Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/smkent/cookie-python
🍪 🐍 Cookiecutter template for new Python projects
https://github.com/smkent/cookie-python
bandit black codecov container cookiecutter coverage cruft docker flake8 github-actions isort mypy pep8 poetry pre-commit pytest python template
Last synced: 3 months ago
JSON representation
🍪 🐍 Cookiecutter template for new Python projects
- Host: GitHub
- URL: https://github.com/smkent/cookie-python
- Owner: smkent
- License: mit
- Created: 2022-02-25T00:05:47.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-09T22:11:47.000Z (6 months ago)
- Last Synced: 2024-09-16T04:52:00.507Z (4 months ago)
- Topics: bandit, black, codecov, container, cookiecutter, coverage, cruft, docker, flake8, github-actions, isort, mypy, pep8, poetry, pre-commit, pytest, python, template
- Language: Python
- Homepage:
- Size: 582 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [Cookiecutter][cookiecutter] template for new Python projects
[][pypi]
[][pypi]
[][gh-actions]
[][codecov]
[][repo]
[![cookie-python][logo]](#)
A template for new Python projects, with:
* [poetry][poetry] (with [poetry-dynamic-versioning][poetry-dynamic-versioning])
* [pytest][pytest]
* [pre-commit][pre-commit]
* [mypy][mypy]
* [black][black]
* [flake8][flake8] (with [bugbear][flake8-bugbear], [simplify][flake8-simplify],
and [pep8-naming][pep8-naming])
* [autoflake][autoflake]
* [pyupgrade][pyupgrade]
* [bandit][bandit]
* [cruft][cruft]
* GitHub Actions support
* Coverage reports with [codecov.io][codecovio]
## Poetry installation
Via [`pipx`][pipx]:
```console
pip install pipx
pipx install poetry
pipx inject poetry poetry-dynamic-versioning poetry-pre-commit-plugin
```
Via `pip`:
```console
pip install poetry
poetry self add poetry-dynamic-versioning poetry-pre-commit-plugin
```
## New project creation
### With [cruft][cruft] via script
```console
poetry install
poetry run new-cookie # or poetry run cruft create
```
### With [cookiecutter][cookiecutter] directly
```console
pip install cookiecutter
cookiecutter https://github.com/smkent/cookie-python
```
## Development tasks
* Setup: `poetry install`
* Run static checks: `poetry run poe lint` or
`poetry run pre-commit run --all-files`
* Run static checks and tests: `poetry run poe test`
* Update test expected output files from test results:
`poetry run poe updatetests`
[autoflake]: https://github.com/PyCQA/autoflake
[bandit]: https://github.com/PyCQA/bandit
[black]: https://github.com/psf/black
[codecov]: https://codecov.io/gh/smkent/cookie-python
[codecovio]: https://codecov.io
[cookiecutter]: https://github.com/cookiecutter/cookiecutter
[cruft]: https://github.com/cruft/cruft
[flake8-bugbear]: https://github.com/PyCQA/flake8-bugbear
[flake8-simplify]: https://github.com/MartinThoma/flake8-simplify
[flake8]: https://github.com/pycqa/flake8
[gh-actions]: https://github.com/smkent/cookie-python/actions?query=branch%3Amain
[logo]: https://raw.github.com/smkent/cookie-python/main/img/cookie-python.png
[mypy]: https://github.com/python/mypy
[pep8-naming]: https://github.com/PyCQA/pep8-naming
[pipx]: https://pypa.github.io/pipx/
[poetry-dynamic-versioning]: https://github.com/mtkennerly/poetry-dynamic-versioning
[poetry-installation]: https://python-poetry.org/docs/#installation
[poetry]: https://python-poetry.org/
[pre-commit]: https://pre-commit.com/
[pypi]: https://pypi.org/project/cookie-python/
[pytest]: https://docs.pytest.org
[pyupgrade]: https://github.com/asottile/pyupgrade
[repo]: https://github.com/smkent/cookie-python