Skip to main content

A syncrounous and asyncrounous Python ODM for MongoDB based on Pydantic

Project description


Documentation: https://pyodmongo.dev

Source Code: https://github.com/mauro-andre/pyodmongo


PyODMongo is a modern Python library that functions as a robust Object-Document Mapper (ODM) for MongoDB. Leveraging the power of Pydantic V2, it seamlessly bridges the gap between Python and MongoDB, offering an intuitive and efficient way to interact with MongoDB documents.

By using PyODMongo, you can effortlessly map your Python classes to MongoDB documents, allowing for a more Pythonic approach to handling data. This library simplifies the entire process of defining and working with MongoDB collections, documents, and queries.

PyODMongo is built on top of Pydantic V2, making the DbModel class an extension of Pydantic's BaseModel. This means that all the rich functionality of Pydantic's BaseModel, including Validators, Fields and Model Config, is readily available in DbModel.

Key Features

  • Integration with pydantic: Leverage the power of pydantic's data validation and modeling capabilities while working with MongoDB data.

  • Automatic Schema Generation: Define your MongoDB schema using pydantic models, and pyodmongo will automatically create the necessary MongoDB collections and ensure data consistency.

  • Query Builder: Easily construct complex MongoDB queries using Python code, reducing the need for writing raw query strings.

  • Document Serialization: Serialize and deserialize Python objects to and from MongoDB documents effortlessly.

  • Async Support: Take advantage of asynchronous programming with pyodmongo to enhance the performance of your MongoDB operations.

  • Active Development: pyodmongo is actively developed and maintained, with new features and improvements being regularly added.

Installation

You can install pyodmongo using pip:

pip install pyodmongo

Contributing

Contributions to pyodmongo are welcome! If you find any issues or have ideas for improvements, please open an issue or submit a pull request on the GitHub repository.

License

pyodmongo is licensed under the MIT License. See the LICENSE file for more information.

Async exemple

from pyodmongo import AsyncDbEngine, DbModel
from typing import ClassVar
import asyncio

engine = AsyncDbEngine(mongo_uri='mongodb://localhost:27017', db_name='my_db')


class Product(DbModel):
    name: str
    price: float
    is_available: bool
    _collection: ClassVar = 'products'


box = Product(name='Box', price='5.99', is_available=True)


async def main():
    result = await engine.save(box)

asyncio.run(main())

Sync exemple

from pyodmongo import DbEngine, DbModel
from typing import ClassVar

engine = DbEngine(mongo_uri='mongodb://localhost:27017', db_name='my_db')


class Product(DbModel):
    name: str
    price: float
    is_available: bool
    _collection: ClassVar = 'products'


box = Product(name='Box', price='5.99', is_available=True)

result = engine.save(box)

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

pyodmongo-1.6.0.tar.gz (758.8 kB view details)

Uploaded Source

Built Distribution

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

pyodmongo-1.6.0-py3-none-any.whl (32.4 kB view details)

Uploaded Python 3

File details

Details for the file pyodmongo-1.6.0.tar.gz.

File metadata

  • Download URL: pyodmongo-1.6.0.tar.gz
  • Upload date:
  • Size: 758.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.11

File hashes

Hashes for pyodmongo-1.6.0.tar.gz
Algorithm Hash digest
SHA256 24308d8193c3ba898acdffe567f6d874081c9a9f5163b8335c62d33225b62c8b
MD5 91ab3be032020de154838cba68b2d3f3
BLAKE2b-256 b9c372255a42c958436cea5cfa128d0edaffac17dc31b563eda32726e414b56d

See more details on using hashes here.

File details

Details for the file pyodmongo-1.6.0-py3-none-any.whl.

File metadata

  • Download URL: pyodmongo-1.6.0-py3-none-any.whl
  • Upload date:
  • Size: 32.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.11

File hashes

Hashes for pyodmongo-1.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 741590f9e68143de3ad8f323f67a8fcd7b87fae5b7e6f4a447db501ada0eed89
MD5 c2977c52ffd664a9d62e56c16a3eeb80
BLAKE2b-256 f2d949507de76c786c868827671f413c32149fc680deb578c9e9d258c26c9bb6

See more details on using hashes here.

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