Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pawamoy/cookie-poetry
Cookiecutter for Poetry projects.
https://github.com/pawamoy/cookie-poetry
cookiecutter cookiecutter-poetry cookiecutter-template poetry
Last synced: 25 days ago
JSON representation
Cookiecutter for Poetry projects.
- Host: GitHub
- URL: https://github.com/pawamoy/cookie-poetry
- Owner: pawamoy
- License: isc
- Created: 2019-03-09T12:12:46.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-05-26T18:45:41.000Z (over 4 years ago)
- Last Synced: 2024-10-24T01:32:24.634Z (2 months ago)
- Topics: cookiecutter, cookiecutter-poetry, cookiecutter-template, poetry
- Language: Roff
- Size: 130 KB
- Stars: 8
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Cookie Poetry
Cookiecutter for Poetry projects.
> :warning: I am now using [copier-poetry](https://github.com/pawamoy/copier-poetry),
which is a very similar (and better!) template,
but based on [copier](https://github.com/pykong/copier)
instead of [cookiecutter](https://github.com/cookiecutter/cookiecutter).
This cookiecutter is mainly for my own usage,
but feel free to try it out, or fork it!
- [Changelog](CHANGELOG.md)
- [Contributing](CONTRIBUTING.md)
- [Features](#features)
- [License: ISC License](LICENSE)
- [Requirements](#requirements)
- [Usage](#usage)
- [Credits](#credits)
## Features
- [Poetry](https://github.com/sdispater/poetry) setup, with pre-defined `pyproject.toml`
- Documentation built with Sphinx, in Markdown and/or reStructuredText
- Pre-configured tools: black, isort, bandit, safety
- Tests run with pytest (and plugins), with coverage
- Dark theme for coverage HTML report
- Gitlab CI configuration (no Travis CI)
- Python 3.6 or above
- Auto-generated CREDITS.md from Python dependencies
- All licenses from [choosealicense.com](https://choosealicense.com/appendix/)
- Makefile for convenience
### Makefile
- `build`: Build the package wheel and sdist.
- `check`: Run multiple checks.
- `check-bandit`: Check for security warnings in code using bandit.
- `check-black`: Check if code is formatted nicely using black.
- `check-flake8`: Check for general warnings in code using flake8.
- `check-isort`: Check if imports are correctly ordered using isort.
- `check-pylint`: Check for more extensive code-smells with pylint.
- `check-safety`: Check for vulnerabilities in dependencies using safety.
- `check-spelling`: Check spelling in the documentation.
- `clean`: Delete temporary files.
- `clean-tests`: Delete temporary tests files.
- `credits`: Regenerate CREDITS.md.
- `docs`: Build the documentation locally.
- `help`: Print this help.
- `lint`: Run linting tools on the code.
- `lint-black`: Lint the code using black.
- `lint-isort`: Sort the imports using isort.
- `publish`: Publish the latest built version on PyPI.
- `readme`: Regenerate README.md.
- `setup`: Setup the development environment (install dependencies).
- `test`: Run the tests using pytest.
- `update-spelling-wordlist`: Update the spelling word list.
Typically, once the project is generated, you would run:
```
make setup
make readme credits
make check
make test
```
## Requirements
- [git](https://git-scm.com/downloads)
- [python](https://www.python.org/downloads/)
- [cookiecutter](https://github.com/audreyr/cookiecutter)
## Usage
```
cookiecutter gh:pawamoy/cookie-poetry
```
## Credits
This cookiecutter was created with [cookiecutter-cookiecutter](https://github.com/pawamoy/cookiecutter-cookiecutter).