Skip to content

cdli-gh/cdli-cts-server

Repository files navigation

CDLI Text Services

Build Status (main branch)

This repo is a webservice which provides programmatic access to texts from the Cuneiform Digital Library Initiative.

It loads a set of documents laid out according to Capitains Guidlines and makes them available over the Canonical Text Services api.

Quickstart

pip install pipenv           # If you don't already have it.
git submodule update --init  # To download the corpus collection.
git submodule update
pipenv install --dev
pipenv run pytest
pipenv run python main.py

This starts a development server listening on the local machine. It will automatically reload the server as changes to the source are made. From there you can get available texts or fetch a text. There is also a browse interface.

Additional text collections can be added under corpora. The server must be manually restarted afterward.

Deployment

The included Dockerfile can be used to deploy the server in a container.