Flask-MongoEngine2

Flask-MongoEngine2 is a Flask extension that provides integration with MongoEngine and FlaskDebugToolbar.

Installation

By default, Flask-MongoEngine2 will install integration only between Flask and MongoEngine. Integration with FlaskDebugToolbar are optional and should be selected as extra option, if required. This is done by users request, to limit amount of external dependencies in different production setup environments.

All methods end extras described below are compatible between each other and can be used together.

Installation with MongoEngine only support

# For Flask >= 2.3.0
pip install flask-mongoengine2

Installation with Flask Debug Toolbar support

Flask-mongoengine provide beautiful extension to FlaskDebugToolbar allowing to monitor all database requests. To use this extension FlaskDebugToolbar itself required. If you need to install flask-mongoengine2 with related support, use:

# With FlaskDebugToolbar dependencies
pip install flask-mongoengine2[toolbar]

Flask configuration

Flask-mongoengine does not provide any configuration defaults. User is responsible for setting up correct database settings, to exclude any possible misconfiguration and data corruption.

There are several options to set connection. Please note, that all except recommended are deprecated and may be removed in future versions, to lower code base complexity and bugs. If you use any deprecated connection settings approach, you should update your application configuration.

Please refer to [complete connection settings description] for more info.

Usage and API documentation

Full project documentation available on read the docs.

Contributing and testing

We are welcome for contributors and testers! Check Contribution guidelines.

License

Flask-MongoEngine2 is distributed under BSD 3-Clause License.