acdh-collatex-utils

Utility functions to work with collatex


Keywords
acdh_collatex_utils
License
MIT
Install
pip install acdh-collatex-utils==1.12

Documentation

CollateX Utils

PyPI version codecov

A python package to collate things with collate-x

install

  • create a virtual environment and install the package with pip install acdh_collatex_utils

use

To collate a bunch of XML/TEI documents located in e.g. ./to_collate run collate -g './to_collate/*.xml

This creates a folder ./to_collate/collated and saves chunked HTML and TEI Files like out__001.html or out__001.tei

To see this package in use in a real life project, please check out frd-data/collate_work.py

develop

  • create a virutal environment

  • install dev-requirements pip install -U pip and pip install -r requirements_dev.txt

  • install the package in dev-mode pip install -e .

  • run test with coverage run -m pytest -v

  • create test-report coverage report or coverage html