Skip to main content

Implementation of annotatorjs's Storage/Search API.

Project description

https://travis-ci.com/PsypherPunk/django-annotator.png?branch=master

2.1.0

Django implementation of annotatorjs Storage.

Implements most of the methods as per the Core Storage/Search API documentation (root, index, create, read, update, delete and search).

To see a working demo:

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:

pip install django-annotator

Following installation it can be added to any Django project by updating the INSTALLED_APPS:

INSTALLED_APPS = (
    ...
    "annotator",
    ...
)

Then run migrate to include the new tables from django-annotator:

./manage.py migrate

Annotator

The package relies on Annotator being installed in your project—see the documentation for details of its inclusion.

Settings

As per Annotator’s documentation, the root endpoint will return information in the format:

{
    "name": "django-annotator-store",
    "version": "2.1.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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for django-annotator, version 2.1.0
Filename, size File type Python version Upload date Hashes
Filename, size django-annotator-2.1.0.tar.gz (10.5 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page