development¶

Here is some information which will help you to develop/contribute to kegscraper

prerequisites¶

• uv
• python 3.10 or higher (installable via uv): uv python install 3.10
• git
• a github account

steps¶

1. fork the kegscraper repo
2. clone that repo. Copy the url of your repo and run git clone {url}
3. run uv venv
4. On windows (pwsh), run .venv/Scripts/activate, on mac/liunux, run source .venv/bin/activate
5. Run uv sync

6. Test your code. Make a directory: tests/local_tests and put your code there.

7. The tests/ directory hosts scripts which can be run with pytest.

8. When you have committed your feature or hotfix, open a pull request
9. Wait/hope for it to be merged!

tips¶

• In kegscraper, it is advised to use conventional commit names
• It is advised to store authentication data in a toml file (make sure it is gitignored!!) or in environment variables. **Definitely not directly in your code as it can be committed.