Skip to content

Latest commit

 

History

History
90 lines (58 loc) · 2.6 KB

README.rst

File metadata and controls

90 lines (58 loc) · 2.6 KB

django-mongonaut

Info:An introspective interface for Django and MongoDB.
Version: 0.2.12
Author: Daniel Greenfeld (http://pydanny.com)

About

Extracted from http://consumernotebook.com, 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

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 mongoengine==0.6.2

Get the code:

pip install django-mongonaut==0.2.12

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!

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()

Documentation

All the documentation for this project is hosted at http://django-mongonaut.rtfd.org.

Support this project!

Sign up for an account on http://consumernotebook.com. It's free and always will be!

Dependencies

  • mongoengine 0.5.2
  • pymongo 2.1.1 (comes with mongoengine)
  • sphinx (optional - for documentation generation)