{"id":16842457,"url":"https://github.com/psypherpunk/django-annotator","last_synced_at":"2025-03-22T05:31:08.262Z","repository":{"id":57418899,"uuid":"82669722","full_name":"PsypherPunk/django-annotator","owner":"PsypherPunk","description":"Django implementation of annotatorjs's Storage/Search API.","archived":false,"fork":false,"pushed_at":"2025-03-10T09:56:27.000Z","size":195,"stargazers_count":8,"open_issues_count":0,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-10T10:37:26.853Z","etag":null,"topics":["annotator","django"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PsypherPunk.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-02-21T10:58:59.000Z","updated_at":"2025-03-10T09:56:31.000Z","dependencies_parsed_at":"2024-10-28T12:25:34.537Z","dependency_job_id":"6a5ad9de-0a55-465d-9ca6-44eed4e87f24","html_url":"https://github.com/PsypherPunk/django-annotator","commit_stats":{"total_commits":20,"total_committers":2,"mean_commits":10.0,"dds":0.25,"last_synced_commit":"0d5e1a34af41dc8e3403be6f23a008b68c20581c"},"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PsypherPunk%2Fdjango-annotator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PsypherPunk%2Fdjango-annotator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PsypherPunk%2Fdjango-annotator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PsypherPunk%2Fdjango-annotator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PsypherPunk","download_url":"https://codeload.github.com/PsypherPunk/django-annotator/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244187760,"owners_count":20412915,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["annotator","django"],"created_at":"2024-10-13T12:46:13.642Z","updated_at":"2025-03-22T05:31:08.256Z","avatar_url":"https://github.com/PsypherPunk.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# `django-annotator`\n\nDjango implementation of [annotatorjs Storage](http://annotatorjs.org/).\n\nImplements most of the methods as per the\n[Core Storage/Search API](http://docs.annotatorjs.org/en/v1.2.x/storage.html#core-storage-api)\ndocumentation (`root`, `index`, `create`, `read`, `update`,`delete` and\n`search`).\n\nTo see a working demo:\n\n```sh\npoetry install\npoetry run python3 ./demo.py\n```\n\nThis will run the tests, after which a demo. page will be available at `/demo`.\n\n## Installation\n\nThe package can be installed via `poetry`:\n\n```sh\npoetry add django-annotator\n```\n\nFollowing installation it can be added to any Django project by updating the\n`INSTALLED_APPS`, along with its dependencies:\n\n```python\nINSTALLED_APPS = (\n    ...\n    \"rest_framework\",\n    \"django_filters\",\n    \"annotator\",\n)\n```\n\nAs per the integration\n[documentation](https://django-filter.readthedocs.io/en/latest/guide/rest_framework.html)\nfor `django-filter`, `DEFAULT_FILTER_BACKENDS` must also be added to\n`settings.py`:\n\n```python\nREST_FRAMEWORK = {\n    \"DEFAULT_FILTER_BACKENDS\": (\n        \"django_filters.rest_framework.DjangoFilterBackend\",\n    ),\n},\n```\n\nThen run `migrate` to include the new tables from `django-annotator`:\n\n```sh\npoetry run python3 ./manage.py migrate\n```\n\n## Annotator\n\nThe package relies on *Annotator* being installed in your project—see the\n[documentation](http://docs.annotatorjs.org/en/v1.2.x/getting-started.html) for\ndetails of its inclusion.\n\n## Settings\n\nAs per Annotator's documentation, the\n[root](http://docs.annotatorjs.org/en/v1.2.x/storage.html#root) endpoint will\nreturn information in the format:\n\n```json\n{\n    \"name\": \"django-annotator-store\",\n    \"version\": \"2.1.0\"\n}\n```\n\nThe `name` returned can be configured by setting `ANNOTATOR_NAME` in your\n`settings` (defaulting to the above).\n\n## `django-cors-headers`\n\nIf you have any issues with *Cross-origin resource sharing (CORS)*, consider\ninstalling\n[`django-cors-headers`](https://github.com/ottoyiu/django-cors-headers).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpsypherpunk%2Fdjango-annotator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpsypherpunk%2Fdjango-annotator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpsypherpunk%2Fdjango-annotator/lists"}