Full installation:
pip install gurun[full]Installing only the main framework components:
pip install gurunYou can also install component dependencies separately. Thus, we have the cv (computer vision) version and the gui version:
pip install gurun[cv]
pip install gurun[gui]For the multi-workspace system to work, install the following libraries on your operating system.
Install PSVirtualDesktop:
PS C:\> Install-Module VirtualDesktopInstall wmctrl:
sudo apt-get install -y wmctrl- bombcrypto-bot - A bot to automate the bombcrypto game.
If you don't have a local development environment, you can follow these steps to set one up.
First, if you have not already, install poetry:
pip install poetryNow, initialize poetry and pre-commit hooks:
make initYou can run the tests with:
make testsThis will run the tests with pytest and show information about the coverage.
To format the code, you can use the command:
make formattingThis will run the isort and black commands.
If you want to just check the formatting, use the command:
make check-formattingTo release a new version, you need to follow these steps:
-
Update the version with
poetry version <version>and commit the changes. This project follows Semantic Versioning, so the version number should follow the format<major>.<minor>.<patch>. Alternatively, you can also use the version asmajororminororpatch, and the version number will be automatically incremented. -
Create a Github release with the new version number.
-
(Optional) Publish the new version to PyPI with
poetry publish --build.