Development
Adding to this project#
-
Clone the repository to a local path:
-
Navigate to the project directory and install dependencies. This project uses the
poetry
package manager. After installingpoetry
, runpoetry install
. -
Make changes.
-
Run tests with pytest:
-
This project uses
mkdocs
for documentation. Runmkdocs serve --watch src
to preview rendered documentation. -
Submit a pull request with your changes to the main code branch on github.