Simple Cookiecutter template for Ape
(ApeWorx) with Hatch
, ruff
, mypy
.
Details | |
Features |
- Lightweight
Ape
starter -
Hatch
package management - Linting and formatting with
ruff
which replaces isort, flake8, black, etc. - Type checking with
mypy
- Unit tests with
pytest
with optional asyncio setup. - Automate and standardize testing with Hatch-env-matrices
- Documentation with Material for MkDocs and docstring reference support with mkdocstrings.
- pyproject.toml: all package, build and tool configuration in one file,
- pre-commit: pre-commit git hooks that make your life easier,
- Markdown: instead of reStructuredText, Markdown is used consistently for all text files
Generate the project:
This project will use pipx
to install hatch
in an isolated enviroment. Make sure you have pipx
installed before running the following command.
cookiecutter https://github.com/Aviksaikat/Cookiecutter-ape-hatch-template
The generator will automatically call hatch env create
at the end.
cruft is a layer above Cookiecutter allowing you to update your project from the template after it has been generated.
cruft create https://github.com/Aviksaikat/Cookiecutter-ape-hatch-template
This project is licensed under the terms of the MIT license.