https://github.com/mongoengine/eve-mongoengine

An Eve extension for MongoEngine ODM support
https://github.com/mongoengine/eve-mongoengine

Last synced: 7 months ago
JSON representation

An Eve extension for MongoEngine ODM support

• Host: GitHub
• URL: https://github.com/mongoengine/eve-mongoengine
• Owner: MongoEngine
• License: other
• Created: 2013-10-23T15:00:02.000Z (about 12 years ago)
• Default Branch: develop
• Last Pushed: 2022-02-21T03:08:11.000Z (almost 4 years ago)
• Last Synced: 2025-05-03T19:03:34.021Z (8 months ago)
• Language: Python
• Homepage:
• Size: 770 KB
• Stars: 40
• Watchers: 7
• Forks: 28
• Open Issues: 10
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
===============

Eve-MongoEngine

===============

:Info: Eve-MongoEngine provides MongoEngine integration with `Eve `_.

:Repository: https://github.com/hellerstanislav/eve-mongoengine

:Author: Stanislav Heller (https://github.com/hellerstanislav)

:Maintainer: Matthew Ellison (https://github.com/seglberg)

----

.. |travis-master| image:: https://api.travis-ci.org/seglberg/eve-mongoengine.png?branch=master

  :target: https://travis-ci.org/seglberg/eve-mongoengine

.. |travis-develop| image:: https://api.travis-ci.org/seglberg/eve-mongoengine.png?branch=develop

  :target: https://travis-ci.org/seglberg/eve-mongoengine/branches

.. |landscape-master| image:: https://landscape.io/github/seglberg/eve-mongoengine/master/landscape.svg?style=flat

  :target: https://landscape.io/github/seglberg/eve-mongoengine/master

  :alt: Code Health

.. |landscape-develop| image:: https://landscape.io/github/seglberg/eve-mongoengine/develop/landscape.svg?style=flat

  :target: https://landscape.io/github/seglberg/eve-mongoengine/develop

  :alt: Code Health

.. list-table::

  :widths: 50 50

  :header-rows: 1

  * - Production

    - Development

  * - |travis-master|

    - |travis-develop|

  * - |landscape-master|

    - |landscape-develop|

**THE DEVELOP BRANCH CONTAINS POST-LEGACY WORK**

See the `legacy` tag for the last legacy release (0.0.10).

Do not use `develop` in production code. Instead, the `master` branch always points to the latest production release, and should be used instead.

About

=====

Eve-MongoEngine is an `Eve`_ extension, which enables MongoEngine ODM  model to be used as an Eve / `Cerberus `_ schema. This eliminates the need to re-write API schemas in the `Cerberus`_ format by using MongoEngine models to automatically export a corresponding Cerberus schema.

Additional documentation and examples can be found on `Read the Docs `_.

Installation

============

If you have ``pip`` installed you can use ``pip install eve-mongoengine``. Otherwise, you can download the

source from `GitHub `_ and run ``python

setup.py install``.

Dependencies

============

- Python 2.7+ or Python 3.3+

- eve>=0.5.3

- mongoengine>=0.8.7,<=0.9

- blinker

Optional Dependencies

---------------------

- *None*

Legacy Release

==============

The legacy version of the extension can be found under the 'legacy' tag. 

The legacy version of the extension was released under the BSD-2 license and originally authored by Stanislav Heller. See AUTHORS for more information about the legacy authors and ownership.