We welcome contributions to the pyApp project (and sub projects).

To get our PR accepted quickly please ensure the following requirements are met:

  • Install the pre-commit hooks to ensure you code is formatted by black.
  • Ensure your code has unit test coverage (we use pytest). Unit tests should be designed to be as fast as possible.
  • Update the docs with the details if required.
  • The API matters, ensure any features provide a nice API for end users.

The core pyApp package is intended to be fairly light and mainly made up of plumbing code. If you want to add support for a particular service or server an extension is the best way to do that.