| 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) |
MongoEngine is a Python Object-Document Mapper for working with MongoDB. Documentation available at https://mongoengine-odm.readthedocs.io - there is currently a tutorial, a user guide and an API reference.
We recommend the use of virtualenv and of
pip. You can then use pip install -U mongoengine.
You may also have setuptools and thus
you can use easy_install -U mongoengine. Otherwise, you can download the
source from GitHub and run python
setup.py install.
- pymongo>=2.7.1
- sphinx (optional - for documentation generation)
- Image Fields: Pillow>=2.0.0
- dateutil>=2.1.0
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(TextPost.objects)
1
>>> len(LinkPost.objects)
1
# Find tagged posts
>>> len(BlogPost.objects(tags='mongoengine'))
2
>>> len(BlogPost.objects(tags='mongodb'))
1To run the test suite, ensure you are running a local instance of MongoDB on
the standard port and have installed nose and rednose, and run: python setup.py nosetests.
To run the test suite on every supported Python version and every supported PyMongo version,
you can use tox.
tox and each supported Python version should be installed in your environment:
# Install tox
$ pip install tox
# Run the test suites
$ toxIf you wish to run one single or selected tests, use the nosetest convention. It will find the folder, eventually the file, go to the TestClass specified after the colon and eventually right to the single test. Also use the -s argument if you want to print out whatever or access pdb while testing.
$ python setup.py nosetests --tests tests/fields/fields.py:FieldTest.test_cls_field -sWe welcome contributions! see the Contribution guidelines