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 : Bastien Gerard (http://github.com/bagerard)
About
MongoEngine is a Python Object-Document Mapper for working with MongoDB. Documentation is available at https://mongoengine-odm.readthedocs.io - there is currently a tutorial, a user guide, and an API reference.
Supported MongoDB Versions
MongoEngine is currently tested against MongoDB v3.6, v4.0, v4.4, v5.0, v6.0, v7.0 and v8.0. Future versions should be supported as well, but aren't actively tested at the moment. Make sure to open an issue or submit a pull request if you experience any problems with a more recent MongoDB versions.
Installation
We recommend the use of virtualenv and of
pip. You can then use
python -m pip install -U mongoengine. You may also have
setuptools and
thus you can use easy_install -U mongoengine. Another option is
pipenv. You can then use
pipenv install mongoengine to both create the virtual environment and
install the package. Otherwise, you can download the source from
GitHub and run
python setup.py install.
The support for Python2 was dropped with MongoEngine 0.20.0
Dependencies
All of the dependencies can easily be installed via python -m pip. At the very least, you'll need these two packages to use MongoEngine:
- pymongo>=3.12
If you utilize a DateTimeField, you might also use a more flexible
date parser:
- dateutil>=2.1.0
If you need to use an ImageField or ImageGridFsProxy:
- Pillow>=7.0.0
If you need to use signals:
- blinker>=1.3
Examples
Some simple examples of what MongoEngine code looks like:
Tests
To run the test suite, ensure you are running a local instance of
MongoDB on the standard port and have pytest installed. Then, run
pytest tests/.
To run the test suite on every supported Python and PyMongo version, you
can use tox. You'll need to make sure you have each supported Python
version installed in your environment and then:
# Install tox
$ python -m pip install tox
# Run the test suites
$ tox
Community
Contributing
We welcome contributions! See the Contribution guidelines