Skip to content

🤝 Contributing

Contributions are welcomed! Here's how to help:

  1. Report bugs or request features via Issues
  2. Submit pull requests for improvements
  3. Share your use cases in Discussions

To run unit tests you will need to pip install pytest.

To build the documentation you will need to install mkdocs and associated packages:

pip install mkdocs mkdocs-material mkdocstrings[python]

Then from within your project directory, you can run mkdocs serve to start a local HTTP server hosting your copy of the docs. For more information see the mkdocs website.