mdocument

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.1612471879

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.1612471879
File	Size	Uploaded
mdocument-4.0.1612471879.tar.gz	10.7 kB	Feb 4, 2021	Details

Built distribution (wheel)

Table of built distributions (wheels) for mdocument 4.0.1612471879
File	Interpreter	ABI	Platform	Reset
mdocument-4.0.1612471879-py3-none-any.whl 13.2 kB Feb 4, 2021	Python 3	none	any	Details

Total release size: 23.9 kB

Release files / mdocument-4.0.1612471879.tar.gz

Download URL	mdocument-4.0.1612471879.tar.gz
Size	10.7 kB
Tags	Source
SHA-256 checksum How to use checksums	`690eda1770c6d4a1162beb7719a54553bba0804b2c90de31b9e62a60df13f448`
BLAKE2b-256 checksum How to use checksums	`f0c4849461262dc505d38c7033e7704cf94f024c815ac88afb3d38e6a11a2f01`
Upload date	Feb 4, 2021
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.1612471879-py3-none-any.whl

Download URL	mdocument-4.0.1612471879-py3-none-any.whl
Size	13.2 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`1071a6be7289c90fdf76c0da8c647f57501f457390c2f4712b18a672851208be`
BLAKE2b-256 checksum How to use checksums	`0548dc2639c294fc7b878eeb595f2c3f2f82e035a9aafc2eaca689216a19d3c1`
Upload date	Feb 4, 2021
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`