Permalink
Find file Copy path
51f314e Dec 2, 2014
4 contributors

Users who have contributed to this file

@hmarr @rozza @mahmoudhossam @3lnc
85 lines (59 sloc) 2.11 KB

MongoEngine User Documentation

MongoEngine is an Object-Document Mapper, written in Python for working with MongoDB. To install it, simply run

$ pip install -U mongoengine
:doc:`tutorial`
A quick tutorial building a tumblelog to get you up and running with MongoEngine.
:doc:`guide/index`
The Full guide to MongoEngine --- from modeling documents to storing files, from querying for data to firing signals and everything between.
:doc:`apireference`
The complete API documentation --- the innards of documents, querysets and fields.
:doc:`upgrade`
How to upgrade MongoEngine.
:doc:`django`
Using MongoEngine and Django

Community

To get help with using MongoEngine, use the MongoEngine Users mailing list or the ever popular stackoverflow.

Contributing

Yes please! We are always looking for contributions, additions and improvements.

The source is available on GitHub and contributions are always encouraged. Contributions can be as simple as minor tweaks to this documentation, the website or the core.

To contribute, fork the project on GitHub and send a pull request.

Changes

See the :doc:`changelog` for a full list of changes to MongoEngine and :doc:`upgrade` for upgrade information.

Note

Always read and test the upgrade documentation before putting updates live in production ;)

Offline Reading

Download the docs in pdf or epub formats for offline reading.

.. toctree::
    :maxdepth: 1
    :numbered:
    :hidden:

    tutorial
    guide/index
    apireference
    changelog
    upgrade
    django

Indices and tables