Metadata-Version: 2.1
Name: beanie
Version: 0.3.2
Summary: MongoDB ODM based on Pydantic and Motor
Home-page: https://github.com/roman-right/beanie
License: Apache-2.0
Keywords: mongo,mongodb,pydantic,odm
Author: Roman
Author-email: roman-right@protonmail.com
Requires-Python: >=3.8,<4.0
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: motor (>=2.1.0,<3.0.0)
Requires-Dist: pydantic (>=1.5.1,<2.0.0)
Project-URL: Repository, https://github.com/roman-right/beanie
Description-Content-Type: text/markdown

![Beanie](https://raw.githubusercontent.com/roman-right/beanie/main/assets/logo/with_text.svg)

Beanie - is an asynchronous ODM for MongoDB, based on [Motor](https://motor.readthedocs.io/en/stable/)
and [Pydantic](https://pydantic-docs.helpmanual.io/).

It uses an abstraction over Pydantic models and Motor collections to work with the database. Class Document allows to
create, replace, update, get, find and aggregate.

### Installation

#### PIP

```shell
pip install beanie
```

#### Poetry

```shell
poetry add beanie
```

### Quick Start

**[Documentation](https://roman-right.github.io/beanie/)** - here you can find all the methods descriptions and usage examples

### Resources

- **[Changelog](https://roman-right.github.io/beanie/changelog)** - list of all the valuable changes
- **[Discord](https://discord.gg/ZTTnM7rMaz)** - ask your questions, share ideas or just say `Hello!!`

### Articles

- [Announcing Beanie - MongoDB ODM](https://dev.to/romanright/announcing-beanie-mongodb-odm-56e)
- [Build a Cocktail API with Beanie and MongoDB](https://developer.mongodb.com/article/beanie-odm-fastapi-cocktails/)
- [MongoDB indexes with Beanie](https://dev.to/romanright/mongodb-indexes-with-beanie-43e8)
