django app for interacting with the Transkribus-API
Project description
A django app for interacting with the [Transkribus-API](https://transkribus.eu/wiki/index.php/REST_Interface) to search and read documents hosted and processed by [Transkribus](https://transkribus.eu/Transkribus/)
Installation
pip install acdh-django-transkribus
Use:
Add your user name and password and the ID of the collection you’d like to expose by the current application’s settings file like shown below:
TRANSKRIBUS = {
"user": "mytranskribususer@whatever.com",
"pw": "mytranskribuspassword",
"col_id": "43497"
}
To make the faksimiles only accessible for logged in user, you need to add the following flag to your settings:
For custom translations you’d need to add following dict to your settings:
TRANSKRIBUS_PUBLIC = True
TRANSKRIBUS_TRANSLATIONS = {
'search_form': {
'prefil': 'search in all documents',
'button': 'Go!'
},
'search_header': {
'header': 'Fulltext Search'
},
'hits': {
'facet_header': 'refine your search',
'facet_doc_title': 'Document',
'result_header': 'Results',
'kwic_header': 'KWIC',
'result_col': 'Collection',
'result_doc': 'Document',
'result_page': 'Page',
'result_link': 'go to document'
},
'page': {
'img_col': 'IMG',
'text_col': 'TEXT'
},
'docs': {
'title_col': 'Title',
'page_nr_col': 'Nr. of pages',
'preview_col': 'Preview',
'doc_singular': 'Document',
'doc_plural': 'Documents',
'page_singular': 'Page',
'page_plural': 'Pages'
}
}
History
1.1.0 (2020-03-20)
added possiblity to restrict access to non logged-in users to Facsimiles by adding TRANSKRIBUS_PUBLIC = False to settings
1.0.0 (2020-03-20)
load staticfiles -> load static to be Django > 3.x compatible
0.3.0 (2019-10-24)
more translations
transkribus-css classes added to templates
added TrpBaseModel
0.2.0 (2019-10-09)
Added settings param for custom translations
0.1.0 (2019-10-02)
First release.
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
Hashes for acdh-django-transkribus-1.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6312e4dc1536ddba701a26951017029359fcd51f335b884912f0d259292501be |
|
MD5 | 6eb92719c17bec98037aaf4b9ab2d5f1 |
|
BLAKE2b-256 | 66b9b49ca3a81b68a85ac3e53cb7981ce757b08318648ab8e3e83bc85f7f1e9f |
Hashes for acdh_django_transkribus-1.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | aaf18b9757b91206a0366619571366baab2c547e12dab8c842d1381ec3f3a66b |
|
MD5 | 177470362b5b0541031ec9e8d4c31880 |
|
BLAKE2b-256 | 4560496e83f96e42125375308f14aaea7e11c46b3ae4b404dbe127d107701607 |