docs/README.md

Project Documentation

Welcome to the documentation for the Python Template Project.

Table of Contents

1. Getting Started
2. Project Structure
3. Development Guide
4. API Documentation
5. Testing Guide
6. Deployment Guide

Overview

This template provides a foundation for Python projects with:

• Modern Python project structure
• Development tooling configuration
  • Black for code formatting
  • Ruff for linting and import sorting
  • Type checking support
• Testing framework setup
• Docker support
• Documentation templates
• CI/CD examples

Development Setup

Code Quality Tools

This project uses modern Python code quality tools:

• Black: Code formatter that enforces a consistent style
• Ruff: Fast Python linter and import sorter
  • Enforces PEP 8 style guide
  • Sorts imports automatically
  • Checks for common errors and anti-patterns
  • Type checking enforcement

VSCode is configured to automatically:

• Format code on save using Black
• Run Ruff for linting and import sorting
• Provide type checking feedback

Quick Links

• Installation Guide
• Development Setup
• Running Tests
• Docker Guide
• API Reference

Contributing

See our Contributing Guide for details on how to contribute to this project.

License

This project is licensed under the MIT License - see the LICENSE file for details.