Skip to content

A Python Object-Document-Mapper for working with MongoDB

License

Notifications You must be signed in to change notification settings

bmhkim/mongoengine

This branch is 2086 commits behind MongoEngine/mongoengine:master.

Folders and files

NameName
Last commit message
Last commit date
Dec 4, 2014
Jan 6, 2015
Dec 4, 2014
Jun 18, 2012
Nov 12, 2014
Nov 20, 2014
May 2, 2013
Feb 14, 2013
Mar 17, 2010
Aug 10, 2014
Jun 25, 2014
Jan 24, 2014
Sep 1, 2014
Oct 15, 2012
Jun 27, 2014

Repository files navigation

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 https://coveralls.io/repos/MongoEngine/mongoengine/badge.png?branch=master Code Health

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.7.1
  • sphinx (optional - for documentation generation)

Optional Dependencies

  • Django Integration: Django>=1.4.0 for Python 2.x or PyPy and Django>=1.5.0 for Python 3.x
  • Image Fields: Pillow>=2.0.0 or PIL (not recommended since MongoEngine is tested with Pillow)
  • 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(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

About

A Python Object-Document-Mapper for working with MongoDB

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 99.6%
  • Other 0.4%