Skip to main content

Asynchronous Python ODM for MongoDB

Project description

Beanie

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

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

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

Uploaded Source

Built Distribution

beanie-1.2.5-py3-none-any.whl (46.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: beanie-1.2.5.tar.gz
  • Upload date:
  • Size: 29.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.9.6 Linux/5.8.0-1036-azure

File hashes

Hashes for beanie-1.2.5.tar.gz
Algorithm Hash digest
SHA256 fd137f1e20df133c4d746319591d3f0a56fd86db9e4a1a27a6b76fe5c20a42d6
MD5 5f3d152750930255f3ec26637515cb77
BLAKE2b-256 0583d393f3a276d6b6c20822d7abac7ad38d067903fb370004ed3f9d75dba6ef

See more details on using hashes here.

File details

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

File metadata

  • Download URL: beanie-1.2.5-py3-none-any.whl
  • Upload date:
  • Size: 46.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.9.6 Linux/5.8.0-1036-azure

File hashes

Hashes for beanie-1.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 8aab1d2a04c3d3ab499b9828096364a5878beb87f75b4cf7481630eddcaca5ed
MD5 2b2b6f32193b31ad417ee12a228dc9ec
BLAKE2b-256 d2e62ebea6535935e6a50ca514c1830498bad734fd50a5f5bc041eb1e3820404

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