https://github.com/lorien/pyproject
Python Project Template for Cookiecutter
https://github.com/lorien/pyproject
cookiecutter linter linter-config pyproject pyproject-toml python template
Last synced: 5 months ago
JSON representation
Python Project Template for Cookiecutter
- Host: GitHub
- URL: https://github.com/lorien/pyproject
- Owner: lorien
- Created: 2015-06-05T06:23:13.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-06-25T14:47:49.000Z (over 1 year ago)
- Last Synced: 2025-04-08T18:24:15.022Z (6 months ago)
- Topics: cookiecutter, linter, linter-config, pyproject, pyproject-toml, python, template
- Language: Makefile
- Homepage:
- Size: 48.8 KB
- Stars: 6
- Watchers: 5
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Python Project Template for Cookiecutter
This is a [cookiecutter](https://github.com/cookiecutter/cookiecutter) template I use to start a
new python project.
## Template features
- Makefile for "make" utility to run linters, tests and other things
- Tools to build virtual environment and install project requirements
- Default configurations for all tools used in the template
- Linters:
- ruff with almost all rules enabled
- pylint
- Type checkers:
- mypy in strict mode
- Tests:
- pytest
- Tool's configurations are stored in pyproject.toml
- Tools to build python package and upload it to pypi
## Usage
* Install cookiecutter: `pip install cookiecutter`
* Run command: `cookiecutter gh:lorien/pyproject` and provide answers
for questions which cookiecutter will ask you. The value of "project\_name" will be
used to create a new directory with project contents.
## Feedback
Telegram English chat: [https://t.me/grablab](https://t.me/grablab)
Telegram Russian chat: [https://t.me/grablab\_ru](https://t.me/grablab_ru)