beanie 0.4.1

Asynchronous Python ODM for MongoDB

Beanie - is an Asynchronous Python ODM for MongoDB, based on Motor and Pydantic.

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.

Beanie supports migrations out of the box.

Installation

PIP

pip install beanie

Poetry

poetry add beanie

Quick Start

from typing import Optional, List

import motor
from beanie import Document, init_beanie
from pydantic import BaseModel


class Tag(BaseModel):
    name: str
    color: str


class Note(Document):
    title: str
    text: Optional[str]
    tag_list: List[Tag] = []


async def main():
    # Crete Motor client
    client = motor.motor_asyncio.AsyncIOMotorClient(
        "mongodb://user:pass@host:27017"
    )
    
    # Init beanie with the Note document class
    await init_beanie(database=client.db_name, document_models=[Note])

    # Get all the notes
    all_notes = await Note.find_all().to_list()

Materials

ODM

• Tutorial - ODM usage examples
• Documentation - Full list of the ODM classes and methods with descriptions

Migrations

• Tutorial - Migrations usage examples

Example Projects

• FastAPI Demo - Beanie and FastAPI collaboration demonstration. CRUD and Aggregation.
• Indexes Demo - Regular and Geo Indexes usage example wrapped to a microservice.

Articles

• Announcing Beanie - MongoDB ODM
• Build a Cocktail API with Beanie and MongoDB
• MongoDB indexes with Beanie

Resources

• GitHub - GitHub page of the project
• Changelog - list of all the valuable changes
• Discord - ask your questions, share ideas or just say Hello!!