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-2.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 20ba93c6ab49a6464c34511d263723b989cda2045f154b9f00b84cfc2fc1d00a |
|
MD5 | ede8d4fcc3735970711e3cd1c40543aa |
|
BLAKE2b-256 | 8a9575ff42e7efdc2370df58ddd134fa312cbeaf3567e65a80397d67d9ce5472 |
Close
Hashes for acdh_transkribus_utils-2.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3531c5cf6a52d22ae80859e7fd6835d6a1e20fe3e37ce946520de6fff8745aec |
|
MD5 | d76dec433fc8e7d2aa4b3374579ca477 |
|
BLAKE2b-256 | c1678df08969bfe10e49064a5c530c55f565615178e90c636f71b61fe451212c |