Skip to content
This repository has been archived by the owner on Apr 8, 2024. It is now read-only.

acdh-oeaw/schnitzler-zeitungen

Repository files navigation

schnitzler-zeitungen

a simple django project for interacting with the Transkribus-API to search and read documents hosted and processed by Transkribus

install

  1. clone the repo git clone https://github.com/acdh-oeaw/schnitzler-zeitungen.git
  2. create and activate a virtual environment
  3. install the dependencies pip install -r requirements.txt
  4. provide the needed TRANSKRIBUS settings via environment variables (see below as well as acdh-django-transkribus)
  5. start the developement server python manage.py runserver

TRANSKRIBUS-Settings

Basically your user name and password and the ID of the collection you'd like to expose by the current application.

TRANSKRIBUS = {
    "user": "mytranskribususer@whatever.com",
    "pw": "mytranskribuspassword",
    "col_id": "43497",
    "base_url": "https://transkribus.eu/TrpServer/rest"
}

docker

building the image

  • docker build -t schnitzlerzeitungen:latest .
  • docker build -t schnitzlerzeitungen:latest --no-cache .

running the image

To run the image you should provide an .env file to pass in needed environment variables; see example below:

  • docker run -it -p 8020:8020 --env-file env.secret --name schnitzlerzeitungen schnitzlerzeitungen:latest