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 the template itself is converted into a Python project in the blink of an eye. It is also hyperfast in the sense that it helps you jump start your project with the best practices in the Python community.

Quickstart

There are three ways to use this project:

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

I. Use the template

Click the Use this template button
Enter a name for your repository
Click Create repository from template
Clone your new repository to your local machine
Initialize your project
```
make init-project
```
Do your work

II. Use Copier

Install Copier
```
pipx install copier
```

Run

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

Do your work

III. Inject the template

Install Copier
```
pipx install copier
```

From the root of your project, run

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

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.

Metadata

Release files for hyperfast-python-template 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for hyperfast-python-template 0.1.0
File	Size	Uploaded
hyperfast_python_template-0.1.0.tar.gz	5.2 kB	Feb 24, 2023	Details

Built distribution (wheel)

Table of built distributions (wheels) for hyperfast-python-template 0.1.0
File	Interpreter	ABI	Platform	Reset
hyperfast_python_template-0.1.0-py3-none-any.whl 4.1 kB Feb 24, 2023	Python 3	none	any	Details

Total release size: 9.3 kB

Release files / hyperfast_python_template-0.1.0.tar.gz

Download URL	hyperfast_python_template-0.1.0.tar.gz
Size	5.2 kB
Tags	Source
SHA-256 checksum How to use checksums	`5efcae75de9de7a691944cfd1c547c3a3f5ce8acd77a904657f4e1b0484b686c`
BLAKE2b-256 checksum How to use checksums	`19ee7ffef413d930a0840a97d19e6ee9faa1c8da5c3caadab8ec1c8fd3303061`
Upload date	Feb 24, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.8.0 pkginfo/1.9.6 readme-renderer/37.3 requests/2.28.2 requests-toolbelt/0.10.1 urllib3/1.26.14 tqdm/4.64.1 importlib-metadata/6.0.0 keyring/23.13.1 rfc3986/2.0.0 colorama/0.4.6 CPython/3.10.10`

Release files / hyperfast_python_template-0.1.0-py3-none-any.whl

Download URL	hyperfast_python_template-0.1.0-py3-none-any.whl
Size	4.1 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`e08f2bda816724a037143f9fc667316c5de02971f39353fb20a0f6f298a0c42e`
BLAKE2b-256 checksum How to use checksums	`f6d3a93930e83098f705296f27b1cde489eb70451bd0a2132605dd6e3f76a0bb`
Upload date	Feb 24, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.8.0 pkginfo/1.9.6 readme-renderer/37.3 requests/2.28.2 requests-toolbelt/0.10.1 urllib3/1.26.14 tqdm/4.64.1 importlib-metadata/6.0.0 keyring/23.13.1 rfc3986/2.0.0 colorama/0.4.6 CPython/3.10.10`