https://github.com/kpj/cookiecutter-python
A cookiecutter template for modern Python packages.
https://github.com/kpj/cookiecutter-python
Last synced: 2 months ago
JSON representation
A cookiecutter template for modern Python packages.
- Host: GitHub
- URL: https://github.com/kpj/cookiecutter-python
- Owner: kpj
- License: mit
- Created: 2021-01-04T17:06:36.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-01-02T11:00:31.000Z (over 3 years ago)
- Last Synced: 2025-01-18T04:06:58.037Z (4 months ago)
- Language: Python
- Homepage:
- Size: 25.4 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cookiecutter-python
Opinionated cookiecutter template for Python packages.
Cool features:
* Package management using [poetry](https://github.com/python-poetry/poetry)
* Automated CI/CD workflows with [GitHub Actions](https://github.com/features/actions)
* Testing using [pytest](https://github.com/pytest-dev/pytest)
* Linting using [black](https://github.com/psf/black)
* Semantic versioning using [bump2version](https://github.com/c4urself/bump2version)
* Automated dependency updates using [dependabot](https://github.com/dependabot/dependabot-core)
## Usage
Install cookiecutter:
```bash
$ pip install cookiecutter
```
Generate your Python package:
```bash
$ cookiecutter https://github.com/kpj/cookiecutter-python
```
Setup additional requirements:
* [Add a new API token](https://pypi.org/manage/account/token/) on PyPi and call it `GitHub Actions CI/CD — /`
* Add API token on `https://github.com///settings/secrets/actions` and call it `PYPI_API_TOKEN`
## Tips
To update the version (and tag/commit the new release) execute `bump2version major/minor/patch`.