Skip to main content

A MongoDB ODM based on Motor and Pydantic.

Project description

Motor-ODM

Build Documentation Status Codecov Requirements Status PyPI - Python Version PyPI

License Code style: black

A MongoDB ODM based on Motor and Pydantic.

The project code is hosted on GitHub, documentation on ReadTheDocs.

Installation

pip install Motor-ODM

Quick Start

from motor.motor_asyncio import AsyncIOMotorClient
from motor_odm import Document

# Create a custom model by subclassing Document
class User(Document):
    class Mongo:
        # Set the collection name
        collection = "users"

    # Add attributes to your model
    username: str
    age: int

# Connect your model to a database
client = AsyncIOMotorClient(...)
Document.use(client.get_default_database())

# Create documents and save them to the database
u = User(username="John", age=20)
await u.insert()

# Query the database
async for user in User.all():
    print(user.username)

For a more complete overview have a look at the docs.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Motor-ODM-0.1.dev0.tar.gz (17.1 kB view hashes)

Uploaded Source

Built Distribution

Motor_ODM-0.1.dev0-py3-none-any.whl (12.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page