Metadata-Version: 2.0
Name: django-textclassifier
Version: 1.0
Summary: Django text classifier validation
Home-page: http://github.com/agjohnson/django-textclassifier/
Author: Anthony Johnson
Author-email: aj@ohess.org
License: MIT License
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Environment :: Web Environment
Requires-Dist: setuptools
Requires-Dist: django
Requires-Dist: nltk
Requires-Dist: textblob

django-textclassifier
=====================

Validators and some utility functions for validating fields using a naive
bayesian text classifier, provided by `TextBlob`_

.. _TextBlob: http://textblob.readthedocs.org/

Usage
-----

Add this application to your Django project::

    INSTALLED_APPS = [
        ...
        'textclassifier',
        ...
    ]

You'll also need to set the data file source in your settings::

    TEXTCLASSIFIER_DATA_FILE = '/tmp/test.json'

.. note::
    The current implementation is very basic, only allowing for one data file.
    This will eventually be more configurable, but is just a POC for now.

Data file
---------

The data file needs to be written by hand for now as well. It is read using the
`TextBlob JSON formatter`_

.. _`TextBlob JSON formatter`: http://textblob.readthedocs.org/en/dev/api_reference.html#textblob.formats.JSON

The file should use the labels ``spam`` and ``valid``::

    [
        {"text": "This is spam", "label": "spam"},
        {"text": "This is valid", "label": "valid"}
    ]


