README.md

DjangoMongoAvatar

Mongo Avatar is a django like orm for interacting with MongoDB.

Installation

You can install django-mongo-avatar through pip sh $ pip install django-mongo-avatar

Settings

In your django settings file include 'mongo_avatar' in your INSTALLED_APPS.

Example:

INSTALLD_APPS = [
  ...,
  'mongo_avatar',
]

Furthermore you have to define atleast one mongo connection in your settings file.

Example:

MONGO_CONNECTIONS = {
  'default': {
    'NAME': 'yourdatabase',
    'USER': 'yourusername',
    'PASSWORD': 'yourpassword',
    'HOST': 'localhost',
    'PORT': '27017',
  },
}

Usage

MongoModelis a django like Model that refers to a collection in mongodb. In the model class you only need to define fields that have special attributes like unique=True or db_index=True otherwise you donot need to define any fields in the model.

Example:

from mongo_avatar.models import MongoModel, MongoField
from datetime import datetime

class Link(MongoModel):
    
    link = MongoField(unique=True)
    referrer = MongoField(default=[])
    priority = MongoField(db_index=True)
    is_active = MongoField(default=True)
    created = MongoField(db_index=True, default=datetime.now())
    modified = MongoField(db_index=True)
    
    class Meta:
        collection = 'some_other_collection'
        sync = True

Syncing Models:

Through the "mongosync" management command you can sync the models.

Example:

$ python manage.py mongosync

Querying Models

Querying works the almost the same as django

Example:

>>> from app.models import Link
>>> from datetime import datetime
>>> link = Link.objects.create(link='http://github.com', is_active=True, created=datetime.now())
>>> links = Link.objects.filter(link__contains='github.com', created__lte=datetime.now())
>>> links[0].is_active = False
>>> link[0].save()