Warning: This branch contains the unmaintained CookieCutter version of the Pyt2 template. Please refer to the main branch for the most up-to-date template (which uses Copier)

Pyt2

My second attempt at making a Python template.

Why?

I've seen many other projects like this but I've never seen any of them follow the pattern I want.

✨ Features

• 📂 Structure and project style
  • 🎨 Uses the linters (checked via GitHub Actions )
    • ⚫ Black
    • 🐍 MyPy
    • ⚡ Ruff (which includes isort and Pylint and many, many others...)
  • 🧪 Hypothesis and Pytest for testing
  • 🎵 Uses Poetry to manage the project
  • 🎶 Has Poe tasks
  • Uses GitHub Actions for CI
    • ✅ Cached workflows
    • 🐍 Tests for Python 3.8+ on 🐧 Linux, 🍎 Mac, and 🏁 Windows.
    • 🔖 Automatically generate and upload distribution files on tagged releases
  • (Optional) 😸 Documentation via Sphinx
• 🖨️ Generation features
  • 🔒 Pre-computed lockfile (poetry.lock) with up-to-date dependencies via CI ()
  • 🔖 Has a test_version.py which will test if the __version__ metadata variable in the package is equal to the one in the pyproject.toml
  • 🤖 Optional post-generation hooks. Runs git init and/or poetry install
  • (Optional) 🎬 __main__.py and [tool.poetry.scripts] entry point generation (for applications)

Usage

cookiecutter gh:ThatXliner/pyt2

✨ Magic

FAQ

About the name...

Pronunciation: pit-too Why this is the name: Python Template 2

Why is the default templated license GPL?

Because it's usually better.

But you can fork this and modify the default license in the template anyways. This template, however, is released to the Public Domain.