https://github.com/escaped/cookiecutter-pypackage
Modern cookiecutter template for libraries or applications, support Django based projects (includes pre-commit hooks, poetry, etc.)
https://github.com/escaped/cookiecutter-pypackage
autoupdater cookiecutter cookiecutter-django cookiecutter-pypackage cookiecutter-template django github-actions python python3
Last synced: 28 days ago
JSON representation
Modern cookiecutter template for libraries or applications, support Django based projects (includes pre-commit hooks, poetry, etc.)
- Host: GitHub
- URL: https://github.com/escaped/cookiecutter-pypackage
- Owner: escaped
- License: bsd-3-clause
- Created: 2019-08-05T12:48:30.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2021-02-11T02:00:21.000Z (over 4 years ago)
- Last Synced: 2024-10-19T07:05:24.892Z (7 months ago)
- Topics: autoupdater, cookiecutter, cookiecutter-django, cookiecutter-pypackage, cookiecutter-template, django, github-actions, python, python3
- Language: Python
- Homepage:
- Size: 52.7 KB
- Stars: 8
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Cookiecutter PyPackage
A modern opinionated [Cookiecutter] template for Python packages and applications using [Poetry].
## Features
* [Poetry]: Dependency management and packaging
* [Tox]: Easily run tests for different python versions
* Github Actions: Ready for Continous Integration testing
* Run tests for different python versions using tox
* Test for [PEP8] compliance
* Enforce the usage of [black]
* Preconfigured [coveralls]
* Tests using [Pytest] including support for
* [pytest-mock] for mocking
* code coverage using [coverage.py]
* [pre-commit] hook to automatically run
* [autoflake] - automatically removes unused imports and variables,
* [isort] - automatically sorts imports alphabetically, and automatically separated into sections and by type,
* [black] - automatically formats your code,
* [flake8] - checks code against code style (PEP8), programming errors and complexity,
* [flake8-bugbear] - finds likely bugs and design problems in your program,
* [flake8-builtins] - Checks for python builtins being used as variables or parameters,
* [flake8-debugger] - Checks for `pdb` statements,
* [pep8-naming] - Checks code against PEP 8 naming conventions,
* [flake8-comprehensions] - helps you write better list/set/dict comprehensions,
* [mypy] - static type checker,
* Debugging tools
* [pdbpp] - better debugger,
* [better_exceptions] - Pretty and more helpful exceptions in Python, automatically
* (optional) Preconfigured for [Django] applications
* Support for [Twelve-factor-Methodology] using [django-environ]
* Simple pull request template with checklist
## Quickstart
Get the latest version of [Cruft] (or [Cookiecutter])
I recommend [pipx] to install it into a global isolated environment.
```sh
pipx install cruft
```
Generate a new python package
```sh
cruft create https://github.com/escaped/cookiecutter-pypackage.git
cd
git init
git add .
git commit -m "feat: initial project structure"
```
### Publish releases to pypi
In order get automatic releases to [pypi] you need to add your pypi access token to the github secrets (named `PYPI_TOKEN`).
Instructions can be found here: [python.org](https://packaging.python.org/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/#saving-credentials-on-github).
### Autoupdate template
This cookiecutter template comes with an auto update feature if the project was created using [cruft].
A GitHub action automatically checks for updates and creates a pull request.
It is required to add a [personal access token](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token)
as github secret to the repository (named `AUTO_UPDATE_GITHUB_TOKEN`).
While creating the access token, the following permissions have to be granted
* repo
* workflow
[autoflake]: https://pypi.org/project/autoflake/
[better-exceptions]: https://github.com/qix-/better-exceptions
[black]: https://black.readthedocs.io/en/stable/
[Conventional-Commits]: http://conventionalcommits.org/
[Cookiecutter]: https://github.com/audreyr/cookiecutter
[coverage.py]: https://coverage.readthedocs.io/
[coveralls]: https://coveralls.io/
[Cruft]: https://github.com/cruft/cruft
[django-environ]: https://github.com/joke2k/django-environ
[Django]: https://www.djangoproject.com/
[flake8-bugbear]: https://pypi.org/project/flake8-bugbear/
[flake8-builtins]: https://pypi.org/project/flake8-builtins/
[flake8-comprehensions]: https://pypi.org/project/flake8-comprehensions/
[flake8-debugger]: https://pypi.org/project/flake8-debugger/
[flake8]: http://flake8.pycqa.org/en/latest/
[isort]: https://github.com/timothycrosley/isort
[mypy]: http://mypy-lang.org/
[pdbpp]: https://github.com/pdbpp/pdbpp
[PEP8]: https://www.python.org/dev/peps/pep-0008/
[pep8-naming]: https://pypi.org/project/pep8-naming/
[pip]: https://pip.pypa.io/en/stable/
[pipx]: https://github.com/pipxproject/pipx
[Poetry]: https://poetry.eustace.io/
[pre-commit]: https://pre-commit.com/
[pypi]: https://pypi.org/
[Pytest]: https://docs.pytest.org/en/latest/
[pytest-mock]: https://github.com/pytest-dev/pytest-mock/
[Tox]: http://testrun.org/tox/
[Twelve-factor-Methodology]: https://www.12factor.net/