=============================== py-template

Python template based on cookiecutter-hypermodern-python__.

__ https://cookiecutter-hypermodern-python.readthedocs.io/

Usage

.. code:: console

$ cruft create https://github.com/iterative/py-template

Features

.. features-begin

• Test automation with Nox_
• Linting with pre-commit and ruff
• Continuous integration with GitHub Actions_
• Documentation with Sphinx and Read the Docs using the furo_ theme
• Automated uploads to PyPI_
• Automated dependency updates with Dependabot_
• Testing with pytest_
• Code coverage with Coverage.py_
• Coverage reporting with Codecov_
• Static type-checking with mypy_
• Automated Python syntax upgrades with pyupgrade_
• setuptools as backend, build as frontend

The template supports Python 3.8, 3.9, 3.10 and 3.11.

.. features-end

.. references-begin

.. _Codecov: https://codecov.io/ .. _Cookiecutter: https://github.com/audreyr/cookiecutter .. _Coverage.py: https://coverage.readthedocs.io/ .. _Dependabot: https://dependabot.com/ .. _GitHub Actions: https://github.com/features/actions .. _Nox: https://nox.thea.codes/ .. _PyPI: https://pypi.org/ .. _Read the Docs: https://readthedocs.org/ .. _mypy: http://mypy-lang.org/ .. _pre-commit: https://pre-commit.com/ .. _pytest: https://docs.pytest.org/en/latest/ .. _pyupgrade: https://github.com/asottile/pyupgrade .. _ruff: https://github.com/astral-sh/ruff

.. references-end