README.md

Cookiecutter for Python projects

Managing the initial setup and boilerplate code for Python Package projects can be a repetitive and time-consuming task. To streamline this process, we've created a Cookiecutter template that automates the creation of such projects. This template is designed to save you time and effort, allowing you to focus on building the core functionality of your project.

Features of the template

• Standard Python Package layout
  • src folder
  • tests folder
  • pyproject.toml, including configuration for:
    • build-system default to hatchling
    • ruff
    • bumpversion
    • mypy
    • pytest
    • tomlsort
    • tox
• MIT License
• Automatic GitLab Component compliant release when new version tag is pushed, based on CHANGELOG.md

Use template

Navigate to the directory where you intend to store your new template and run the following command:

uvx cookiecutter https://gitlab.com/swepy/cookiecutter/python-package.git -c 0.2.2

This command will guide you through a series of prompts to gather information about your template and set up the necessary files.