acdh-collatex-utils

Name	acdh-collatex-utils JSON
Version	1.12 JSON
	download
home_page	https://github.com/acdh-oeaw/acdh_collatex_utils
Summary	Utility functions to work with collatex
upload_time	2022-12-06 15:00:11
maintainer
docs_url	None
author	Peter Andorfer
requires_python	>=3.8
license	MIT license
keywords	acdh_collatex_utils
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # CollateX Utils

[![PyPI version](https://badge.fury.io/py/acdh-collatex-utils.svg)](https://badge.fury.io/py/acdh-collatex-utils)
[![codecov](https://codecov.io/gh/acdh-oeaw/acdh_collatex_utils/branch/master/graph/badge.svg?token=G3PO6ZC12Z)](https://codecov.io/gh/acdh-oeaw/acdh_collatex_utils)

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](https://github.com/freud-digital/frd-data/blob/main/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`

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/acdh-oeaw/acdh_collatex_utils",
    "name": "acdh-collatex-utils",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "acdh_collatex_utils",
    "author": "Peter Andorfer",
    "author_email": "peter.andorfer@oeaw.ac.at",
    "download_url": "https://files.pythonhosted.org/packages/01/7a/8470f27b64049d9cc439459ef948c0b79e632f2308577eba6c008cee721d/acdh_collatex_utils-1.12.tar.gz",
    "platform": null,
    "description": "# CollateX Utils\n\n[![PyPI version](https://badge.fury.io/py/acdh-collatex-utils.svg)](https://badge.fury.io/py/acdh-collatex-utils)\n[![codecov](https://codecov.io/gh/acdh-oeaw/acdh_collatex_utils/branch/master/graph/badge.svg?token=G3PO6ZC12Z)](https://codecov.io/gh/acdh-oeaw/acdh_collatex_utils)\n\nA python package to collate things with collate-x\n\n## install\n\n* create a virtual environment and install the package with `pip install acdh_collatex_utils` \n\n## use\n\nTo collate a bunch of XML/TEI documents located in e.g. `./to_collate` run\n`collate -g './to_collate/*.xml`\n\nThis creates a folder `./to_collate/collated` and saves chunked HTML and TEI Files like `out__001.html` or `out__001.tei`\n\nTo see this package in use in a real life project, please check out [frd-data/collate_work.py](https://github.com/freud-digital/frd-data/blob/main/collate_work.py)\n\n## develop\n\n* create a virutal environment\n* install dev-requirements `pip install -U pip` and `pip install -r requirements_dev.txt`\n* install the package in dev-mode `pip install -e .`\n\n* run test with `coverage run -m pytest -v`\n* create test-report `coverage report` or `coverage html`\n",
    "bugtrack_url": null,
    "license": "MIT license",
    "summary": "Utility functions to work with collatex",
    "version": "1.12",
    "split_keywords": [
        "acdh_collatex_utils"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "bb857095f1bc4001399e57aacb7b8673",
                "sha256": "47dfc0f896303125958843d793fd2911f1aa69e3a4136b988515bdb7c691e846"
            },
            "downloads": -1,
            "filename": "acdh_collatex_utils-1.12-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "bb857095f1bc4001399e57aacb7b8673",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 10334,
            "upload_time": "2022-12-06T15:00:09",
            "upload_time_iso_8601": "2022-12-06T15:00:09.079922Z",
            "url": "https://files.pythonhosted.org/packages/f5/ab/bbbd768354cc0edc01b3a112dd8633666eab8c67ab4439e7ba6c4a5a87bd/acdh_collatex_utils-1.12-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "636fcdaa6d1f13da2af610541a296c12",
                "sha256": "a93c5fbac896dbca00eea25fdd90f20675f810ccc8b1a4e93350482edb844ee8"
            },
            "downloads": -1,
            "filename": "acdh_collatex_utils-1.12.tar.gz",
            "has_sig": false,
            "md5_digest": "636fcdaa6d1f13da2af610541a296c12",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 173049,
            "upload_time": "2022-12-06T15:00:11",
            "upload_time_iso_8601": "2022-12-06T15:00:11.118463Z",
            "url": "https://files.pythonhosted.org/packages/01/7a/8470f27b64049d9cc439459ef948c0b79e632f2308577eba6c008cee721d/acdh_collatex_utils-1.12.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-12-06 15:00:11",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "acdh-oeaw",
    "github_project": "acdh_collatex_utils",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "acdh-collatex-utils"
}