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

django mongoengine integration
https://github.com/mongoengine/django-mongoengine

Last synced: about 1 month ago
JSON representation

django mongoengine integration

• Host: GitHub
• URL: https://github.com/mongoengine/django-mongoengine
• Owner: MongoEngine
• License: other
• Created: 2012-05-15T09:28:40.000Z (about 13 years ago)
• Default Branch: master
• Last Pushed: 2025-03-06T23:05:11.000Z (4 months ago)
• Last Synced: 2025-03-31T21:44:41.335Z (3 months ago)
• Language: Python
• Homepage:
• Size: 1.15 MB
• Stars: 751
• Watchers: 71
• Forks: 204
• Open Issues: 23
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Authors: AUTHORS

Awesome Lists containing this project

README

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

Django-MongoEngine

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

|stand-with-ukraine|

|lifecycle| |gitter|

.. |lifecycle| image:: https://img.shields.io/osslifecycle/MongoEngine/django-mongoengine

   :alt: OSS Lifecycle

.. |gitter| image:: https://badges.gitter.im/gitterHQ/gitter.png

   :target: https://gitter.im/MongoEngine/django-mongoengine

   :alt: Gitter chat

.. |stand-with-ukraine| image:: https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner2-direct.svg

   :target: https://stand-with-ukraine.pp.ua

   :alt: Stand With Ukraine

THIS IS UNSTABLE PROJECT, IF YOU WANT TO USE IT - FIX WHAT YOU NEED

Right now we're targeting to get things working on Django 4.2;

WARNING: This project is not in good state, and is likely to break with django updates. Do not use it for any new projects.

Recommended way for new projects is `django-mongodb-backend `_.

Working / Django 4.2

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

* [ok] sessions

* [ok] models/fields, fields needs testing

* [ok] views

* [ok] auth

* [?] admin - partially working, some things broken

Current status

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

Many parts of projects rewritten/removed;

Instead of copying django code i try to subclass/reuse/even monkey-patch;

Everything listed above is working; admin - just base fuctions

like changelist/edit, not tested with every form type; need's more work.

Some code just plaholder to make things work;

`django/forms/document_options.py` - dirty hack absolutely required to

get thigs work with django. It replaces mongo _meta on model/class and

provide django-like interface.

It get's replaced after class creation via some metaclass magick.

Fields notes

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

* Project uses mongoengine style argument `required=False`, not django style `blank=False`,

  to be compatible with mongo-types.

  **All your fields are optional by default.**

TODO

----

* Sync some files/docs that removed from mongoengine: https://github.com/seglberg/mongoengine/commit/a34f4c1beb93f430c37da20c8fd96ce02a0f20c1?diff=unified

* Add docs for integrating: https://github.com/hmarr/django-debug-toolbar-mongo

* Take a look at django-mongotools: https://github.com/wpjunior/django-mongotools

Connecting

==========

In your **settings.py** file, add following lines::

    MONGODB_DATABASES = {

        "default": {

            "name": database_name,

            "host": database_host,

            "password": database_password,

            "username": database_user,

            "tz_aware": True, # if you using timezones in django (USE_TZ = True)

        },

    }

    INSTALLED_APPS += ["django_mongoengine"]

Documents

=========

Inhherit your documents from ``django_mongoengine.Document``,

and define fields using ``django_mongoengine.fields``.::

    from django_mongoengine import Document, EmbeddedDocument, fields

    class Comment(EmbeddedDocument):

        created_at = fields.DateTimeField(

            default=datetime.datetime.now, editable=False,

        )

        author = fields.StringField(verbose_name="Name", max_length=255)

        email  = fields.EmailField(verbose_name="Email")

        body = fields.StringField(verbose_name="Comment")

    class Post(Document):

        created_at = fields.DateTimeField(

            default=datetime.datetime.now, editable=False,

        )

        title = fields.StringField(max_length=255)

        slug = fields.StringField(max_length=255, primary_key=True)

        comments = fields.ListField(

            fields.EmbeddedDocumentField('Comment'), required=False,

        )

Sessions

========

Django allows the use of different backend stores for its sessions. MongoEngine

provides a MongoDB-based session backend for Django, which allows you to use

sessions in your Django application with just MongoDB. To enable the MongoEngine

session backend, ensure that your settings module has

``'django.contrib.sessions.middleware.SessionMiddleware'`` in the

``MIDDLEWARE_CLASSES`` field  and ``'django.contrib.sessions'`` in your

``INSTALLED_APPS``. From there, all you need to do is add the following line

into your settings module::

    SESSION_ENGINE = 'django_mongoengine.sessions'

    SESSION_SERIALIZER = 'django_mongoengine.sessions.BSONSerializer'

Django provides session cookie, which expires after

```SESSION_COOKIE_AGE``` seconds, but doesn't delete cookie at sessions

backend, so ``'mongoengine.django.sessions'`` supports  `mongodb TTL `_.

.. note:: ``SESSION_SERIALIZER`` is only necessary in Django>1.6 as the default

   serializer is based around JSON and doesn't know how to convert

   ``bson.objectid.ObjectId`` instances to strings.

How to run example app

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

.. code::

    uv sync --group dev

    uv pip install -r example/tumblelog/requirements.txt

    uv run python example/tumblelog/manage.py runserver

How to run tests

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

.. code::

    uv run python -m pytest