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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
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
Algorithm | Hash digest | |
---|---|---|
SHA256 |
3165f8ae897ce7aee77d85056205af71f79406359e02ef8c654d6c463cbb5e8e
|
|
MD5 |
141e48b18e120bf290924a025417ee14
|
|
BLAKE2b-256 |
4b67af91d17a703733d7470056a6ae8f73483f1430ed2ef07f32d22257e496b1
|
Provenance
The following attestation bundles were made for django_annotator-2.2.10.tar.gz
:
Publisher:
bump-release.yml
on PsypherPunk/django-annotator
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1
-
Predicate type:
https://docs.pypi.org/attestations/publish/v1
-
Subject name:
django_annotator-2.2.10.tar.gz
-
Subject digest:
3165f8ae897ce7aee77d85056205af71f79406359e02ef8c654d6c463cbb5e8e
- Sigstore transparency entry: 243005844
- Sigstore integration time:
-
Permalink:
PsypherPunk/django-annotator@92b35016dc924d8e918fed08dfe77a4d05d20acb
-
Branch / Tag:
refs/heads/main
- Owner: https://github.com/PsypherPunk
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com
-
Runner Environment:
github-hosted
-
Publication workflow:
bump-release.yml@92b35016dc924d8e918fed08dfe77a4d05d20acb
-
Trigger Event:
push
-
Statement type:
File details
Details for the file django_annotator-2.2.10-py3-none-any.whl
.
File metadata
- Download URL: django_annotator-2.2.10-py3-none-any.whl
- Upload date:
- Size: 91.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
7bf222249777c6f788dd4ee4fb2493ad29b741ed0653657c02909c9e1986a5ba
|
|
MD5 |
6adc2abcf7bf3d03ce1af9af19c91319
|
|
BLAKE2b-256 |
cec3a77bb7ca0348ac9c92a8ec1b3cd1cd24bccb9017a71cd656cd0b3ec5b241
|
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
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1
-
Predicate type:
https://docs.pypi.org/attestations/publish/v1
-
Subject name:
django_annotator-2.2.10-py3-none-any.whl
-
Subject digest:
7bf222249777c6f788dd4ee4fb2493ad29b741ed0653657c02909c9e1986a5ba
- Sigstore transparency entry: 243005846
- Sigstore integration time:
-
Permalink:
PsypherPunk/django-annotator@92b35016dc924d8e918fed08dfe77a4d05d20acb
-
Branch / Tag:
refs/heads/main
- Owner: https://github.com/PsypherPunk
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com
-
Runner Environment:
github-hosted
-
Publication workflow:
bump-release.yml@92b35016dc924d8e918fed08dfe77a4d05d20acb
-
Trigger Event:
push
-
Statement type: