mirror of
https://github.com/d3vyce/fastapi-toolsets.git
synced 2026-03-01 17:00:48 +01:00
73fae04333
* chore: move dependencies module to the project root * chore:update README * chore: clean conftest * chore: remove old code + comment * fix: uv.lock dependencies
68 lines
3.2 KiB
Markdown
68 lines
3.2 KiB
Markdown
# FastAPI Toolsets
|
|
|
|
A modular collection of production-ready utilities for FastAPI. Install only what you need — from async CRUD and database helpers to CLI tooling, Prometheus metrics, and pytest fixtures. Each module is independently installable via optional extras, keeping your dependency footprint minimal.
|
|
|
|
[](https://github.com/d3vyce/fastapi-toolsets/actions/workflows/ci.yml)
|
|
[](https://codecov.io/gh/d3vyce/fastapi-toolsets)
|
|
[](https://github.com/astral-sh/ty)
|
|
[](https://github.com/astral-sh/uv)
|
|
[](https://github.com/astral-sh/ruff)
|
|
[](https://www.python.org/downloads/)
|
|
[](https://opensource.org/licenses/MIT)
|
|
|
|
---
|
|
|
|
**Documentation**: [https://fastapi-toolsets.d3vyce.fr](https://fastapi-toolsets.d3vyce.fr)
|
|
|
|
**Source Code**: [https://github.com/d3vyce/fastapi-toolsets](https://github.com/d3vyce/fastapi-toolsets)
|
|
|
|
---
|
|
|
|
## Installation
|
|
|
|
The base package includes the core modules (CRUD, database, schemas, exceptions, fixtures, dependencies, logging):
|
|
|
|
```bash
|
|
uv add fastapi-toolsets
|
|
```
|
|
|
|
Install only the extras you need:
|
|
|
|
```bash
|
|
uv add "fastapi-toolsets[cli]" # CLI (typer)
|
|
uv add "fastapi-toolsets[metrics]" # Prometheus metrics (prometheus_client)
|
|
uv add "fastapi-toolsets[pytest]" # Pytest helpers (httpx, pytest-xdist)
|
|
```
|
|
|
|
Or install everything:
|
|
|
|
```bash
|
|
uv add "fastapi-toolsets[all]"
|
|
```
|
|
|
|
## Features
|
|
|
|
### Core
|
|
|
|
- **CRUD**: Generic async CRUD operations with `CrudFactory`, built-in search with relationship traversal
|
|
- **Database**: Session management, transaction helpers, table locking, and polling-based row change detection
|
|
- **Dependencies**: FastAPI dependency factories (`PathDependency`, `BodyDependency`) for automatic DB lookups from path or body parameters
|
|
- **Fixtures**: Fixture system with dependency management, context support, and pytest integration
|
|
- **Standardized API Responses**: Consistent response format with `Response`, `PaginatedResponse`, and `PydanticBase`
|
|
- **Exception Handling**: Structured error responses with automatic OpenAPI documentation
|
|
- **Logging**: Logging configuration with uvicorn integration via `configure_logging` and `get_logger`
|
|
|
|
### Optional
|
|
|
|
- **CLI**: Django-like command-line interface with fixture management and custom commands support
|
|
- **Metrics**: Prometheus metrics endpoint with provider/collector registry
|
|
- **Pytest Helpers**: Async test client, database session management, `pytest-xdist` support, and table cleanup utilities
|
|
|
|
## License
|
|
|
|
MIT License - see [LICENSE](LICENSE) for details.
|
|
|
|
## Contributing
|
|
|
|
Contributions are welcome! Please feel free to submit issues and pull requests.
|