Metadata-Version: 1.1
Name: acdh-django-transkribus
Version: 0.3.1
Summary: django app for interacting with the Transkribus-API
Home-page: https://github.com/acdh-oeaw/acdh-django-transkribus
Author: Peter Andorfer, Ingo Börner
Author-email: peter.andorfer@oeaw.ac.at, ingo.boerner@oeaw.ac.at
License: MIT
Description: 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"
            }
        
        
        For custom translations you'd need to add following dict to your settings:
        
        
        .. 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
        -------
        
        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.
        
Keywords: acdh-django-transkribus
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Django :: 2.0
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
