MongoDB is a great schema-less document oriented database. It have a lot of driver for many langages (python, ruby, perl, java, php...).

MongoKit is a python module that brings structured schema and validation layer on top of the great pymongo driver. It has be written to be simpler and lighter as possible with the KISS and DRY principles in mind.

Features

> - schema validation (wich use simple python type for the > declaration) > - nested and complex schema declaration > - required fields validation > - default values > - custom validators > - inheritance and polymorphisme support > - versionized document support (still in alpha stage) > - partial auth support (it brings a simple User model)

A quick example

MongoDocument are enhanced python dictionnary with a validate() method. A MongoDocument declaration look like that:

>>> from mongokit.pylons import MongoDocument
>>> import datetime

>>> class BlogPost(MongoDocument):
...     db_name = 'test'
...     collection_name = 'tutorial'
...     structure = {
...             'title':unicode,
...             'body':unicode,
...             'author':unicode,
...             'date_creation':datetime.datetime,
...             'rank':int
...     }
...     required_fields = ['title','author', 'date_creation']
...     default_values = {'rank':0, 'date_creation':datetime.datetime.utcnow}
... 
>>> blogpost = BlogPost()
>>> blogpost['title'] = u'my title'
>>> blogpost['body'] = u'a body'
>>> blogpost['author'] = u'me'
>>> blogpost.validate()
>>> blogpost # doctest: +ELLIPSIS, +NORMALIZE_WHITESPACE
{'body': u'a body', 'title': u'my title', 'date_creation': datetime.datetime(...), 

'rank': 0, 'author': u'me'}
>>> blogpost.save()

And you can use more complex structure:

>>> class ComplexDoc(MongoDocument):
...     db_name = 'test'
...     collection_name = 'tutorial'
...     structure = {
...         "foo" : {"content":int},
...         "bar" : {
...             int:{unicode:int}
...         }
...     }
...     required_fields = ['foo.content', 'bar.$int']

Please, see the tutorial for more examples.

[ For any questions related to this fork, especially the Pylons & Autoref (and properties) support, rather than the core mongokit code, please contact myself (Brendan McAdams ) rather than namlook. I can be reached at *.com, and sometimes lurk on freenode #mongodb as bwmcadams.]