hyperfast-python-template 0.2.5

A python template that helps you jump start your project

Hyperfast Python Template

A python template that helps you jump start your project

• Documentation: https://hyperfast-python.entelecheia.cc
• GitHub: https://github.com/entelecheia/hyperfast-python-template
• PyPI: https://pypi.org/project/hyperfast-python-template

Hyperfast Python Template is a self-contained template that helps you initialize your Python project inside the template. It is hyperfast in the sense that it helps you jump start your project with the best practices in the Python community.

Quickstart

There are two ways to use this project:

• Use Copier to create a project to your local machine directly
• Inject Hyperfast Python Template into an existing project

I. Use Copier

1. Install Copier

   pipx install copier
   

2. Run

   copier gh:entelecheia/hyperfast-python-template path/to/destination
   

3. Do your work

II. Inject the template

1. Install Copier

   pipx install copier
   

2. From the root of your project, run

   copier gh:entelecheia/hyperfast-python-template .
   

3. Do your work

Features

• Automated changelog with Conventional Commits and Python Semantic Release

• Automated dependency updates with Dependabot

• Automated semantic versioning with Python Semantic Release

• Automated uploads to PyPI and TestPyPI

• Code coverage with Pytest-Cov

• Code formatting with Black and Prettier

• Continuous integration with GitHub Actions

• Coverage reporting with Codecov

• Documentation with MkDocs, Jupyter Book, and Read the Docs

• Hyperfast rendering of the template into a new project with Copier

• Import sorting with isort

• Linting with pre-commit and Flake8

• Managing project labels with GitHub Labeler

• Managing projects with Make

• Packaging and dependency management with Poetry

• Static type-checking with mypy

• Support for Conventional Commits

• Support for Semantic Versioning

• Testing with pytest

• Automated Python syntax upgrades with pyupgrade

• Automatic documentation from sources for MkDocs with mkdocstrings

• Check documentation examples with xdoctest

• Runtime type-checking with Typeguard

• Security audit with Bandit and Safety

• Test automation with Nox

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

Changelog

See the CHANGELOG for more information.

Contributing

Contributions are welcome! Please see the contributing guidelines for more information.

License

This project is released under the MIT License.