Skip to main content

Utility functions to work with collatex

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

acdh_collatex_utils-1.12.tar.gz (173.0 kB view hashes)

Uploaded Source

Built Distribution

acdh_collatex_utils-1.12-py3-none-any.whl (10.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page