gurun

Installation

Full installation:

pip install gurun[full]

Installing only the main framework components:

pip install gurun

You 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]

Development

Setting up a development environment

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 poetry

Now, initialize poetry and pre-commit hooks:

make install && make install-pre-commit

Running tests

You can run the tests with:

make tests

This will run the tests with pytest and show information about the coverage.

Formatting the code

To format the code, you can use the command:

make formatting

This will run the black, isort and )pyupgrade commands.

If you want to just check the formatting, use the command:

make check-formatting

Releasing a new version

To release a new version, you need to follow these steps:

1. 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 as major or minor or patch, and the version number will be automatically incremented.

2. Create a Github release with the new version number.

3. (Optional) Publish the new version to PyPI with poetry publish --build.