{
"info": {
"author": "CDH @ Princeton",
"author_email": "digitalhumanities@princeton.edu",
"bugtrack_url": null,
"classifiers": [
"Development Status :: 3 - Alpha",
"Environment :: Web Environment",
"Framework :: Django",
"Framework :: Django :: 1.10",
"Framework :: Django :: 1.11",
"Framework :: Django :: 1.8",
"Framework :: Django :: 1.9",
"Intended Audience :: Developers",
"License :: OSI Approved :: Apache Software License",
"Operating System :: OS Independent",
"Programming Language :: Python",
"Programming Language :: Python :: 2",
"Programming Language :: Python :: 2.7",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.5"
],
"description": ".. _README:\n\nDjango-Annotator-Store\n======================\n\n.. sphinx-start-marker-do-not-remove\n\n.. image:: https://travis-ci.org/Princeton-CDH/django-annotator-store.svg?branch=master\n :target: https://travis-ci.org/Princeton-CDH/django-annotator-store\n :alt: Build Status\n.. image:: https://codecov.io/gh/Princeton-CDH/django-annotator-store/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/Princeton-CDH/django-annotator-store\n :alt: Code Coverage\n.. image:: https://landscape.io/github/Princeton-CDH/django-annotator-store/master/landscape.svg?style=flat\n :target: https://landscape.io/github/Princeton-CDH/django-annotator-store/master\n :alt: Code Health\n.. image:: https://requires.io/github/Princeton-CDH/django-annotator-store/requirements.svg?branch=master\n :target: https://requires.io/github/Princeton-CDH/django-annotator-store/requirements/?branch=master\n :alt: Requirements Status\n.. image:: https://readthedocs.org/projects/django-annotator-store/badge/?version=stable\n :target: http://django-annotator-store.readthedocs.io/en/latest/?badge=stable\n :alt: Documentation Status\n\n**annotator_store** is a `Django `_\napplication meant for use within a Django project as an\n`annotator.js `_ 2.x annotation\nstore backend, and implements the `Annotator Storage API `_.\n\n**annotator_store** was originally develop as a component of\n`Readux `_.\n\n\nLicense\n^^^^^^^\n\nThis software is distributed under the Apache 2.0 License.\n\n\nInstallation\n------------\n\nUse pip to install::\n\n pip install\n\nYou can also install from GitHub. Use branch or tag name, e.g.\n``@develop`` or ``@1.0``, to install a specific tagged release or branch::\n\n pip install git+https://github.com/Princeton-CDH/django-annotator-store.git@develop#egg=annotator_store\n\n\nConfiguration\n-------------\n\nAdd `annotator_store` to installed applications and make sure that other\nrequired components are enabled::\n\n INSTALLED_APPS = (\n ...\n 'django.contrib.auth',\n 'django.contrib.admin',\n 'django.contrib.contenttypes',\n 'django.contrib.sessions',\n 'django.contrib.sites',\n 'annotator_store',\n ...\n )\n\n\nInclude the annotation storage API urls at the desired base url with the\nnamespace::\n\n from annotator_store import views as annotator_views\n\n urlpatterns = [\n # annotations\n url(r'^annotations/api/', include('annotator_store.urls', namespace='annotation-api')),\n # annotatorjs doesn't handle trailing slash in api prefix url\n url(r'^annotations/api', annotator_views.AnnotationIndex.as_view(), name='annotation-api-prefix'),\n ]\n\nRun migrations to create annotation database tables::\n\n python manage.py migrate\n\n.. Note::\n\n If you want per-object permissions on individual annotations (rather than\n the standard django type-based permissions), you must also install\n `django-guardian` and include `guardian` in your\n **INSTALLED_APPS**. Per-object permissions must be turned on in Django\n settings by setting **ANNOTATION_OBJECT_PERMISSIONS** to True.\n\nCustom Annotation Model\n^^^^^^^^^^^^^^^^^^^^^^^\n\nThis module is designed to allow the use of a custom Annotation model, in order\nto add functionality or relationships to other models within an application.\nTo take advantage of this feature, you should extend the abstract model\n`annotator_store.models.BaseAnnotation` and configure your model in\nDjango setings, e.g.::\n\n ANNOTATOR_ANNOTATION_MODEL = 'myapp.LocalAnnotation'\n\nIf you want per-object permissions on your annotation model, you should\nextend `annotator_store.models.AnnotationWithPermissions` rather than\nthe base annotation class.\n\n.. NOTE::\n\n Per-object permissions require that a `permissions plugin`_ be\n included when you initialize your annotator.js Annotator object.\n That code is currently available as a plugin in the `Readux codebase`_\n\n.. _permissions plugin: https://github.com/ecds/readux/blob/master/sitemedia/js/annotator/annotator.permissions.js\n.. _Readux codebase: https://github.com/ecds/readux\n\nDevelopment instructions\n------------------------\n\nThis git repository uses `git flow`_ branching conventions.\n\n.. _git flow: https://github.com/nvie/gitflow\n\nInitial setup and installation:\n\n- recommended: create and activate a python virtualenv::\n\n virtualenv annotator-store\n source annotator-store/bin/activate\n\n- pip install the package with its python dependencies::\n\n pip install -e .\n\n\nUnit Testing\n^^^^^^^^^^^^\n\nUnit tests are run with `py.test`_ but use\nDjango test classes for convenience and compatibility with django test suites.\nRunning the tests requires a minimal settings file for Django required\nconfigurations.\n\n.. _py.test: http://doc.pytest.org\n\n- Copy sample test settings and add a **SECRET_KEY**::\n\n cp ci/testsettings.py testsettings.py\n\n- To run the tests, either use the configured setup.py test command::\n\n python setup.py test\n\n- Or install test requirements and use py.test directly::\n\n pip install -e '.[test]'\n py.test\n\n\nSphinx Documentation\n^^^^^^^^^^^^^^^^^^^^\n\n- To work with the sphinx documentation, install `sphinx` directly via pip\n or via::\n\n pip install -e '.[docs]'\n\n- Documentation can be built in the `docs` directory using::\n\n make html\n\n\n\n",
"description_content_type": null,
"docs_url": null,
"download_url": "",
"downloads": {
"last_day": -1,
"last_month": -1,
"last_week": -1
},
"home_page": "https://github.com/Princeton-CDH/django-annotator-store",
"keywords": "",
"license": "Apache License, Version 2.0",
"maintainer": "",
"maintainer_email": "",
"name": "annotator_store",
"package_url": "https://pypi.org/project/annotator_store/",
"platform": "",
"project_url": "https://pypi.org/project/annotator_store/",
"project_urls": {
"Homepage": "https://github.com/Princeton-CDH/django-annotator-store"
},
"release_url": "https://pypi.org/project/annotator_store/0.6.0/",
"requires_dist": null,
"requires_python": "",
"summary": "Django application to act as an annotator.js 2.x annotator-store backend",
"version": "0.6.0"
},
"last_serial": 5820273,
"releases": {
"0.6.0": [
{
"comment_text": "",
"digests": {
"md5": "54405eef6be9b9f0e862cf5ea69941ef",
"sha256": "07809d58679924bae3f2096de9719e5b4594c9c58cfab639959d80098383d67b"
},
"downloads": -1,
"filename": "annotator_store-0.6.0-py2-none-any.whl",
"has_sig": false,
"md5_digest": "54405eef6be9b9f0e862cf5ea69941ef",
"packagetype": "bdist_wheel",
"python_version": "2.7",
"requires_python": null,
"size": 798323,
"upload_time": "2017-08-01T14:12:41",
"url": "https://files.pythonhosted.org/packages/d2/c7/51a49633048c98920db8d8a40522d1a0d596256633b9b44433574a9193b3/annotator_store-0.6.0-py2-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "30f489e938d029d52b4171226c87750f",
"sha256": "6bc65e8be3e6816ec7743d1d3819be5b5c9da7e7369fa57b19ce58e5b6f3ce89"
},
"downloads": -1,
"filename": "annotator_store-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "30f489e938d029d52b4171226c87750f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 790273,
"upload_time": "2017-08-01T14:12:39",
"url": "https://files.pythonhosted.org/packages/b1/7e/38d233307dc8ece0b91aeea54004070e91cfe974c2e36c69525f80f3b3e6/annotator_store-0.6.0.tar.gz"
}
]
},
"urls": [
{
"comment_text": "",
"digests": {
"md5": "54405eef6be9b9f0e862cf5ea69941ef",
"sha256": "07809d58679924bae3f2096de9719e5b4594c9c58cfab639959d80098383d67b"
},
"downloads": -1,
"filename": "annotator_store-0.6.0-py2-none-any.whl",
"has_sig": false,
"md5_digest": "54405eef6be9b9f0e862cf5ea69941ef",
"packagetype": "bdist_wheel",
"python_version": "2.7",
"requires_python": null,
"size": 798323,
"upload_time": "2017-08-01T14:12:41",
"url": "https://files.pythonhosted.org/packages/d2/c7/51a49633048c98920db8d8a40522d1a0d596256633b9b44433574a9193b3/annotator_store-0.6.0-py2-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "30f489e938d029d52b4171226c87750f",
"sha256": "6bc65e8be3e6816ec7743d1d3819be5b5c9da7e7369fa57b19ce58e5b6f3ce89"
},
"downloads": -1,
"filename": "annotator_store-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "30f489e938d029d52b4171226c87750f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 790273,
"upload_time": "2017-08-01T14:12:39",
"url": "https://files.pythonhosted.org/packages/b1/7e/38d233307dc8ece0b91aeea54004070e91cfe974c2e36c69525f80f3b3e6/annotator_store-0.6.0.tar.gz"
}
]
}