arichr / python-template

Python template used in my repositories

Python Template

Python template used in my repositories.

Important: Python minimal version update

Features:

• Python: >=3.8, <4.0
• Prefers LF
• Allows 80 symbols/line and 100 symbols/line for docstrings
• Uses ruff

Getting started!

1. Write a good README for your project
2. Correct LICENSE, pyproject.toml files
3. Write documentation!
4. Provide automated tests
5. (optional) Add a Dockerfile

Utilities

Linting

• Ruff documentation

Documentation

• MkDocs
• Sphinx documentation

Packaging

• Packaging Python Projects
• Poetry-compatible pyproject.toml