https://github.com/gjeusel/soft-cookiecutter
Cookiecutter template for easy python packaging.
https://github.com/gjeusel/soft-cookiecutter
bandit ci cookiecutter cookiecutter-template isort pre-commit pypi python readthedocs yapf
Last synced: 4 months ago
JSON representation
Cookiecutter template for easy python packaging.
- Host: GitHub
- URL: https://github.com/gjeusel/soft-cookiecutter
- Owner: gjeusel
- Created: 2018-07-18T17:24:22.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2025-02-10T19:57:39.000Z (over 1 year ago)
- Last Synced: 2025-02-10T20:34:51.253Z (over 1 year ago)
- Topics: bandit, ci, cookiecutter, cookiecutter-template, isort, pre-commit, pypi, python, readthedocs, yapf
- Language: Python
- Size: 281 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Everything you need for a modern python project/package.
---
See [cookiecutter](https://github.com/audreyr/cookiecutter) and [cruft](https://github.com/cruft/cruft) for more informations.
## Usage
```bash
pip install -y cookiecutter cruft
```
```bash
cruft create https://github.com/gjeusel/soft-cookiecutter
```
## Details
#### Tooling choices
- **PEP 621**: pyproject.toml (everything)
- **Hatchling**: dynamic versioning (based on git)
- **pre-commit**: a framework for managing and maintaining multi-language pre-commit hooks
- **mkdocs**: generate beautiful documentation easily with [mkdocs-material](https://squidfunk.github.io/mkdocs-material/)
#### CI Github actions
- **Linter & Formatter**: [ruff](https://github.com/charliermarsh/ruff)
- **Type Checker**: [mypy](https://github.com/python/mypy)
- **Pytest**: unit testing
- **Code Coverage**: [coverage](https://github.com/nedbat/coveragepy) & [smokeshow](https://github.com/samuelcolvin/smokeshow)
- **PyPI**: deployment only on new tag in main branch