Data

Tools

Indexes

Applications

Experiments

Open Source Science

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

A python package providing some utility functions for interacting with the Transkribus-API

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

Science Score: 36.0%

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

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

Keywords

acdh-python-packages transkribus
Last synced: 10 months ago · JSON representation

Repository

A python package providing some utility functions for interacting with the Transkribus-API

Basic Info
Statistics
  • Stars: 4
  • Watchers: 6
  • Forks: 2
  • Open Issues: 2
  • Releases: 11
Topics
acdh-python-packages transkribus
Created about 6 years ago · Last pushed about 1 year ago
Metadata Files
Readme License

README.md

acdh-transkribus-utils

PyPI version flake8 Lint Test codecov

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:

bash 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.

```python import os

from transkribusutils.transkribusutils import ACDHTranskribusUtils

truser = os.environ.get("TRANSKRIBUSUSER") trpw = os.environ.get("TRANSKRIBUSPASSWORD")

client = ACDHTranskribusUtils(user=truser, password=trpw) ```

List all collections

```python collections = client.list_collections() for x in collections[-7:]: print(x["colId"], x["colName"])

188933 bv-play

188991 Kastenblau45_11

190357 acdh-transkribus-utils

193145 palm

195363 Österreichische Bundesverfassung: Datenset A

196428 Österreichische Bundesverfassung: Datenset B

196429 Österreichische Bundesverfassung: Datenset C

```

List all documents from a given collection

```python colid = 142911 documents = client.listdocs(col_id) n = -3 for x in documents[n:]: print(x["docId"], x["title"], x["author"], x["nrOfPages"])

950920 Kastenblau4490050 Pfalz-Neuburg, Eleonore Magdalena Theresia von 1

950921 Kastenblau4490037 Pfalz, Johann Wilhelm Joseph Janaz von der 4

950922 Kastenblau4490239 Pfalz, Johann Wilhelm Joseph Janaz von der 1

```

Download METS files from Collection

```python from transkribusutils.transkribusutils import ACDHTranskribusUtils

COLID = 51052 client = ACDHTranskribusUtils() client.collectiontomets(COLID)

downloads a METS for each document in the given collection into a folder `./{COL_ID}

client.collectiontomets(COLID, filepath='./foo')

downloads a METS for each document in the given collection into a folder `./foo/{COL_ID}

client.collectiontomets(COLID, filterbydocids=[230161, 230155])

downloads only METS for document with ID 230161 and 230155 into a folder `./{COL_ID}

```

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
  • Issues event: 1
  • Pull request event: 2
  • Create event: 1
Last Year
  • Issues event: 1
  • Pull request event: 2
  • Create event: 1

Committers

Last synced: over 3 years ago

All Time
  • Total Commits: 26
  • Total Committers: 3
  • Avg Commits per committer: 8.667
  • Development Distribution Score (DDS): 0.115
Top Committers
Name Email Commits
csae8092 p****r@o****t 23
Matthias Schlögl m****l@o****t 2
cfhaak c****k@p****e 1
Committer Domains (Top 20 + Academic)
oeaw.ac.at: 2 posteo.de: 1

Issues and Pull Requests

Last synced: 12 months ago

All Time
  • Total issues: 19
  • Total pull requests: 14
  • Average time to close issues: 11 days
  • Average time to close pull requests: 17 minutes
  • Total issue authors: 2
  • Total pull request authors: 3
  • Average comments per issue: 0.16
  • Average comments per pull request: 0.07
  • Merged pull requests: 13
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 2
  • Pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: about 1 hour
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • csae8092 (13)
  • cfhaak (3)
Pull Request Authors
  • csae8092 (11)
  • cfhaak (2)
  • fsanzl (2)
Top Labels
Issue Labels
enhancement (5) METS/GOOBI (2) housekeeping (2)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 224 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 18
  • Total maintainers: 3
pypi.org: acdh-transkribus-utils

some utility function to interact with the Transkribus-API

  • Versions: 18
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 224 Last month
Rankings
Dependent packages count: 7.6%
Downloads: 14.2%
Average: 21.5%
Dependent repos count: 22.7%
Forks count: 30.4%
Stargazers count: 32.4%
Maintainers (3)
csae8092 sennierer acdh-ch-tech
Last synced: 11 months ago

Dependencies

setup.py pypi
  • click *
  • lxml *
  • requests *
.github/workflows/lint.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • py-actions/flake8 v2 composite
.github/workflows/pypi.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
.github/workflows/test.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • codecov/codecov-action v3 composite
requirements_dev.txt pypi
  • black * development
  • coverage * development
  • flake8 * development
  • pytest * development