README.md

fillname

Remove this block after following the instructions below to use the template.

This project template is configured to ease collaboration. Linters, formatters, and actions are already configured and ready to use.

To use the project template, run the init.py script to give the project a name and some metadata. The script can then be removed and the pyproject.toml file be adjusted as needed.

Installation

To install the project, run

pip install .

Usage

Run the following for basic usage information:

fillname -h

To generate and open the documentation, run

nox -s doc -- serve

Instructions to install and use nox can be found in DEVELOPMENT.md