diff --git a/README.md b/README.md index c46ceca..8d7a10e 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ -# mooc.fi CSES exercise task CLI -[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/madeddie/moocfi_cses/test.yml)](https://github.com/madeddie/moocfi_cses/actions) +# Tyora: mooc.fi CSES exercise task CLI +[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/madeddie/tyora/test.yml)](https://github.com/madeddie/tyora/actions) -This script interacts with the mooc.fi instance of the CSES (https://cses.fi) website to perform various actions such as logging in, retrieving exercise lists, and submitting solutions. It provides a convenient way to view and submit tasks. +This script interacts with the mooc.fi instance of the CSES (https://cses.fi) website to perform various actions such as logging in, retrieving exercise lists, and submitting solutions. +It provides a convenient way to view and submit tasks. ## Features @@ -14,13 +15,13 @@ This script interacts with the mooc.fi instance of the CSES (https://cses.fi) we 1. Clone the repository to your local machine: ```bash - git clone https://github.com/madeddie/moocfi_cses.git + git clone https://github.com/madeddie/tyora.git ``` 2. Navigate to the project directory: ```bash - cd moocfi_cses + cd tyora ``` 3. Install the required dependencies: @@ -34,7 +35,7 @@ This script interacts with the mooc.fi instance of the CSES (https://cses.fi) we 1. Configure the script by running: ```bash - python moocfi_cses.py configure + python tyora.py configure ``` Follow the prompts to enter your mooc.fi username and password. This information will be stored for future use. @@ -42,7 +43,7 @@ This script interacts with the mooc.fi instance of the CSES (https://cses.fi) we 2. List available exercises: ```bash - python moocfi_cses.py list + python tyora.py list ``` This will retrieve and display a list of exercises available on the CSES platform. @@ -50,11 +51,16 @@ This script interacts with the mooc.fi instance of the CSES (https://cses.fi) we 3. Submit a solution: ```bash - python moocfi_cses.py submit + python tyora.py submit ``` Replace `` with the ID of the exercise you want to submit a solution for, and `` with the path to your solution file. +## Origin of name + +The name "tyora" is derived from Finnish words: "työ" meaning "work" and "pyörä" meaning "wheel". +Anyway, `pyora` was already taken, so I went with `tyora`... ;) + ## Contributing Contributions are welcome! If you have any suggestions, bug reports, or feature requests, please open an issue or submit a pull request. diff --git a/tests/test_moocfi_cses.py b/tests/test_tyora.py similarity index 81% rename from tests/test_moocfi_cses.py rename to tests/test_tyora.py index 73906fc..cd5f527 100644 --- a/tests/test_moocfi_cses.py +++ b/tests/test_tyora.py @@ -1,15 +1,15 @@ -import moocfi_cses +import tyora import pytest import requests_mock def test_parse_args_missing_args() -> None: with pytest.raises(SystemExit): - moocfi_cses.parse_args() + tyora.parse_args() def test_parse_args_command() -> None: - args = moocfi_cses.parse_args(["list"]) + args = tyora.parse_args(["list"]) assert args.cmd == "list" @@ -26,15 +26,15 @@ class TestFindLink: def test_find_link_success(self) -> None: assert ( - moocfi_cses.find_link(self.valid_html, self.valid_xpath) + tyora.find_link(self.valid_html, self.valid_xpath) == self.valid_return ) def test_find_link_bad_xpath(self) -> None: - assert moocfi_cses.find_link(self.valid_html, self.invalid_xpath) == {} + assert tyora.find_link(self.valid_html, self.invalid_xpath) == {} def test_find_link_bad_html(self) -> None: - assert moocfi_cses.find_link(self.invalid_html, self.valid_xpath) == {} + assert tyora.find_link(self.invalid_html, self.valid_xpath) == {} class TestParseForm: @@ -51,15 +51,15 @@ class TestParseForm: # TODO: add tests for unreachable and failing endpoints, 4xx, 5xx, etc @pytest.fixture -def mock_session() -> moocfi_cses.Session: - return moocfi_cses.Session( +def mock_session() -> tyora.Session: + return tyora.Session( username="test_user@test.com", password="test_password", base_url="https://example.com", ) -def test_login_successful(mock_session: moocfi_cses.Session) -> None: +def test_login_successful(mock_session: tyora.Session) -> None: # Mocking the HTTP response for successful login with requests_mock.Mocker() as m: m.get( @@ -70,7 +70,7 @@ def test_login_successful(mock_session: moocfi_cses.Session) -> None: assert mock_session.is_logged_in -def test_login_failed(mock_session: moocfi_cses.Session) -> None: +def test_login_failed(mock_session: tyora.Session) -> None: # Mocking the HTTP response for failed login with requests_mock.Mocker() as m: m.get( diff --git a/moocfi_cses.py b/tyora.py similarity index 98% rename from moocfi_cses.py rename to tyora.py index 2316afb..4f0aa74 100644 --- a/moocfi_cses.py +++ b/tyora.py @@ -14,7 +14,7 @@ import requests -logger = logging.getLogger(name="moocfi_cses") +logger = logging.getLogger(name="tyora") @dataclass @@ -115,7 +115,7 @@ def parse_args(args: Optional[list[str]] = None) -> argparse.Namespace: parser.add_argument( "--config", help="Location of config file (default: %(default)s)", - default="~/.config/moocfi_cses/config.json", + default="~/.config/tyora/config.json", ) parser.add_argument( "--no-state", @@ -162,7 +162,7 @@ def create_config() -> dict[str, str]: def write_config(configfile: str, config: dict[str, str]) -> None: file_path = Path(configfile).expanduser() if file_path.exists(): - # TODO: https://github.com/madeddie/moocfi_cses/issues/28 + # TODO: https://github.com/madeddie/tyora/issues/28 ... file_path.parent.mkdir(parents=True, exist_ok=True) # Ensure directory exists print("Writing config to file") @@ -371,7 +371,7 @@ def main() -> None: cookiefile = None cookies = dict() if not args.no_state: - state_dir = Path("~/.local/state/moocfi_cses").expanduser() + state_dir = Path("~/.local/state/tyora").expanduser() if not state_dir.exists(): state_dir.mkdir(parents=True, exist_ok=True) cookiefile = state_dir / "cookies.txt"