Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/volfpeter/motorhead
Async MongoDB with vanilla Pydantic v2+ - made easy.
https://github.com/volfpeter/motorhead
api async fastapi mongodb odm pydantic python query-builder rest typed
Last synced: about 1 month ago
JSON representation
Async MongoDB with vanilla Pydantic v2+ - made easy.
- Host: GitHub
- URL: https://github.com/volfpeter/motorhead
- Owner: volfpeter
- License: mit
- Created: 2023-07-29T23:31:42.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-06T08:48:05.000Z (3 months ago)
- Last Synced: 2024-09-29T02:21:52.607Z (about 2 months ago)
- Topics: api, async, fastapi, mongodb, odm, pydantic, python, query-builder, rest, typed
- Language: Python
- Homepage: https://volfpeter.github.io/motorhead/
- Size: 854 KB
- Stars: 11
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
**Source code**: [https://github.com/volfpeter/motorhead](https://github.com/volfpeter/motorhead)
**Documentation and examples**: [https://volfpeter.github.io/motorhead](https://volfpeter.github.io/motorhead/)
# Motorhead
Async MongoDB with vanilla Pydantic v2+ - made easy.
Key features:
- Database **model** and API design with vanilla `Pydantic` v2+.
- Relationship support and validation using async **validators and delete rules** with a declarative, decorator-based syntax.
- ODM-like **query builder** for convenient, typed, and Pythonic query construction.
- Declarative **index** specification.
- Typed **utilities** for convenient model and API creation.
- Ready to use, customizable **async service layer** with **transaction support** that integrates all the above to keep your API and business logic clean, flexible, and easy to understand.
- **Simplicity**: by not being a classic ODM, the codebase is very simple and easy to understand (even contribute to) even for relative beginners.
By providing a convenient, declarative middle layer between MongoDB and your API, `motorhead` is halfway between an object document mapper (based on vanilla `Pydantic`) and a database driver (by wrapping the official, async `motor` driver). What's missing is the built-in ODM performance and memory overhead, whose benefits are rarely felt when working with document databases.
See the [full documentation here](https://volfpeter.github.io/motorhead/).
## Installation
The library is available on PyPI and can be installed with:
```console
$ pip install motorhead
```
## Examples
See the [documentation](https://volfpeter.github.io/motorhead/fastapi-example/) for usage and application examples.
## Requirements
The project depends on `motor` (the official asyncio MongoDB driver, which is built on top of `pymongo` and `bson`) and `pydantic` v2+.
## Development
Use `black` for code formatting, `mypy` for static code analysis, `ruff` for linting, and `pytest` (with `pytest-asyncio` and `pytest-docker`) for testing.
The documentation is built with `mkdocs-material` and `mkdocstrings`.
## Contributing
All contributions are welcome.
## Notes
This project is the continuation of [fastapi-motor-oil](https://github.com/volfpeter/fastapi-motor-oil) with support for [Pydantic v2](https://docs.pydantic.dev/latest/migration/), among other improvements. Migration from `fastapi-motor-oil` should be easy, but if you need help, just create an issue in the issue tracker.
## License - MIT
The library is open-sourced under the conditions of the [MIT license](https://choosealicense.com/licenses/mit/).