Equipment

# Equipment Documentation > Documentation for building and maintaining Python applications with Equipment. Equipment is a Python project scaffolding framework for building applications with configuration, dependency injection, logging, database access, queues, scheduling, storage, tests, compilation, and optional FastAPI serving. Use this file as an LLM-oriented index. For complete offline documentation content, use https://equipment-python.vercel.app/llms-full.txt. Important constraints: - Supported Python versions are 3.12, 3.13, and 3.14. - Equipment projects use unittest, not pytest. - Generated projects must remain portable across Linux, macOS, and Windows. - Runtime dependencies are managed from requirements.txt and should not be changed unless dependency upgrades are explicitly requested. - Website LLM files are generated by docusaurus-plugin-llms during npm run build. ## Table of Contents - [Equipment Overview](https://equipment-python.vercel.app/docs/intro.md): Equipment is a scaffolding framework for creating Python application projects. It gives a new project a working structure for configuration, depend... - [Installation](https://equipment-python.vercel.app/docs/getting-started/installation.md): - Python 3.12, 3.13, or 3.14. - [Generated Directory Structure](https://equipment-python.vercel.app/docs/getting-started/directory-structure.md): `equipment new my-app` creates an application scaffold with runtime code, configuration, tests, and project metadata. The structure is intentionall... - [Common Workflows](https://equipment-python.vercel.app/docs/getting-started/common-workflows.md): This page collects practical workflows for building an application with Equipment after the project has been generated. - [Dependency Injection](https://equipment-python.vercel.app/docs/features/dependency-injection.md): Equipment uses `dependency-injector` to keep service creation explicit and reusable. The framework container provides shared services, and the gene... - [Configuration](https://equipment-python.vercel.app/docs/features/config.md): Equipment loads configuration from a project base path. It first loads `.env` when present, then merges files from `config/*.ini`, `config/*.yaml`,... - [Database](https://equipment-python.vercel.app/docs/features/database.md): Equipment wraps SQLAlchemy setup in `SQLAlchemyFactory`. The generated project defaults to SQLite so the scaffold can run locally without an extern... - [Logging](https://equipment-python.vercel.app/docs/features/log.md): Equipment builds logging on top of the Python standard library. `LoggerFactory` reads `config/log.yaml`, creates handlers, and exposes familiar met... - [Queue](https://equipment-python.vercel.app/docs/features/queue.md): Equipment provides a queue abstraction with two drivers: `sync` and `redis`. - [Scheduler](https://equipment-python.vercel.app/docs/features/scheduler.md): Equipment uses the `schedule` library for recurring tasks. The generated `scheduler.py` entry point creates the app and calls `app.scheduler().run()`. - [Storage](https://equipment-python.vercel.app/docs/features/storage.md): Equipment provides a storage abstraction with local filesystem and S3-compatible drivers. Application code can call the same methods regardless of ... - [Testing](https://equipment-python.vercel.app/docs/features/tests.md): Equipment projects use the Python standard library `unittest` runner. The repository also uses `coverage` for test coverage reporting. - [Compilation](https://equipment-python.vercel.app/docs/features/compilation.md): The `equipment compile` command prepares a generated project for bytecode-based distribution. It compiles Python files to `.pyc` and copies runtime... - [FastAPI Example](https://equipment-python.vercel.app/docs/examples/fastapi.md): Generated Equipment projects include `web.py`, a small FastAPI entry point that reads host and port from `config/web.yaml` and uses the generated a... - [CLI Reference](https://equipment- […truncated]