django-mongonaut

Info:	An introspective interface for Django and MongoDB.
Version:	0.2.23
Maintainer:	Devin Barry

Upgrades!

This is a fork of Jazzband django-mongonaut repo. This fork is tested to work against

• Python 3.5
• Django 1.10.5
• Mongoengine 0.11.0
• Pymongo 3.4.0
• Mongo DB v3.4.2

All testing done on Ubuntu 16.10. Additionally, this version also supports automatic detection of the module name for your Mongoengine models. No need to put them in models.py anymore. Call your module anything you like!

Differences / Goal

I am working to upgrade this package to support the latest Django, the latest Python 3 and the latest Mongoengine / PyMongo / MongoDB. As part of this goal I will (likely) drop support for earlier versions of Django/Python.

About

django-mongonaut is an introspective interface for working with MongoDB via mongoengine. Rather then attempt to staple this functionality into Django's Admin interface, django-mongonaut takes the approach of rolling a new framework from scratch.

By writing it from scratch I get to avoid trying to staple ORM functionality on top of MongoDB, a NoSQL key/value binary-tree store.

Features

• Automatic introspection of mongoengine documents.
• Ability to constrain who sees what and can do what.
• Full control to add, edit, and delete documents
• More awesome stuff! See https://django-mongonaut.readthedocs.io/en/latest/index.html#features

Installation

Made as easy as possible, setup is actually easier than django.contrib.admin. Furthermore, the only dependencies are mongoengine and pymongo. Eventually django-mongonaut will be able to support installations without mongoengine.

Get MongoDB:

Download the right version per http://www.mongodb.org/downloads

Get mongoengine (and pymongo):

pip install --upgrade mongoengine

Get the code:

pip install https://github.com/devinbarry/django-mongonaut/archive/master.zip

Install the dependency in your settings.py:

INSTALLED_APPS = (
...
'mongonaut',
...
)

You will need the following also set up:

• django.contrib.sessions
• django.contrib.messages

Note

No need for autodiscovery() with django-mongonaut!

Add the mongonaut urls.py file to your urlconf file:

urlpatterns = [
    ...
    url((r'^mongonaut/', include('mongonaut.urls')),
    ...
]

Configuration

django-mongonaut will let you duplicate much of what django.contrib.admin gives you, but in a way more suited for MongoDB. Still being implemented, but already works better than any other MongoDB solution for Django. A simple example:

# myapp/mongoadmin.py

# Import the MongoAdmin base class
from mongonaut.sites import MongoAdmin

# Import your custom models
from blog.models import Post

# Instantiate the MongoAdmin class
# Then attach the mongoadmin to your model
Post.mongoadmin = MongoAdmin()

• https://django-mongonaut.readthedocs.io/en/latest/api.html

Testing

To run the tests, create a virtual env and install the requirements from requirements.txt in the tests package.

Run tests from within the tests package as one of the below:

python runtests.py python runtests_1_7.py

Documentation

All the documentation for this project is hosted at https://django-mongonaut.readthedocs.io.

Dependencies

• mongoengine >=0.11.0
• pymongo >=3.4.0
• sphinx (optional - for documentation generation)