rk_utils

Some useful Python utilities made by RKWS.

A longer description of your project goes here...

Making Changes & Contributing

For developers, extra requirements are in requirements_dev.txt:

cd rk_utils
pip install -r requirements_dev.txt

This project uses pre-commit, and it is a good idea to update the hooks to the latest version before installing:

cd rk_utils
pre-commit autoupdate
pre-commit install

There are some useful tox commands that can be used to simplify developing:

cd rk_utils
tox  # to run all the tests
tox -e docs  # to build your documentation
tox -e build  # to build your package distribution
tox -e publish  # to test your project uploads correctly in test.pypi.org
tox -e publish -- --repository pypi  # to release your package to PyPI
tox -av  # to list all the tasks available

Note

This project has been set up using PyScaffold 4.4. For details and usage information on PyScaffold see https://pyscaffold.org/.