Cookiecutter Simple Python

This is a simple python project cookiecutter template suitable for creating ready to code project folder.

Features

• Python: 3.12
• Testing: pytest
• Package manager: poetry
• Linting and formatting: ruff
• Type checker: mypy
• Standardizing spaces and tabs: editorconfig
• Default integration with pre-commit
• Optional integration with asdf and rtx via .tool_versions file
• Optional integration with Github Actions

Quick Start

Install Cookiecutter and generate a new python project:

cookiecutter https://github.com/zahidkizmaz/cookiecutter-python-simple

Cookiecutter prompts you for information regarding your project.

[1/10] project_name (Python Project):
[2/10] project_slug (python_project):
[3/10] author_name (Zahid Kizmaz):
[4/10] email ([email protected]):
[5/10] version (0.1.0):
[6/10] description (My Simple Python Project):
[7/10] python_version (3.12.0):
[8/10] use_tool_versions [y/n] (y):
[9/10] use_github_actions [y/n] (y):
[10/10] Select license
  1 - MIT
  2 - BSD-3
  3 - Apache Software License 2.0
  4 - GNU General Public License v3.0
  Choose from [1/2/3/4] (1):

That's it! Your simple python project is ready for coding.

python_project
├── .editorconfig
├── .github
│   ├── PULL_REQUEST_TEMPLATE.md
│   ├── dependabot.yml
│   └── workflows
│       └── ci.yml
├── .gitignore
├── .pre-commit-config.yaml
├── .tool-versions
├── LICENSE
├── README.md
├── pyproject.toml
├── src
│   ├── __init__.py
│   └── main.py
└── tests
    ├── __init__.py
    └── test_main.py