Source

jaraco.modb / README

Full commit
===========
jaraco.modb
===========

.. contents::

Overview
--------

``jaraco.modb`` is a small, pure-Python library for persisting Python
objects to `MongoDB <http://www.mongodb.org/>`_.

``jaraco.modb`` is written by Jason R. Coombs.  It is licensed under an
`MIT-style permissive license
<http://www.opensource.org/licenses/mit-license.php>`_.

You can install it with ``easy_install jaraco.modb`` or grab the source
code from the `mercurial repository
<http://bitbucket.org/jaraco/jaraco.modb>`_.

Usage
-----

``jaraco.modb`` facilitates using `jsonpickle` to produce MongoDB-friendly
representations of pickleable Python objects for easy storage in a MongoDB
database.

The jsonpickle module requires initialization to use the backends supplied
by jaraco.modb, so the application must first call `init()`::

    import jaraco.modb
    jaraco.modb.init()

Thereafter, one can simply encode and decode Python objects to MongoDB
BSON-friendly representations::

    class MyObject(object):
        def __init__(self, val):
            self.val = val

    import pymongo
    mongo_collection = pymongo.Connection().mydb.mycollection
    val = MyObject(3)
    # save the object to the DB
    id = mongo_collection.save(jaraco.modb.encode(val))
    # retrieve the object from the DB
    new_val = jaraco.modb.decode(mongo_collection.find_one(id))
    assert isinstance(new_val, MyObject)
    assert new_val.val == 3

Changes
-------

1.0
~~~

* Initial release