some utility function to interact with the Transkribus-API
Project description
acdh-transkribus-utils
A python package providing some utility functions for interacting with the Transkribus-API
Installation
pip install acdh-transkribus-utils
Usage
Authentication
Set Transkribus-Credentials as environment variables:
export TRANSKRIBUS_USER=some@mail.com
export TRANSKRIBUS_PASSWORD=verysecret
(or create a file called env.secret
similar to env.dummy
and run source export_env_variables.sh
)
you can pass in your credentials also as params e.g.
import os
from transkribus_utils.transkribus_utils import ACDHTranskribusUtils
tr_user = os.environ.get("TRANSKRIBUS_USER")
tr_pw = os.environ.get("TRANSKRIBUS_PASSWORD")
client = ACDHTranskribusUtils(user=tr_user, password=tr_pw)
List all collections
collections = client.list_collections()
for x in collections[-7:]:
print(x["colId"], x["colName"])
# 188933 bv-play
# 188991 Kasten_blau_45_11
# 190357 acdh-transkribus-utils
# 193145 palm
# 195363 Österreichische Bundesverfassung: Datenset A
# 196428 Österreichische Bundesverfassung: Datenset B
# 196429 Österreichische Bundesverfassung: Datenset C
List all documents from a given collection
col_id = 142911
documents = client.list_docs(col_id)
n = -3
for x in documents[n:]:
print(x["docId"], x["title"], x["author"], x["nrOfPages"])
# 950920 Kasten_blau_44_9_0050 Pfalz-Neuburg, Eleonore Magdalena Theresia von 1
# 950921 Kasten_blau_44_9_0037 Pfalz, Johann Wilhelm Joseph Janaz von der 4
# 950922 Kasten_blau_44_9_0239 Pfalz, Johann Wilhelm Joseph Janaz von der 1
Download METS files from Collection
from transkribus_utils.transkribus_utils import ACDHTranskribusUtils
COL_ID = 51052
client = ACDHTranskribusUtils()
client.collection_to_mets(COL_ID)
# downloads a METS for each document in the given collection into a folder `./{COL_ID}
client.collection_to_mets(COL_ID, file_path='./foo')
# downloads a METS for each document in the given collection into a folder `./foo/{COL_ID}
client.collection_to_mets(COL_ID, filter_by_doc_ids=[230161, 230155])
# downloads only METS for document with ID 230161 and 230155 into a folder `./{COL_ID}
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
Close
Hashes for acdh-transkribus-utils-0.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1641f1a671a7d48f28a12fa56824b881934f120befc35dedc5f5ad5d70de499f |
|
MD5 | dcfd2ecb790852d8d8242ac9e1f5b15f |
|
BLAKE2b-256 | 0e4f867f6214981d64283a7790d2ea2f37ad12ed5f3b6ac6c12cbee23dfad2cb |
Close
Hashes for acdh_transkribus_utils-0.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c6581b69ef063da6baa9b4595f8cab53575b579fed333957d254647793750e84 |
|
MD5 | eee093dbff576f9c19e2804d35891bef |
|
BLAKE2b-256 | bdbae364171fe3a49022c494d195a1462c1edef8a60397089a44d467507f210d |