{"author":"Harry Marr","author_email":"harry.marr@gmail.com","bugtrack_url":null,"classifiers":["Development Status :: 5 - Production/Stable","Intended Audience :: Developers","License :: OSI Approved :: MIT License","Operating System :: OS Independent","Programming Language :: Python","Programming Language :: Python :: 3","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.8","Programming Language :: Python :: 3.9","Programming Language :: Python :: Implementation :: CPython","Programming Language :: Python :: Implementation :: PyPy","Topic :: Database","Topic :: Software Development :: Libraries :: Python Modules"],"description":"===========\nMongoEngine\n===========\n:Info: MongoEngine is an ORM-like layer on top of PyMongo.\n:Repository: https://github.com/MongoEngine/mongoengine\n:Author: Harry Marr (http://github.com/hmarr)\n:Maintainer: Bastien Gerard (http://github.com/bagerard)\n\n.. image:: https://travis-ci.org/MongoEngine/mongoengine.svg?branch=master\n :target: https://travis-ci.org/MongoEngine/mongoengine\n\n.. image:: https://coveralls.io/repos/github/MongoEngine/mongoengine/badge.svg?branch=master\n :target: https://coveralls.io/github/MongoEngine/mongoengine?branch=master\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/ambv/black\n\n.. image:: https://pepy.tech/badge/mongoengine/month\n :target: https://pepy.tech/project/mongoengine\n\n.. image:: https://img.shields.io/pypi/v/mongoengine.svg\n :target: https://pypi.python.org/pypi/mongoengine\n\n\n.. image:: https://readthedocs.org/projects/mongoengine-odm/badge/?version=latest\n :target: https://readthedocs.org/projects/mongoengine-odm/builds/\n\nAbout\n=====\nMongoEngine is a Python Object-Document Mapper for working with MongoDB.\nDocumentation is available at https://mongoengine-odm.readthedocs.io - there\nis currently a `tutorial `_,\na `user guide `_, and\nan `API reference `_.\n\nSupported MongoDB Versions\n==========================\nMongoEngine is currently tested against MongoDB v3.6, v4.0, v4.4, v5.0, v6.0 and v7.0. Future versions\nshould be supported as well, but aren't actively tested at the moment. Make\nsure to open an issue or submit a pull request if you experience any problems\nwith a more recent MongoDB versions.\n\nInstallation\n============\nWe recommend the use of `virtualenv `_ and of\n`pip `_. You can then use ``python -m pip install -U mongoengine``.\nYou may also have `setuptools `_\nand thus you can use ``easy_install -U mongoengine``. Another option is\n`pipenv `_. You can then use ``pipenv install mongoengine``\nto both create the virtual environment and install the package. Otherwise, you can\ndownload the source from `GitHub `_ and\nrun ``python setup.py install``.\n\nThe support for Python2 was dropped with MongoEngine 0.20.0\n\nDependencies\n============\nAll of the dependencies can easily be installed via `python -m pip `_.\nAt the very least, you'll need these two packages to use MongoEngine:\n\n- pymongo>=3.4\n\nIf you utilize a ``DateTimeField``, you might also use a more flexible date parser:\n\n- dateutil>=2.1.0\n\nIf you need to use an ``ImageField`` or ``ImageGridFsProxy``:\n\n- Pillow>=7.0.0\n\nIf you need to use signals:\n\n- blinker>=1.3\n\nExamples\n========\nSome simple examples of what MongoEngine code looks like:\n\n.. code :: python\n\n from mongoengine import *\n connect('mydb')\n\n class BlogPost(Document):\n title = StringField(required=True, max_length=200)\n posted = DateTimeField(default=datetime.datetime.utcnow)\n tags = ListField(StringField(max_length=50))\n meta = {'allow_inheritance': True}\n\n class TextPost(BlogPost):\n content = StringField(required=True)\n\n class LinkPost(BlogPost):\n url = StringField(required=True)\n\n # Create a text-based post\n >>> post1 = TextPost(title='Using MongoEngine', content='See the tutorial')\n >>> post1.tags = ['mongodb', 'mongoengine']\n >>> post1.save()\n\n # Create a link-based post\n >>> post2 = LinkPost(title='MongoEngine Docs', url='hmarr.com/mongoengine')\n >>> post2.tags = ['mongoengine', 'documentation']\n >>> post2.save()\n\n # Iterate over all posts using the BlogPost superclass\n >>> for post in BlogPost.objects:\n ... print('===', post.title, '===')\n ... if isinstance(post, TextPost):\n ... print(post.content)\n ... elif isinstance(post, LinkPost):\n ... print('Link:', post.url)\n ...\n\n # Count all blog posts and its subtypes\n >>> BlogPost.objects.count()\n 2\n >>> TextPost.objects.count()\n 1\n >>> LinkPost.objects.count()\n 1\n\n # Count tagged posts\n >>> BlogPost.objects(tags='mongoengine').count()\n 2\n >>> BlogPost.objects(tags='mongodb').count()\n 1\n\nTests\n=====\nTo run the test suite, ensure you are running a local instance of MongoDB on\nthe standard port and have ``pytest`` installed. Then, run ``pytest tests/``.\n\nTo run the test suite on every supported Python and PyMongo version, you can\nuse ``tox``. You'll need to make sure you have each supported Python version\ninstalled in your environment and then:\n\n.. code-block:: shell\n\n # Install tox\n $ python -m pip install tox\n # Run the test suites\n $ tox\n\nCommunity\n=========\n- `MongoEngine Users mailing list\n `_\n- `MongoEngine Developers mailing list\n `_\n\nContributing\n============\nWe welcome contributions! See the `Contribution guidelines `_\n\n\n","description_content_type":null,"docs_url":null,"download_url":"https://github.com/MongoEngine/mongoengine/tarball/master","downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":"http://mongoengine.org/","keywords":null,"license":"MIT","license_expression":null,"license_files":null,"maintainer":"Bastien Gerard","maintainer_email":"bast.gerard@gmail.com","name":"mongoengine","package_url":"https://pypi.org/project/mongoengine/","platform":"any","project_url":"https://pypi.org/project/mongoengine/","project_urls":{"Download":"https://github.com/MongoEngine/mongoengine/tarball/master","Homepage":"http://mongoengine.org/"},"provides_extra":["test"],"release_url":"https://pypi.org/project/mongoengine/0.29.1/","requires_dist":["pymongo<5.0,>=3.4","pytest; extra == \"test\"","pytest-cov; extra == \"test\"","coverage; extra == \"test\"","blinker; extra == \"test\"","Pillow>=7.0.0; extra == \"test\""],"requires_python":">=3.7","summary":"MongoEngine is a Python Object-Document Mapper for working with MongoDB.","version":"0.29.1","yanked":false,"yanked_reason":null}

Dependency	Optional
pymongo	false
blinker	true
coverage	true
Pillow	true
pytest	true
pytest-cov	true

Package search

mongoengine

project_urls

Dependencies

All package metadata

Releases