MongoEngine is a Python Object-Document Mapper for working with MongoDB.
Project description
- Info:
MongoEngine is an ORM-like layer on top of PyMongo.
- Repository:
- Maintainer:
Ross Lawley (http://github.com/rozza)
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
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.
Dependencies
pymongo>=2.7.1
sphinx (optional - for documentation generation)
Optional Dependencies
Image Fields: Pillow>=2.0.0
dateutil>=2.1.0
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(TextPost.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 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 -sCommunity
Contributing
We welcome contributions! see the Contribution guidelines
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file mongoengine-0.10.4.tar.gz.
File metadata
- Download URL: mongoengine-0.10.4.tar.gz
- Upload date:
- Size: 345.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 96c9e86271df084aedd50b5828aa79a7834edbb76660358474f0107e234a0fe0 |
|
| MD5 | c619922d3295c46a9b94e575e24e2627 |
|
| BLAKE2b-256 | b815e49ed3bf7a1345ae95aa77f991049931ca8320cf9d75cc9e43568e7fda11 |
