semvec/pypi-packages huggingface dataset:
acdh-django-transkribus 1.1.0
django app for interacting with the Transkribus-API
License: MIT
Keywords: acdh-django-transkribus

Readme
======

.. image:: https://badge.fury.io/py/acdh-django-transkribus.svg
    :target: https://badge.fury.io/py/acdh-django-transkribus

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:


.. code-block:: python

    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:

.. code-block:: python

    TRANSKRIBUS_PUBLIC = True


.. code-block:: python

    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.