Metadata-Version: 1.1
Name: django-annotator
Version: 1.0.1
Summary: Implementation of annotatorjs's Storage/Search API.
Home-page: https://github.com/PsypherPunk/django-annotator
Author: PsypherPunk
Author-email: psypherpunk@gmail.com
License: UNKNOWN
Description: ================
        django-annotator
        ================
        
        Django implementation of `annotatorjs Storage <http://annotatorjs.org/>`_.
        
        
        Implements most of the methods as per the `Core Storage/Search API <http://docs.annotatorjs.org/en/v1.2.x/storage.html#core-storage-api>`_ documentation (``root``, ``index``, ``create``, ``read``, ``update``, ``delete`` and ``search``).
        
        To see a working demo:
        
        .. code:: bash
        
            virtualenv annotatorjs
            cd annotatorjs
            source bin/activate
            git clone https://github.com/PsypherPunk/django-annotator.git
            cd django-annotator
            ./demo.py
        
        This will run the tests, after which a demo. page will be available at ``/demo``.
        
        
        Installation
        ============
        
        The package can be installed via ``pip``:
        
        .. code::
        
            pip install django-annotator
        
        Following installation it can be added to any Django project by updating the ``INSTALLED_APPS``:
        
        .. code::
        
            INSTALLED_APPS = (
                ...
                "annotator",
                ...
            )
        
        Then run ``migrate`` to include the new tables from ``django-annotator``:
        
        
        .. code::
        
            ./manage.py migrate
        
        Annotator
        ---------
        
        The package relies on *Annotator* being installed in your project—see the `documentation <http://docs.annotatorjs.org/en/v1.2.x/getting-started.html>`_ for details of its inclusion.
        
        Settings
        --------
        
        As per Annotator's documentation, the `root <http://docs.annotatorjs.org/en/v1.2.x/storage.html#root>`_ endpoint will return information in the format:
        
        .. code::
        
            {
                "name": "django-annotator-store",
                "version": "1.0.0"
            }
        
        The ``name`` returned can be configured by setting ``ANNOTATOR_NAME`` in your ``settings`` (defaulting to the above).
        
        django-cors-headers
        +++++++++++++++++++
        
        If you have any issues with *Cross-origin resource sharing (CORS)*, consider installing the ``django-cors-headers`` `package <https://github.com/ottoyiu/django-cors-headers>`_.
        
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
