This release is a pre-release and may not be stable for production use.
Hyperfast Python Template
A python template that helps you jump start your project
- Documentation: https://entelecheia.github.io/hyperfast-python-template
- 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.
Usage
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 templatebutton - Enter a name for your repository
- Click
Create repository from template - Clone your new repository to your local machine
- Initialize your project with
make init-project - Do your work
II. Use Copier
- Install Copier with
pipx install copier - Run
copier gh:entelecheia/hyperfast-python-template path/to/destination - Initialize your project with
make init-git - Do your work
III. Inject the template
- Install Copier with
pipx install copier - From the root of your project, run
copier gh:entelecheia/hyperfast-python-template . - If your project is not a git repository, initialize it with
make init-git - Do your work
Features
-
Automated semantic versioning with Python Semantic Release
-
Code coverage with Pytest-Cov
-
Continuous integration with GitHub Actions
-
Coverage reporting with Codecov
-
Documentation with MkDocs, Jupyter Book, and Read the Docs
-
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
-
Rendering projects with Copier
-
Static type-checking with mypy
-
Support for Conventional Commits
-
Support for Semantic Release
-
Testing with pytest
-
Automated dependency updates with Dependabot
-
Automated Python syntax upgrades with pyupgrade
-
Automated release notes with Release Drafter
-
Check documentation examples with xdoctest
-
Generating API documentation with [autodoc] and napoleon
-
Runtime type-checking with Typeguard
-
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.
1 maintainer
Metadata
1 maintainer
Release files for hyperfast-python-template 0.0.1rc12
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| hyperfast_python_template-0.0.1rc12.tar.gz | 5.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| hyperfast_python_template-0.0.1rc12-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 9.8 kB
Release files / hyperfast_python_template-0.0.1rc12.tar.gz
| Download URL | hyperfast_python_template-0.0.1rc12.tar.gz |
|---|---|
| Size | 5.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e6e0dd4c218ceb399df0b4ead803a6fe16756997d924c4e87a569badd26942eb
|
|
BLAKE2b-256 checksum How to use checksums |
9bbeb5b43dc26394fa6320dd9508b5bd66b14a35f35dca4a718a4602c7f79af2
|
| Upload date | |
|
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.0.1rc12-py3-none-any.whl
| Download URL | hyperfast_python_template-0.0.1rc12-py3-none-any.whl |
|---|---|
| Size | 4.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1642ce550795a78b11f697c19b925c3650aaf3a8dea1ecc1c20414404156f927
|
|
BLAKE2b-256 checksum How to use checksums |
c5c3e198ba5b48a623b04a72d2610935a5a6fe116eac94036ebfe857fd400706
|
| Upload date | |
|
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
|
