This section provides documentation for the various technologies and tools used in this project. Each page includes information about what the tool does, how it's configured in this project, and how to use it effectively.
- hatchling - Modern Python project build backend
- lazy-loader - Deferred module loading for Python
- pydantic-settings - Settings management for Python
- pyright - Static type checker for Python
- bandit - Security-focused static analyzer
- vulture - Dead code detector
- shellcheck-py - Shell script linter for Python
- ruff - Fast Python linter and formatter
- flynt - Python string format converter
- pyupgrade - Python syntax upgrader
- mkinit - Python
__init__.pygenerator - commitizen - Standardized commit messages
- darglint - Docstring argument linter
- codespell - Spell checker for code
- mdformat - Markdown formatter
- interrogate - Docstring coverage checker
- radon - Code complexity analyzer
- xenon - Code maintainability checker
- mkdocs - Project documentation generator
- mkdocs-material - Material theme for MkDocs
- poethepoet - Task runner for Python projects
- pytest - Python testing framework
- pytest-cov - Code coverage for pytest
- pytest-asyncio - Testing asynchronous code with pytest
- pytest-xdist - Distributed testing with pytest
- pre-commit - Git hooks framework
- git - Distributed version control system
Each technology page follows a consistent structure:
- Overview - A brief description of what the tool does and its key features
- Installation - How to install the tool in this project
- How It's Used in This Project - Specific ways the tool is utilized
- Configuration in This Project - How the tool is configured
- Basic Usage - Common commands and usage patterns
- Examples - Practical examples of using the tool
- Best Practices - Recommended approaches when using the tool
- Resources - Links to official documentation and helpful resources
For a more comprehensive understanding of how these technologies work together, see the Development Workflow documentation.