Skip to content

acdh-oeaw/django-recogito

Repository files navigation

django-recogito

pypi Test codecov

A python package to integrate recogito-js in a django-project

install

pip install django_recogito

add recogito to INSTALLED_APPS as well as rest_framework and django_filters:

#  project/settings.py

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'recogito',
    'example',
]

register the annotation api-endpoint in your project's urls.py:

#  project/urls.py

from django.urls import path, include
from rest_framework import routers
from recogito import api_views

router = routers.DefaultRouter()
router.register(r'recogitoannotations', api_views.RecogitoAnnotationViewSet)

urlpatterns = [
    path('admin/', admin.site.urls),
    path(r'api/', include(router.urls)),
]

run migrations python manage.py migrate

local testing

  • Load example data: python manage.py loaddata example/fixtures/fixtures.json
  • Start testserver: python manage.py runserver
  • Visit http://localhost:8000/my-text/1/

About

A python package to integrate recogito-js in a django-project

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published