Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/acdh-oeaw/acdh-tei-pyutils

Utilty functions to work with TEI Documents

https://github.com/acdh-oeaw/acdh-tei-pyutils

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
    1 of 3 committers (33.3%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (11.8%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

Utilty functions to work with TEI Documents

Basic Info
Statistics
  • Stars: 1
  • Watchers: 5
  • Forks: 0
  • Open Issues: 0
  • Releases: 36
Created over 5 years ago · Last pushed over 1 year ago
Metadata Files
Readme License

README.md

acdh-tei-pyutils

Github Workflow Tests Status PyPI version codecov

Utilty functions to work with TEI Documents

install

run pip install acdh-tei-pyutils

usage

some examples on how to use this package

parse an XML/TEI Document from and URL, string or file:

```python from acdhteipyutils.tei import TeiReader

doc = TeiReader("https://raw.githubusercontent.com/acdh-oeaw/acdh-tei-pyutils/main/acdhteipyutils/files/tei.xml") print(doc.tree)

doc = TeiReader("./acdhteipyutils/files/tei.xml") doc.tree

```

write the current XML/TEI tree object to file

```python doc.treetofile("out.xml")

'out.xml' ```

see acdhteipyutils/cli.py for further examples

command line scripts

Batch process a collection of XML/Documents by adding xml:id, xml:base next and prev attributes to the documents root element run:

bash add-attributes -g "/path/to/your/xmls/*.xml" -b "https://value/of-your/base.com" add-attributes -g "../../xml/grundbuecher/gb-data/data/editions/*.xml" -b "https://id.acdh.oeaw.ac.at/grundbuecher"

Write mentions as listEvents into index-files:

bash mentions-to-indices -t "erwähnt in " -i "/path/to/your/xmls/indices/*.xml" -f "/path/to/your/xmls/editions/*.xml"

Write mentions as listEvents of index-files and copy enriched index entries into files

bash denormalize-indices -f "../../xml/schnitzler/schnitzler-tagebuch-data-public/editions/*.xml" -i "../../xml/schnitzler/schnitzler-tagebuch-data-public/indices/*.xml" denormalize-indices -f "./data/*/*.xml" -i "./data/indices/*.xml" -m ".//*[@key]/@key" -x ".//tei:title[@level='a']/text()" denormalize-indices -f "./data/*/*.xml" -i "./data/indices/*.xml" -m ".//*[@key]/@key" -x ".//tei:title[@level='a']/text()" -b pmb2121 -b pmb10815 -b pmb50

Register handle-ids and add them as tei:idno elements:

bash add-handles -g "../../xml/grundbuecher/gb-data/data/editions/*.xml" -user "user12.3456-01" -pw "verysecret" -hixpath ".//tei:publicationStmt"

develop

  • install dev-dependencies: pip install -r requirements_dev.txt
  • install local package pip install -e .
  • before commiting run flake8 to check linting and coverage run -m pytest -v to run the tests

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
  • Create event: 5
  • Release event: 2
  • Issues event: 6
  • Delete event: 6
  • Push event: 9
  • Pull request event: 6
Last Year
  • Create event: 5
  • Release event: 2
  • Issues event: 6
  • Delete event: 6
  • Push event: 9
  • Pull request event: 6

Committers

Last synced: over 3 years ago

All Time
  • Total Commits: 92
  • Total Committers: 3
  • Avg Commits per committer: 30.667
  • Development Distribution Score (DDS): 0.054
Top Committers
Name Email Commits
csae8092 p****r@o****t 87
Daniel_Stoxreiter d****r@o****e 4
Peter Andorfer p****r@g****m 1
Committer Domains (Top 20 + Academic)
outlook.de: 1 oeaw.ac.at: 1

Issues and Pull Requests

Last synced: 12 months ago

All Time
  • Total issues: 23
  • Total pull requests: 20
  • Average time to close issues: 3 days
  • Average time to close pull requests: 12 minutes
  • Total issue authors: 3
  • Total pull request authors: 3
  • Average comments per issue: 0.48
  • Average comments per pull request: 0.2
  • Merged pull requests: 20
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 4
  • Pull requests: 4
  • Average time to close issues: about 1 hour
  • Average time to close pull requests: 1 minute
  • Issue authors: 2
  • Pull request authors: 2
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 4
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • csae8092 (14)
  • linxOD (6)
  • cfhaak (1)
Pull Request Authors
  • csae8092 (17)
  • linxOD (7)
  • cfhaak (2)
Top Labels
Issue Labels
enhancement (13) bug (1)
Pull Request Labels
enhancement (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 8,321 last-month
  • Total dependent packages: 3
  • Total dependent repositories: 13
  • Total versions: 34
  • Total maintainers: 2
pypi.org: acdh-tei-pyutils

Utilty functions to work with TEI Documents

  • Versions: 34
  • Dependent Packages: 3
  • Dependent Repositories: 13
  • Downloads: 8,321 Last month
Rankings
Dependent packages count: 3.1%
Dependent repos count: 4.0%
Downloads: 7.0%
Average: 15.2%
Forks count: 29.8%
Stargazers count: 31.9%
Maintainers (2)
csae8092 acdh-ch-tech
Last synced: 11 months ago

Dependencies

.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.txt pypi
  • acdh-handle-pyutils >=0.3.0,<4
  • acdh-xml-pyutils *
  • click >=7.1.2
  • tqdm >=4.59.0
requirements_dev.txt pypi
  • black * development
  • coverage >=6.4.4,<7 development
  • flake8 >=5.0.4,<6 development
  • pip * development
  • pytest >=7.1.3,<8 development
  • wheel * development