AldoGl / python-project-template

Yet another Python project template.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

(yet another) Python project template

PyPI PyPI - Python Version PyPI - Status PyPI - Implementation PyPI - Wheel GitHub

test lint docs codecov

Yet another Python project template.

Install

(TODO replace) To install the package from PyPI:

pip install python_project_template

Tests

To run tests: tox

To run only the code tests: tox -e py3.7

To run only the linters:

  • tox -e flake8
  • tox -e mypy
  • tox -e black-check
  • tox -e isort-check

Please look at the tox.ini file for the full list of supported commands.

Docs

To build the docs: mkdocs build

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

License

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

Copyright 2022 Marco Favorito

Authors

About

Yet another Python project template.

License:GNU Lesser General Public License v3.0


Languages

Language:Python 55.1%Language:Makefile 38.4%Language:Shell 6.6%