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.
from transkribus_utils.transkribus_utils import ACDHTranskribusUtils
client = ACDHTranskribusUtils(user="some@mail.com", password="verysecret")
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.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4a5069b3eaf6603c4174946fff0a77bf90615db2d29949e2d25a85e563406f22 |
|
MD5 | e921c3a25287890381881f38ce84370e |
|
BLAKE2b-256 | 885c3308584c34f68993e9dfa69517ae17a3b6e08acacb010d65d02851adfeb4 |
Close
Hashes for acdh_transkribus_utils-2.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ba99dbd647f7473380223aee4b0be0078e740a61fefc9dd8b1ca0abc0e796851 |
|
MD5 | 6a2815cdf92297b8c7aa23229ab26ced |
|
BLAKE2b-256 | 88c95515287807e471c514c8ccfba026e58a5f64200ec08b3d41e61d00902869 |