Skip to main content

Neat ODM wrapper around great PyMongo driver

Project description

Build Status Latest Version

Documentation: #TODO

Ognom is object-to-document mapper for mongodb. Currently ognom uses pymongo as default backend, but you can easily implement your own backend based on another driver (for example asyncio-mongo) if needed, as serialization and storage logic in ognom are separated.

Supports python2.7+, python3.3+, PyPy.

Documentation: #TODO

Install

pip install ognom

Tests

tox

Features

  • Vanilla python, no dependencies;

  • From version 1.0 exposes full pymongo API(!);

  • Easy to write your own backend with your own API.

Quickstart

from ognom.base import ConnectionManager, Document, Collection
from ognom.fields import StringField, IntField

ConnectionManager.connect({
    'main': {  # ognom use aliases for databases to make it possible to use multiple db's per project
        'name': 'birzha_main',
        'args': ['127.0.0.1:27017'],
        'kwargs': {'socketTimeoutMS': 60000}},})


class Foo(Document):
    objects = Collection(
        db_name='main'
        collection_name='my_foos'  # collection name (by default 'foos')
        indexes=[{
            'index': [('bar', 1), ('baz', -1)],
            'background': True}])

    bar = StringField(required=True, default='baaar')
    baz = IntField(choices=[10, 20, 30, 40, 50])


foo1 = Foo.objects.create({'bar': 'lalala'})
assert Foo.objects.get({'bar': 'lalala'}).id == foo1.id

foo2 = Foo(bar='lololo', baz=10)
assert foo2.id is None
foo2.save()
assert foo2.id is not None
foo2.remove()

foos = Foo.objects.find({'bar': 'lalala'})  # not list but CursorWrapper!
assert len(list(foos)) == 1

Contributors

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

ognom-0.5.4.tar.gz (16.2 kB view hashes)

Uploaded Source

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