| # Project Documentation |
|
|
| Welcome to the documentation for the Python Template Project. |
|
|
| ## Table of Contents |
|
|
| 1. [Getting Started](getting-started.md) |
| 2. [Project Structure](project-structure.md) |
| 3. [Development Guide](development.md) |
| 4. [API Documentation](api.md) |
| 5. [Testing Guide](testing.md) |
| 6. [Deployment Guide](deployment.md) |
|
|
| ## 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](getting-started.md#installation) |
| - [Development Setup](development.md#setup) |
| - [Running Tests](testing.md#running-tests) |
| - [Docker Guide](deployment.md#docker) |
| - [API Reference](api.md#endpoints) |
|
|
| ## Contributing |
|
|
| See our [Contributing Guide](CONTRIBUTING.md) for details on how to contribute to this project. |
|
|
| ## License |
|
|
| This project is licensed under the MIT License - see the [LICENSE](../LICENSE) file for details. |
