Skip to main content

pipeline status coverage report pypi link

MDocument is a simple ORM for MongoDB with addition of relations.

Usage

There are two ways of using mdocument: 1. Specify database, colleciton and client in class. 2. Use modified mongo motor client.

Specifying document parameters in class

import asyncio

import motor.motor_asyncio

from mdocument import MDocument, relations, model

client = motor.motor_asyncio.AsyncIOMotorClient()

class Video(MDocument):
    __collection__ = "videos"
    __database__ = "mdocument"
    __client__ = client

    class Model(MDocument.Model):
        title = model.Field(str)
        views_count = model.Field(int)
        public_id = model.Field(str, unique=True)

class Comment(MDocument):
    __collection__ = "comments"
    __database__ = "mdocument"
    __client__ = client

    class Model(MDocument.Model):
        text = model.Field(str)
        video = model.FieldSync(Video, relation=relations.RelationOneToMany, synced_fields=["_id", "title"])


async def main():
    video = await Video.create({"title": "Test"})

    comment1 = await Comment.create(
        video=video._id,
        message="First!",
    )

    comment2 = await Comment.create(
        video=video._id,
        message="Second!"
    )

loop = asyncio.get_event_loop()
loop.run_until_complete(main())

Now we can easily access our comments using our related documents

TODO: REWRITE DOCUMENTATION!

Metadata

Release files for mdocument 4.0.1612473357

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mdocument 4.0.1612473357
File Size Uploaded
mdocument-4.0.1612473357.tar.gz 10.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for mdocument 4.0.1612473357
File Interpreter ABI Platform
mdocument-4.0.1612473357-py3-none-any.whl Python 3 none any Details

Total release size: 24.1 kB

Release files / mdocument-4.0.1612473357.tar.gz

Download URL mdocument-4.0.1612473357.tar.gz
Size 10.7 kB
Tags Source
SHA-256 checksum
How to use checksums
d54ccc93b1c2778a4a4e9b90efe82e05300881e159402d99e4848199ff87b631
BLAKE2b-256 checksum
How to use checksums
81d7cab0eda14ddb0410cf515874a73b65b78771ea5808cd73397121869ec508
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.1

Release files / mdocument-4.0.1612473357-py3-none-any.whl

Download URL mdocument-4.0.1612473357-py3-none-any.whl
Size 13.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
8e001a0dcf377bf3092799dac820df7519f86371c287454ccd98dbe835c14c84
BLAKE2b-256 checksum
How to use checksums
192085180a74390c7f1a0cc75097e46e472ce5a66edb6d76549018a87d174864
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.1

Release history Release notifications | RSS feed

This release

4.0.1612473357 This release

2 release files

0.5

1 release file

0.4

1 release file

0.3

1 release file

0.2

1 release file

0.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page