llms.txt Content
# Equipment: Python Project Scaffolding Framework
> Equipment is a comprehensive scaffolding framework designed to simplify and streamline Python project development. It provides a robust, flexible foundation for projects of any scale, from simple scripts to enterprise applications. Key features include built-in Dependency Injection, modular configuration, SQLAlchemy ORM, background queues, task scheduling, and an abstract storage API.
## Core Documentation
- [Full Docs (Text)](https://equipment-python.vercel.app/llms-full.txt): Comprehensive technical documentation optimized for LLMs.
- [Official Website](https://equipment-python.vercel.app): Interactive documentation and guides.
## Quick Start
```bash
pip install equipment
equipment new my-app
cd my-app && pip install .
python main.py
```
## Features & Guides
- [Dependency Injection](https://equipment-python.vercel.app/docs/features/dependency-injection): Manage object lifecycles with singletons.
- [Configuration](https://equipment-python.vercel.app/docs/features/config): YAML/JSON/INI support with env var interpolation.
- [Database](https://equipment-python.vercel.app/docs/features/database): SQLAlchemy and Alembic integration.
- [Logging](https://equipment-python.vercel.app/docs/features/log): Multi-channel logging with JSON support.
- [Queue & Worker](https://equipment-python.vercel.app/docs/features/queue): Async task processing with Redis.
- [Task Scheduler](https://equipment-python.vercel.app/docs/features/scheduler): Recurring task scheduling.
- [Storage API](https://equipment-python.vercel.app/docs/features/storage): Unified Local/S3 filesystem interface.
- [Testing](https://equipment-python.vercel.app/docs/features/tests): Pre-configured pytest environment with Faker.
- [Compilation](https://equipment-python.vercel.app/docs/features/compilation): Bytecode distribution tool.
## Examples
- [FastAPI Integration](https://equipment-python.vercel.app/docs/examples/fastapi): Building a modern web API wi