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!!

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.11.8.tar.gz (45.4 kB view details)

Uploaded Source

Built Distribution

beanie-1.11.8-py3-none-any.whl (69.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: beanie-1.11.8.tar.gz
  • Upload date:
  • Size: 45.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.10.5 Linux/5.15.0-1017-azure

File hashes

Hashes for beanie-1.11.8.tar.gz
Algorithm Hash digest
SHA256 dada69e80e9ef353a3952adfd8fd79bde5e0b77d7d91bfd0da632619c0df626b
MD5 7f3bd73b24ca4e0e678ea3c81ce492d7
BLAKE2b-256 b886a9102f98493669eec5e2706680fa8b36546873acd25821a7f6283c5646ae

See more details on using hashes here.

File details

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

File metadata

  • Download URL: beanie-1.11.8-py3-none-any.whl
  • Upload date:
  • Size: 69.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.10.5 Linux/5.15.0-1017-azure

File hashes

Hashes for beanie-1.11.8-py3-none-any.whl
Algorithm Hash digest
SHA256 716f74df83ad76525e4db15a1b39bc99f5074efeb211b40082886c128b68d919
MD5 9d3814966b8c4b11b8f4acef1267b418
BLAKE2b-256 fa8dc12e9e4e38794f691c70eeb2fdd3939af16569d0354cd7f67fd9585f87b5

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