Metadata-Version: 1.0
Name: django-monitor
Version: 0.2a
Summary: Django app to moderate model objects
Home-page: http://bitbucket.org/rajeesh/django-monitor
Author: Rajeesh Nair
Author-email: rajeeshrnair@gmail.com
License: BSD
Description: ===============
        Django-monitor
        ===============
        
        ---------------------------------------------------------
        A django-app to enable moderation of model objects
        ---------------------------------------------------------
        
        About
        =====
        
        Moderation seems to be some job each one want to do in their own way.
        Django-monitor is a django-app to moderate model objects. It was started as a
        clone of `django-gatekeeper` project but to meet certain business requirements.
        Read about those requirements it meet in the ``Features`` section.
        
        Here, the moderation process is well integrated with django-admin. That is, all
        moderation actvities are performed from within the changelist page itself.
        
        The detailed documentation is available at the following locations:
        
        * http://django-monitor.readthedocs.org/
        
        * http://packages.python.org/django-monitor
        
        * Within the ``docs/source/`` directory inside the source path.
        
        Installation
        ============
        
        #. Directly from the python package index: ::
        
           $ pip install django_monitor
        
        #. Or Download & install as instructed below:
        
           * Get the latest version from the bitbucket repo:
             http://bitbucket.org/rajeesh/django-monitor.
        
           * Install using the setuptools as given below: ::
        
              $ python setup.py install
        
           * If setuptools is not installed, you may copy the ``django_monitor``
             directory to somewhere in your python path.
        
        #. Add 'django_monitor' to your project's ``settings.INSTALLED_APPS``.
        
        Features
        =========
        
        Model-specific permission
        --------------------------
        Each moderated model will have an associated moderate permission. To approve
        or challenge any object created for a particular model, users need to have
        the corresponding permission.
        
        Auto-moderation
        ----------------
        Any object created by a user with add permission will have an ``In Pending``
        status. If the user has got moderate permission also, the object created will
        automatically get approved (status becomes ``Approved``).
        
        Moderation from within admin changelist
        ----------------------------------------
        The changelist of a moderated model displays the current moderation status of
        all objects. Also, you can filter the objects by their moderation status. Three
        actions are available for moderation. To moderate, user just need to select the
        objects, choose appropriate action and press ``Go``.
        
        Related moderation
        -------------------
        When a manager moderates some model objects, there may be some other related
        model objects which also can get moderated along with the original ones. The
        developer can specify such related models to be moderated during registration.
        
        Data protection
        ----------------
        The developer can prevent admin-users from changing values of selected fields
        of approved objects. Deleting approved objects also can be prevented if your
        client's business requires that.
        
        Basic usage (developers)
        ========================
        
        * Register the model for moderation using ``monitor.nq``.
        
          **Example**: ::
        
            import django_monitor
            from django.db import models
            class MyModel(models.Model):
                pass
        
            django_monitor.nq(MyModel)
        
        * Inherit ``MonitorAdmin``, not ``ModelAdmin`` for moderated models. ::
        
            # in your admin.py
            from django_monitor.admin import MonitorAdmin
            class MyAdmin(MonitorAdmin):
                pass
        
            from django.contrib import admin
            admin.site.register(MyModel, MyAdmin)
        
        More details given at the documentation locations mentioned above.
        
        
Keywords: django moderation models
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Framework :: Django
