Metadata-Version: 1.1
Name: django-moderator
Version: 0.0.1
Summary: Django Bayesian inference based comment moderation app.
Home-page: http://github.com/praekelt/django-moderator
Author: Praekelt Foundation
Author-email: dev@praekelt.com
License: BSD
Description: Django Moderator
        ================
        **Django Bayesian inference based comment moderation app.**
        
        .. contents:: Contents
            :depth: 5
        
        ``django-moderator`` integrates Django's comments framework with SpamBayes_ to automatically classify comments into three categories, *ham*, *spam* or *unknown*, based on previous training (see Paul Graham's `A Plan for Spam <http://www.paulgraham.com/spam.html>`_ for some background).
        
        Comments classified as *unknown* have to be manually classified as either *spam* or *ham* via admin, thereby training the system to automatically classify similarly worded comments in future.
        
        Comments classified as *spam* will have their ``is_removed`` field set to ``True`` and as such it will no longer be visible in comment listings.
        
        Comments classified as *ham* will remain unchanged and as such will be visible in comment listings.
        
        ``django-moderator`` also implements a user friendly admin interface for efficiently moderating comments.
        
        
        Installation
        ------------
        
        #. Install or add ``django-moderator`` to your Python path.
        
        #. Add ``moderator`` to your ``INSTALLED_APPS`` setting.
        
        #. Add a ``MODERATOR`` setting to your project's ``settings.py`` file. This setting specifies what classifier storage backend to use (see below) and also classification thresholds::
           
            MODERATOR = {
                'CLASSIFIER': 'moderator.storage.DjangoClassifier',
                'HAM_CUTOFF': 0.3,
                'SPAM_CUTOFF': 0.7,
            }
        
           Specifically a ``HAM_CUTOFF`` value of ``0.3`` as in this example specifies that any comment scoring less than ``0.3`` during Bayesian inference will be classified as *ham*.  A ``SPAM_CUTOFF`` value of ``0.7`` as in this example specifies that any comment scoring more than ``0.7`` during Bayesian inference will be classified as *spam*. Anything between ``0.3`` and ``0.7`` will be classified as *unsure*, awaiting manual user classification. ``HAM_CUTOFF`` and ``SPAM_CUTOFF`` can be ommited in which case the default cuttofs are ``0.3`` and ``0.7`` respectively.
        
        Classifier Storage Backends
        ---------------------------
        ``django-moderator`` includes two SpamBayes_ storage backends, ``moderator.storage.DjangoClassifier`` and ``moderator.storage.RedisClassifier`` respectively. 
        
        .. note::
            ``moderator.storage.RedisClassifier`` is recommended for production environments as it should be much more performant than ``moderator.storage.DjangoClassifier``.
        
        To use ``moderator.storage.RedisClassifier`` as your classifier storage backend specify it in your ``MODERATOR`` setting, i.e.::
        
            MODERATOR = {
                'CLASSIFIER': 'moderator.storage.RedisClassifier',
                'CLASSIFIER_CONFIG': {
                    'host': 'localhost',
                    'port': 6379,
                    'db': 0,
                    'password': None,
                },
                'HAM_CUTOFF': 0.3,
                'SPAM_CUTOFF': 0.7,
            }
        
        You can aslo create your own backends, in which case take note that the content of ``CLASSIFIER_CONFIG`` will be passed as keyword agruments to your backend's ``__init__`` method.
        
        Usage
        -----
        
        Once correctly configured you'll use the ``classifycomments`` management command to automatically classify comments as either *ham*, *spam* or *unsure* based on previous training, i.e.::
        
            $ ./manage.py classifycomments
        
        *Unsure* comments can be manually classified as either *ham* or *spam* via the `Classified comments <http://localhost:8000/admin/moderator/classifiedcomment/>`_ page in admin. 
        
        
        .. _SpamBayes: http://spambayes.sourceforge.net/
        
        Authors
        =======
        
        Praekelt Foundation
        -------------------
        * Shaun Sephton
        
        Changelog
        =========
        
        0.0.1 (2012-05-23)
        ------------------
        #. Initial release
           
        
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: License :: OSI Approved :: BSD License
Classifier: Development Status :: 4 - Beta
Classifier: Operating System :: OS Independent
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
