Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
RussellDash332 committed May 8, 2023
1 parent 7f4c085 commit 7b44864
Showing 1 changed file with 18 additions and 9 deletions.
27 changes: 18 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,26 @@ Kattis scraper, updated as of May 2023 after the major UI/UX change.

## Usage

```
pip install -r requirements.txt
echo "USER = <user>" >> env.py
echo "PASSWORD = <password>" >> env.py
python main.py
```
1. Run `pip install -r requirements.txt` to install the Python packages required.
1. Create a new file called `env.py` and add these two lines.

- `<user>` can be your Kattis username or email **as a single-quoted Python string**, e.g. `'helloworld'` or `'helloworld@gmail.com'`.
- `<password>` is your Kattis account's password **as a single-quoted Python string**, e.g. `'asdf'`.
```python
USER = <username>
PASSWORD = <password>
```

See `env.py.example` for an example of doing the `echo` parts manually.
where `<username>` is your Kattis username/email and `<password>` is your Kattis account password. Both should be provided as **Python strings**.
1. Run `python main.py`.

## Useful References

- Old UI Kattis API wrapper: https://github.com/terror/kattis-api

> Most of the work in `autokattis` is heavily inspired and motivated by this repository.

- Kattis official CLI tool: https://github.com/Kattis/kattis-cli

> Since Kattis has provided an official tool to automate submissions, there won't be such feature in `autokattis`.

## Contributing

Expand Down

0 comments on commit 7b44864

Please # to comment.