Home

Awesome

shields badge pypi

Bunnet

The logo is generated by WOMBO Dream

Overview

Bunnet - is a Python object-document mapper (ODM) for MongoDB. It is a synchronous fork of Beanie ODM.

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

Bunnet saves you time by removing boilerplate code, and it helps you focus on the parts of your app that actually matter.

Installation

PIP

pip install bunnet

Poetry

poetry add bunnet

Example

from typing import Optional

from pymongo import MongoClient
from pydantic import BaseModel

from bunnet import Document, Indexed, init_bunnet


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



# Bunnet uses Pymongo client under the hood 
client = MongoClient("mongodb://user:pass@host:27017")

# Initialize bunnet with the Product document class
init_bunnet(database=client.db_name, document_models=[Product])

chocolate = Category(name="Chocolate", description="A preparation of roasted and ground cacao seeds.")
# Bunnet documents work just like pydantic models
tonybar = Product(name="Tony's", price=5.95, category=chocolate)
# And can be inserted into the database
tonybar.insert() 

# You can find documents with pythonic syntax
product = Product.find_one(Product.price < 10).run()

# And update them
product.set({Product.name:"Gold bar"})

Links

Documentation

Resources

Supported by JetBrains

JetBrains