Skip to main content

Asynchronous Python ODM for MongoDB

Project description

Beanie

shields badge pypi

Overview

Beanie - is an Asynchronous Python object-document mapper (ODM) for MongoDB, based on Motor and Pydantic.

When using Beanie each database collection has a corresponding Document that is used to interact with that collection. In addition to retrieving data, Beanie allows you to add, update, or delete documents from the collection as well.

Beanie saves you time by removing boiler-plate code and it helps you focus on the parts of your app that actually matter.

Data and schema migrations are supported by Beanie out of the box.

Installation

PIP

pip install beanie

Poetry

poetry add beanie

Example

from typing import Optional
from pydantic import BaseModel
from beanie import Document, Indexed, init_beanie
import asyncio, motor

class Category(BaseModel):
    name: str
    description: str

class Product(Document):
    name: str                          # You can use normal types just like in pydantic
    description: Optional[str] = None
    price: Indexed(float)              # You can also specify that a field should correspond to an index
    category: Category                 # You can include pydantic models as well

# Beanie is fully asynchronous, so we will access it from an async function
async def example():
    # Beanie uses Motor under the hood 
    client = motor.motor_asyncio.AsyncIOMotorClient("mongodb://user:pass@host:27017")

    # Init beanie with the Product document class
    await init_beanie(database=client.db_name, document_models=[Product])

    chocolate = Category(name="Chocolate", description="A preparation of roasted and ground cacao seeds.")
    # Beanie documents work just like pydantic models
    tonybar = Product(name="Tony's", price=5.95, category=chocolate)
    # And can be inserted into the database
    await tonybar.insert() 
    
    # You can find documents with pythonic syntax
    product = await Product.find_one(Product.price < 10)
    
    # And update them
    await product.set({Product.name:"Gold bar"})
    
asyncio.run(example())

Links

Documentation

  • Doc - Tutorial, API docmentation, and development guidlines.

Example Projects

Articles

Resources

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

Sponsor the project

  • Bitcoin bc1qz8z0uhftdcra7u8hjyft6nqn30uhktlcgsg0tq
  • Doge DPKs32RSEVwPiKuGAAmQHZ8VQ8BQK5Qg4L

Supported by JetBrains

JetBrains

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

beanie-1.9.0.tar.gz (41.4 kB view details)

Uploaded Source

Built Distribution

beanie-1.9.0-py3-none-any.whl (61.5 kB view details)

Uploaded Python 3

File details

Details for the file beanie-1.9.0.tar.gz.

File metadata

  • Download URL: beanie-1.9.0.tar.gz
  • Upload date:
  • Size: 41.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.9.10 Linux/5.11.0-1028-azure

File hashes

Hashes for beanie-1.9.0.tar.gz
Algorithm Hash digest
SHA256 885e073dd376adf39e7ceab558cfdf87bd65ef6ab9fb7bac3f4da0845b0ff173
MD5 68960e24255683e393e3d46fa3299682
BLAKE2b-256 8df7eb17b9cb51b2e34e1e60404d90f7745d9e8ee9e96f582927f92608c90b45

See more details on using hashes here.

File details

Details for the file beanie-1.9.0-py3-none-any.whl.

File metadata

  • Download URL: beanie-1.9.0-py3-none-any.whl
  • Upload date:
  • Size: 61.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.9.10 Linux/5.11.0-1028-azure

File hashes

Hashes for beanie-1.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 71201ca0913906a148e22ec27805f366f3439c2f5276c8668c97039da32e4383
MD5 2f59cbbbee9c69858bd9d48fdeb541c3
BLAKE2b-256 38725201a66bb6fb250dffb50722a172e0caa6794681c4a3840e9e5272fcac6f

See more details on using hashes here.

Supported by

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