ognom

ognom

.. image:: https://travis-ci.org/lorehov/ognom.svg :target: https://travis-ci.org/lorehov/ognom :alt: Build Status

.. image:: https://img.shields.io/pypi/v/ognom.svg :target: https://pypi.python.org/pypi/ognom :alt: Latest Version

Documentation: #TODO

Ognom is object-to-document mapper for mongodb <https://www.mongodb.org>. Currently ognom uses pymongo <https://api.mongodb.org/python/current/> as default backend, but you can easily implement your own backend based on another driver (for example asyncio-mongo <https://pypi.python.org/pypi/asyncio_mongo>_) if needed, as serialization and storage logic in ognom are separated.

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

Documentation: #TODO

Install

.. code-block:: python

pip install ognom

Tests

.. code-block:: python

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

.. code-block:: python

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

• Lev Orekhov @lorehov <https://github.com/lorehov>_
• Michael Elovskikh @wronglink <https://github.com/wronglink>_
• Sardnej @sardnej <https://github.com/sardnej>_