Skip to main content

Pydantic Async Mongo Document

Project description

Pydantic Mongo Document

pydantic_mongo_document is a Python library that provides a base class for creating MongoDB documents using Pydantic models.

Installation

Install the package using pip or poetry.

Using pip

pip install pydantic_mongo_document

Using poetry

poetry add pydantic_mongo_document

Usage To use pydantic_mongo_document, you need to create a Pydantic model that represents your MongoDB document and inherit from the MongoDocument class provided by the library. Here's an example:

from pydantic_mongo_document import Document

class User(Document):
    __collection__ = "users"
    __database__ = "production"

    name: str
    email: str

In this example, we define a User Pydantic Document model with two fields (name and email) and
specifies the MongoDB collection name (users) and database name (production) using the __collection__ and __database__ class attributes.

from pydantic_mongo_document import Document


# Set the MongoDB replica configuration
Document.set_replica_config({"localhost": "mongodb://localhost:27017"})


class User(Document):
    __replica__ = "localhost"
    __collection__ = "users"
    __database__ = "production"

    name: str
    email: str


async def create_user():
    user = User(name="John", email="john@example.com")

    await user.insert()

    user = await User.one(add_query={"name": "John"})
    print(user)  # User(id=ObjectId("64fc59cf6410868c9a40644b"), name="John", email="john@example")

In this example, we created new User in database. We then used the User.one method to retrieve the user from the database.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT

Project details


Download files

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

Source Distribution

pydantic_mongo_document-0.1.7.tar.gz (4.8 kB view details)

Uploaded Source

Built Distribution

pydantic_mongo_document-0.1.7-py3-none-any.whl (5.8 kB view details)

Uploaded Python 3

File details

Details for the file pydantic_mongo_document-0.1.7.tar.gz.

File metadata

  • Download URL: pydantic_mongo_document-0.1.7.tar.gz
  • Upload date:
  • Size: 4.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.11.1 Darwin/23.5.0

File hashes

Hashes for pydantic_mongo_document-0.1.7.tar.gz
Algorithm Hash digest
SHA256 c9470579c9be2c792c2aac8c56afaeabb9da19634524b5706b5c967afd85a809
MD5 3fef028b57768a2e41c526f8451108cc
BLAKE2b-256 ccdebda9b4502f57f0706d2165b6bfbbf5edeabbcb382c2e13870c5512942999

See more details on using hashes here.

File details

Details for the file pydantic_mongo_document-0.1.7-py3-none-any.whl.

File metadata

File hashes

Hashes for pydantic_mongo_document-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 9845f9643405bd6fb7304a4fb1a1249f67d2ae67a7e56d94f3c34ad54171b29b
MD5 d60fa5ac5575acd46e83bf184be0de2f
BLAKE2b-256 01e830a7ec8bf47ee14d8636849e9fa14720d73513e1933577aa55ffb79a19cf

See more details on using hashes here.

Supported by

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