This project welcomes contributions in the form of Pull Requests. For clear bug-fixes / typos etc. just submit a PR. For new features or if there is any doubt in how to fix a bug, you might want to open an issue prior to starting work.
Rich Tools uses poetry for packaging and dependency management. To start developing with Rich Tools, install Poetry using the recommended method or run:
pip install poetryOnce Poetry is installed, install the dependencies with the following command:
poetry installRun tests with the following command:
poetry run pytestNew code should ideally have tests and not break existing tests.
If you are not familiar with writing tests but still want to contribute to this package, please feel free to submit your pull request, and I will work on tests. 🙂
Please add type annotations for all new code.
Rich Tools uses Ruff for code formatting.
I recommend setting up Ruff in your editor to format on save.
To run Ruff from the command line:
poetry run ruff check
poetry run ruff format