Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/acdh-oeaw/acdh-django-transkribus

django app to interact with Transkribus-API

https://github.com/acdh-oeaw/acdh-django-transkribus

Science Score: 10.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ○
    codemeta.json file
  • ○
    .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    1 of 2 committers (50.0%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (7.3%) to scientific vocabulary

Keywords

acdh-django-packages apis-app django djangobaseproject transkribus
Last synced: 6 months ago · JSON representation

Repository

django app to interact with Transkribus-API

Basic Info
  • Host: GitHub
  • Owner: acdh-oeaw
  • License: mit
  • Language: Python
  • Default Branch: master
  • Size: 71.3 KB
Statistics
  • Stars: 1
  • Watchers: 6
  • Forks: 0
  • Open Issues: 2
  • Releases: 0
Topics
acdh-django-packages apis-app django djangobaseproject transkribus
Created over 6 years ago · Last pushed over 5 years ago
Metadata Files
Readme Changelog License

README.rst 

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'
        }
    }

Owner

  • Name: Austrian Centre for Digital Humanities & Cultural Heritage
  • Login: acdh-oeaw
  • Kind: organization
  • Email: acdh@oeaw.ac.at
  • Location: Vienna, Austria

GitHub Events

Total
Last Year

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 38
  • Total Committers: 2
  • Avg Commits per committer: 19.0
  • Development Distribution Score (DDS): 0.158
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Peter Andorfer P****r@o****t 32
ingoboerner i****r@g****t 6
Committer Domains (Top 20 + Academic)
gmx.at: 1 oeaw.ac.at: 1

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 11
  • Total pull requests: 0
  • Average time to close issues: 7 days
  • Average time to close pull requests: N/A
  • Total issue authors: 3
  • Total pull request authors: 0
  • Average comments per issue: 0.36
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • csae8092 (6)
  • ingoboerner (4)
  • martinantonmueller (1)
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 157 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 3
  • Total versions: 9
  • Total maintainers: 1
pypi.org: acdh-django-transkribus

django app for interacting with the Transkribus-API

  • Versions: 9
  • Dependent Packages: 0
  • Dependent Repositories: 3
  • Downloads: 157 Last month
Rankings
Dependent repos count: 8.9%
Dependent packages count: 10.1%
Downloads: 18.7%
Average: 19.9%
Forks count: 29.8%
Stargazers count: 31.9%
Maintainers (1)
csae8092
Last synced: 6 months ago

Dependencies

setup.py pypi
  • django *
  • lxml *
  • requests *