Yet another Python project template.

(TODO replace) To install the package from PyPI:

pip install python_project_template

Clone the repository:

git clone https://github.com/marcofavorito/python-project-template
cd python-project-template

Set up virtual environment using Poetry:

poetry shell
poetry install

To run tests: tox

To run only the code tests: tox -e py312

To run only the linters:

• tox -e ruff-check
• tox -e ruff-format
• tox -e mypy

Please look at the tox.ini file or run tox -l for the full list of supported commands.

To build the docs: mkdocs build

To view documentation in a browser: mkdocs serve and then go to http://localhost:8000

python-project-template is released under the GNU General Public License v3.0 or later (GPLv3+).

Copyright 2024 Marco Favorito

• Marco Favorito