https://github.com/pa-decarvalho/python-template

A python project template using Copier
https://github.com/pa-decarvalho/python-template

copier python template

Last synced: 6 days ago
JSON representation

A python project template using Copier

• Host: GitHub
• URL: https://github.com/pa-decarvalho/python-template
• Owner: pa-decarvalho
• License: mit
• Created: 2025-02-13T10:53:24.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-08-21T07:47:18.000Z (10 months ago)
• Last Synced: 2025-08-21T09:42:28.969Z (10 months ago)
• Topics: copier, python, template
• Language: Python
• Homepage: https://pa-decarvalho.github.io/python-template/
• Size: 2.72 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Python Template

[![copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-orange.json)](https://github.com/copier-org/copier)

![license](https://img.shields.io/github/license/pa-decarvalho/python-template)

A modern Python package template that helps you quickly bootstrap new Python projects with best practices and common tools already set up.

Built with [Copier](https://copier.readthedocs.io/en/latest/), this template provides a standardized foundation for your Python projects.

---

## Why Use This Template ?

Starting a new Python project involves many repetitive setup tasks. This template helps you:

- Save time by avoiding manual project setup

- Ensure consistency across your projects

- Follow Python best practices from the start

- Focus on writing code instead of configuration

## Features

- Poetry - Modern dependency management and packaging

- Task - A task runner to simplify common operations

- MkDocs - Documentation generation with Markdown

- Linters:

    - Ruff - An extremely fast Python linter and code formatter

    - yamllint - YAML files linter

    - commitizen - Commit message checker and changelog generator

- Tests:

    - pytest - Powerful and flexible testing framework

- And many more...

## Prerequisites

- Python 3.9 or higher

- A Git repository

- [Task](https://taskfile.dev/) (not mandatory but recommended)

## Example Project

You can see what a project looks like once generated with this template in the following [example](https://github.com/pa-decarvalho/python-template-example).

This repository serves as a reference for the output of the template generation and is also used to test updates and improvements.