https://github.com/ankandrew/python-project-template

Modern Python Project Template
https://github.com/ankandrew/python-project-template

cookiecutter-python project-template python-project python-project-template python-repositories python-template

Last synced: 5 months ago
JSON representation

Modern Python Project Template

• Host: GitHub
• URL: https://github.com/ankandrew/python-project-template
• Owner: ankandrew
• Created: 2023-09-13T00:56:23.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-11-27T17:10:15.000Z (about 1 year ago)
• Last Synced: 2025-01-03T21:31:18.381Z (12 months ago)
• Topics: cookiecutter-python, project-template, python-project, python-project-template, python-repositories, python-template
• Language: Makefile
• Homepage:
• Size: 76.2 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
[//]: # (TODO)

# 🐍 Python Project Template 🚀

[//]: # (TODO)

![example workflow](https://github.com/ankandrew/python-project-template/actions/workflows/test.yaml/badge.svg)

[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

[![Pylint](https://img.shields.io/badge/linting-pylint-yellowgreen)](https://github.com/pylint-dev/pylint)

[![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)

A modern Python project template to kickstart your next Python project with all the necessary tools and configurations.

## Features

- ✨ **Poetry**: Manage your project's dependencies and packaging with Poetry.

- 📝 **Editorconfig**: Ensure consistent code formatting across different editors.

- 🔧 **Formatter**: Automatically format your code using Ruff formatter and import sorter.

- 🔍 **Linters**: Catch and prevent errors in your code. Ruff is used for linting and MyPy for type checking.

- 📋 **Makefile**: Easily execute common project tasks with a Makefile.

- 🧪 **Test**: Write and run tests for your project using pytest.

- 🔗 **GitHub Workflow**: Automated GitHub workflow for linting, formatting, and testing your code.

## Getting Started

1. Select `Use this template > Create a new repository`.

2. Install Poetry (if not already installed):

   ```bash

   pipx install poetry

3. Replace `TODO` comments in files with project/repo specific.