A Python Object-Document-Mapper for working with MongoDB [moved to mongoengine/mongoengine]
Python
#581 Compare This branch is 1429 commits behind MongoEngine:master.
Permalink
Failed to load latest commit information.
docs Added Garry Polley to contributors list Oct 1, 2012
mongoengine Merge branch 'master' of github.com:hmarr/mongoengine Oct 1, 2012
tests Fixed reload issue with ReferenceField where dbref=False (MongoEngine… Sep 24, 2012
.gitignore
.travis.yml
AUTHORS Added Garry Polley to contributors list Oct 1, 2012
CONTRIBUTING.rst Updates to the readme Sep 27, 2012
LICENSE Updated License Aug 1, 2012
MANIFEST.in
README.rst
benchmark.py
python-mongoengine.spec
requirements.txt Added for read the docs Mar 5, 2012
setup.cfg Cleaned up the metaclasses for documents Aug 17, 2012
setup.py Updated setup.py Sep 4, 2012

README.rst

MongoEngine

Info:MongoEngine is an ORM-like layer on top of PyMongo.
Repository:https://github.com/MongoEngine/mongoengine
Author: Harry Marr (http://github.com/hmarr)
Maintainer:Ross Lawley (http://github.com/rozza)
https://secure.travis-ci.org/MongoEngine/mongoengine.png?branch=master

About

MongoEngine is a Python Object-Document Mapper for working with MongoDB. Documentation available at http://mongoengine-odm.rtfd.org - there is currently a tutorial, a user guide and an API reference.

Installation

If you have setuptools you can use easy_install -U mongoengine. Otherwise, you can download the source from GitHub and run python setup.py install.

Dependencies

  • pymongo 2.1.1+
  • sphinx (optional - for documentation generation)

Examples

Some simple examples of what MongoEngine code looks like:

class BlogPost(Document):
    title = StringField(required=True, max_length=200)
    posted = DateTimeField(default=datetime.datetime.now)
    tags = ListField(StringField(max_length=50))

class TextPost(BlogPost):
    content = StringField(required=True)

class LinkPost(BlogPost):
    url = StringField(required=True)

# Create a text-based post
>>> post1 = TextPost(title='Using MongoEngine', content='See the tutorial')
>>> post1.tags = ['mongodb', 'mongoengine']
>>> post1.save()

# Create a link-based post
>>> post2 = LinkPost(title='MongoEngine Docs', url='hmarr.com/mongoengine')
>>> post2.tags = ['mongoengine', 'documentation']
>>> post2.save()

# Iterate over all posts using the BlogPost superclass
>>> for post in BlogPost.objects:
...     print '===', post.title, '==='
...     if isinstance(post, TextPost):
...         print post.content
...     elif isinstance(post, LinkPost):
...         print 'Link:', post.url
...     print
...

>>> len(BlogPost.objects)
2
>>> len(HtmlPost.objects)
1
>>> len(LinkPost.objects)
1

# Find tagged posts
>>> len(BlogPost.objects(tags='mongoengine'))
2
>>> len(BlogPost.objects(tags='mongodb'))
1

Tests

To run the test suite, ensure you are running a local instance of MongoDB on the standard port, and run: python setup.py test.

Community

Contributing

We welcome contributions! see the`Contribution guidelines <https://github.com/MongoEngine/mongoengine/blob/master/CONTRIBUTING.rst>`_