Skip to main content

Implementation of annotatorjs's Storage/Search API.

Project description

django-annotator

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:

poetry install
poetry run python3 ./demo.py

This will run the tests, after which a demo. page will be available at /demo.

Installation

The package can be installed via poetry:

poetry add django-annotator

Following installation it can be added to any Django project by updating the INSTALLED_APPS, along with its dependencies:

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

As per the integration documentation for django-filter, DEFAULT_FILTER_BACKENDS must also be added to settings.py:

REST_FRAMEWORK = {
    "DEFAULT_FILTER_BACKENDS": (
        "django_filters.rest_framework.DjangoFilterBackend",
    ),
},

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

poetry run python3 ./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 django-cors-headers.

Project details


Download files

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

Source Distribution

django_annotator-2.2.10.tar.gz (90.3 kB view details)

Uploaded Source

Built Distribution

django_annotator-2.2.10-py3-none-any.whl (91.9 kB view details)

Uploaded Python 3

File details

Details for the file django_annotator-2.2.10.tar.gz.

File metadata

  • Download URL: django_annotator-2.2.10.tar.gz
  • Upload date:
  • Size: 90.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for django_annotator-2.2.10.tar.gz
Algorithm Hash digest
SHA256 3165f8ae897ce7aee77d85056205af71f79406359e02ef8c654d6c463cbb5e8e
MD5 141e48b18e120bf290924a025417ee14
BLAKE2b-256 4b67af91d17a703733d7470056a6ae8f73483f1430ed2ef07f32d22257e496b1

See more details on using hashes here.

Provenance

The following attestation bundles were made for django_annotator-2.2.10.tar.gz:

Publisher: bump-release.yml on PsypherPunk/django-annotator

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file django_annotator-2.2.10-py3-none-any.whl.

File metadata

File hashes

Hashes for django_annotator-2.2.10-py3-none-any.whl
Algorithm Hash digest
SHA256 7bf222249777c6f788dd4ee4fb2493ad29b741ed0653657c02909c9e1986a5ba
MD5 6adc2abcf7bf3d03ce1af9af19c91319
BLAKE2b-256 cec3a77bb7ca0348ac9c92a8ec1b3cd1cd24bccb9017a71cd656cd0b3ec5b241

See more details on using hashes here.

Provenance

The following attestation bundles were made for django_annotator-2.2.10-py3-none-any.whl:

Publisher: bump-release.yml on PsypherPunk/django-annotator

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page