Skip to content

Commit

Permalink
Rename project to something more typeable, tyora!
Browse files Browse the repository at this point in the history
  • Loading branch information
madeddie committed May 16, 2024
1 parent c532e7c commit 4399950
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 12 deletions.
21 changes: 13 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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:
Expand All @@ -34,27 +35,31 @@ 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.

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.

3. Submit a solution:

```bash
python moocfi_cses.py submit <exercise_id> <path_to_solution_file>
python tyora.py submit <exercise_id> <path_to_solution_file>
```

Replace `<exercise_id>` with the ID of the exercise you want to submit a solution for, and `<path_to_solution_file>` with the path to your solution file.

## Origin of name

In Finnish, "työ" means "work", "pyörä" means "wheel". "Työrä" would be "work 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.
Expand Down
8 changes: 4 additions & 4 deletions moocfi_cses.py → tyora.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
import requests


logger = logging.getLogger(name="moocfi_cses")
logger = logging.getLogger(name="tyora")


@dataclass
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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")
Expand Down Expand Up @@ -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"
Expand Down

0 comments on commit 4399950

Please sign in to comment.