Beanie

shields badge pypi pre-commit.ci status

Overview

Beanie - is an asynchronous Python object-document mapper (ODM) for MongoDB. Data models are based on 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 boilerplate 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.

There is a synchronous version of Beanie ODM - Bunnet

Installation

PIP

pip install beanie

Poetry

poetry add beanie

For more installation options (eg: aws, gcp, srv ...) you can look in the getting started

Example

import asyncio
from typing import Optional

from pymongo import AsyncMongoClient
from pydantic import BaseModel

from beanie import Document, Indexed, init_beanie


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


# This is an asynchronous example, so we will access it from an async function
async def example():
    # Beanie uses PyMongo async client under the hood
    client = AsyncMongoClient("mongodb://user:pass@host:27017")

    # Initialize 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"})


if __name__ == "__main__":
    asyncio.run(example())

Links

Documentation

  • Doc - Tutorial, API documentation, and development guidelines.

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

Project links

Data verified by PyPI on
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for roman-right from gravatar.com roman-right

Credits

Author: Roman Right

GitHub Statistics

Data verified by PyPI on 
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License

Apache Software License

Requires

Python <3.14, >=3.10

Provides Extra

aws ci doc encryption gssapi ocsp queue snappy test zstd

Tags

mongodb odm orm pydantic mongo async python

Classifiers

Report project as malware

Download files

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

Source Distribution

beanie-2.2.0.tar.gz (70.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

beanie-2.2.0-py3-none-any.whl (93.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: beanie-2.2.0.tar.gz
  • Upload date:
  • Size: 70.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for beanie-2.2.0.tar.gz
Algorithm Hash digest
SHA256 2dc116e7f4a6650f8066f95851d34d898983af6ffaf5366dcfef892993537a51
MD5 c15b4809459f71490e98c7b75df117e4
BLAKE2b-256 6ba14abc93d5437999c55465f68c3c81e4735cdfe22827072c0e9cab00f63d11

See more details on using hashes here.

Provenance

The following attestation bundles were made for beanie-2.2.0.tar.gz:

Publisher: github-actions-publish-project.yml on BeanieODM/beanie

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

  • Download URL: beanie-2.2.0-py3-none-any.whl
  • Upload date:
  • Size: 93.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for beanie-2.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4074f893ef00c52b8538b814c9dfd55130eea4ed0579abfae72853657c9029e4
MD5 fc0e05f52bd72e06ac4ded691fd81cbe
BLAKE2b-256 c5ae2584fb9871b58f3c5334110f8ce00bd1421fe5fbda28eeac9a8d01d10ba6

See more details on using hashes here.

Provenance

The following attestation bundles were made for beanie-2.2.0-py3-none-any.whl:

Publisher: github-actions-publish-project.yml on BeanieODM/beanie

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

2.2.0

2.1.0

2.0.1

2.0.0

1.30.0

1.29.0

1.28.0

1.27.0

1.26.0

1.25.0

1.24.0

1.23.6

1.23.5

1.23.4

1.23.3

1.23.2

1.23.1

1.23.0

1.22.6

1.22.5

1.22.4

1.22.3

1.22.2

1.22.1

1.22.0

1.21.0

1.21.0b1 pre-release

1.21.0b0 pre-release

1.20.0

1.20.0b1 pre-release

1.20.0b0 pre-release

1.19.2

1.19.1

1.19.0

1.18.1

1.18.0

1.18.0b1 pre-release

1.18.0b0 pre-release

1.17.0

1.16.8

1.16.7

1.16.6

1.16.5

1.16.4

1.16.3

1.16.2

1.16.1

1.16.0

1.16.0b3 pre-release

1.16.0b2 pre-release

1.16.0b1 pre-release

1.16.0b0 pre-release

1.15.5

1.15.4

1.15.3

1.15.2

1.15.1

1.15.0

1.14.1

1.14.0

1.13.1

1.13.0

1.12.1

1.12.0

1.11.12

1.11.11

1.11.10

1.11.9

1.11.8

1.11.7

1.11.6

1.11.5

1.11.4

1.11.3

1.11.2

1.11.1

1.11.0

1.10.9

1.10.8

1.10.7

1.10.6

1.10.5

1.10.4

1.10.3

1.10.2

1.10.1

1.10.0

1.9.2

1.9.1

1.9.0

1.8.13

1.8.12

1.8.10

1.8.9

1.8.8

1.8.7

1.8.6

1.8.5

1.8.4

1.8.3

1.8.2

1.8.1

1.8.0

1.7.2

1.7.1

1.7.0

1.6.3

1.6.2

1.6.1

1.6.0

1.5.1

1.5.0

1.4.0

1.3.0

1.2.8

1.2.7

1.2.6

1.2.5

1.2.4

1.2.3

1.2.2

1.2.1

1.2.0

1.1.6

1.1.5

1.1.4

1.1.3

1.1.2

1.1.1

1.1.0

1.0.6

1.0.5

1.0.4

1.0.3

1.0.2

1.0.1

1.0.0

1.0.0b3 pre-release

1.0.0b2 pre-release

1.0.0b1 pre-release

0.4.3

0.4.2

0.4.1

0.4.0

0.4.0b1 pre-release

0.3.4

0.3.3

0.3.2

0.3.1

0.3.0

0.2.3

0.2.2

0.2.1

0.2.0

0.1.1

0.1.0

Supported by

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