ahlbatross


Nameahlbatross JSON
Version 0.1.7 PyPI version JSON
download
home_pageNone
SummaryTool for comparing and visualizing changes between AHB documents across different format version releases.
upload_time2024-12-12 14:07:43
maintainerNone
docs_urlNone
authorNone
requires_python>=3.11
licenseMIT
keywords ahb
VCS
bugtrack_url
requirements annotated-types click colorlog efoli et-xmlfile kohlrahbi lxml markdown-it-py mdurl more-itertools numpy openpyxl pandas pydantic pydantic-core pygments python-dateutil python-docx pytz rich shellingham six tomlkit typer typing-extensions tzdata xlsxwriter
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <img src="https://raw.githubusercontent.com/Hochfrequenz/ahlbatross/main/ahlbatross.png" alt="ahlbatross.png">

# AHlBatross

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg?labelColor=30363D&color=fccccc)](LICENSE)
![Pypi status badge](https://img.shields.io/pypi/v/ahlbatross?labelColor=30363D&color=fccccc)
![Python Versions (officially) supported](https://img.shields.io/pypi/pyversions/ahlbatross.svg?labelColor=30363D&color=fccccc)

![Unittests status badge](https://github.com/Hochfrequenz/ahlbatross/workflows/Unittests/badge.svg)
![Coverage status badge](https://github.com/Hochfrequenz/ahlbatross/workflows/Coverage/badge.svg)
![Pylint status badge](https://github.com/Hochfrequenz/ahlbatross/workflows/Linting/badge.svg)
![Formatting status badge](https://github.com/Hochfrequenz/ahlbatross/workflows/Formatting/badge.svg)

Tool for automatic AHB comparison of consecutive `Formatversionen`. Highlighted changes between `PruefIDs` of various 
`Nachrichtenformate` are provided by already formatted `.xlsx` files or raw `.csv` files located inside the 
[machine-readable-anwendungshandbücher](https://github.com/Hochfrequenz/machine-readable_anwendungshandbuecher/tree/main/diff) 
repository.

<img src="https://raw.githubusercontent.com/Hochfrequenz/ahlbatross/main/output.png" alt="output.png">

## Installation
Install this package from [PyPI](https://pypi.org/project/ahlbatross/) using

```shell
pip install ahlbatross
```

## Development Setup

To set up the python development environment, install the required dependencies via

```shell
$ tox -e dev
```

For local testing and code quality maintenance, run 

```shell
tox
```

Check out our [Python Template Repository](https://github.com/Hochfrequenz/python_template_repository#how-to-use-this-repository-on-your-machine) 
for detailed descriptions and step-by-step instructions.

### Release Workflow / CD
To publish a new version of this library on PyPI [create a new release](https://github.com/Hochfrequenz/ahlbatross/releases/new).
Use semantic versioning with leading `v`, e.g. `v1.2.3` and please include at least the autogenerated release notes.

## Contribute

Feel free to contribute to this project by opening a pull request against the main branch.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "ahlbatross",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": null,
    "keywords": "ahb",
    "author": null,
    "author_email": "Hochfrequenz Unternehmensberatung GmbH <info@hochfrequenz.de>",
    "download_url": "https://files.pythonhosted.org/packages/8b/59/19de99b4aa32b11c1708e75ee7d32543814d406c6efb09e7bb278a21e765/ahlbatross-0.1.7.tar.gz",
    "platform": null,
    "description": "<img src=\"https://raw.githubusercontent.com/Hochfrequenz/ahlbatross/main/ahlbatross.png\" alt=\"ahlbatross.png\">\n\n# AHlBatross\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg?labelColor=30363D&color=fccccc)](LICENSE)\n![Pypi status badge](https://img.shields.io/pypi/v/ahlbatross?labelColor=30363D&color=fccccc)\n![Python Versions (officially) supported](https://img.shields.io/pypi/pyversions/ahlbatross.svg?labelColor=30363D&color=fccccc)\n\n![Unittests status badge](https://github.com/Hochfrequenz/ahlbatross/workflows/Unittests/badge.svg)\n![Coverage status badge](https://github.com/Hochfrequenz/ahlbatross/workflows/Coverage/badge.svg)\n![Pylint status badge](https://github.com/Hochfrequenz/ahlbatross/workflows/Linting/badge.svg)\n![Formatting status badge](https://github.com/Hochfrequenz/ahlbatross/workflows/Formatting/badge.svg)\n\nTool for automatic AHB comparison of consecutive `Formatversionen`. Highlighted changes between `PruefIDs` of various \n`Nachrichtenformate` are provided by already formatted `.xlsx` files or raw `.csv` files located inside the \n[machine-readable-anwendungshandb\u00fccher](https://github.com/Hochfrequenz/machine-readable_anwendungshandbuecher/tree/main/diff) \nrepository.\n\n<img src=\"https://raw.githubusercontent.com/Hochfrequenz/ahlbatross/main/output.png\" alt=\"output.png\">\n\n## Installation\nInstall this package from [PyPI](https://pypi.org/project/ahlbatross/) using\n\n```shell\npip install ahlbatross\n```\n\n## Development Setup\n\nTo set up the python development environment, install the required dependencies via\n\n```shell\n$ tox -e dev\n```\n\nFor local testing and code quality maintenance, run \n\n```shell\ntox\n```\n\nCheck out our [Python Template Repository](https://github.com/Hochfrequenz/python_template_repository#how-to-use-this-repository-on-your-machine) \nfor detailed descriptions and step-by-step instructions.\n\n### Release Workflow / CD\nTo publish a new version of this library on PyPI [create a new release](https://github.com/Hochfrequenz/ahlbatross/releases/new).\nUse semantic versioning with leading `v`, e.g. `v1.2.3` and please include at least the autogenerated release notes.\n\n## Contribute\n\nFeel free to contribute to this project by opening a pull request against the main branch.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Tool for comparing and visualizing changes between AHB documents across different format version releases.",
    "version": "0.1.7",
    "project_urls": {
        "Changelog": "https://github.com/Hochfrequenz/ahlbatross/releases",
        "Homepage": "https://github.com/Hochfrequenz/ahlbatross"
    },
    "split_keywords": [
        "ahb"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ac916058a9e2d24a5befa54553db531cef754c17fb3a1fceb0b1f531f2017c1b",
                "md5": "b4c974774b6253cae1213413629e6326",
                "sha256": "d27c4678444634f2e027a9b2819f6688707ae621d3893e66ae7f94d79a7e4e4f"
            },
            "downloads": -1,
            "filename": "ahlbatross-0.1.7-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b4c974774b6253cae1213413629e6326",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 17236,
            "upload_time": "2024-12-12T14:07:41",
            "upload_time_iso_8601": "2024-12-12T14:07:41.376676Z",
            "url": "https://files.pythonhosted.org/packages/ac/91/6058a9e2d24a5befa54553db531cef754c17fb3a1fceb0b1f531f2017c1b/ahlbatross-0.1.7-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8b5919de99b4aa32b11c1708e75ee7d32543814d406c6efb09e7bb278a21e765",
                "md5": "374fb49ee432b420b301da074f75e076",
                "sha256": "d2e661fc2d7732863b27641a77a1b7ff97fc1eee32bfc04eb94374f6d74418ea"
            },
            "downloads": -1,
            "filename": "ahlbatross-0.1.7.tar.gz",
            "has_sig": false,
            "md5_digest": "374fb49ee432b420b301da074f75e076",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 1078115,
            "upload_time": "2024-12-12T14:07:43",
            "upload_time_iso_8601": "2024-12-12T14:07:43.024306Z",
            "url": "https://files.pythonhosted.org/packages/8b/59/19de99b4aa32b11c1708e75ee7d32543814d406c6efb09e7bb278a21e765/ahlbatross-0.1.7.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-12 14:07:43",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Hochfrequenz",
    "github_project": "ahlbatross",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "annotated-types",
            "specs": [
                [
                    "==",
                    "0.7.0"
                ]
            ]
        },
        {
            "name": "click",
            "specs": [
                [
                    "==",
                    "8.1.7"
                ]
            ]
        },
        {
            "name": "colorlog",
            "specs": [
                [
                    "==",
                    "6.9.0"
                ]
            ]
        },
        {
            "name": "efoli",
            "specs": [
                [
                    "==",
                    "1.3.0"
                ]
            ]
        },
        {
            "name": "et-xmlfile",
            "specs": [
                [
                    "==",
                    "2.0.0"
                ]
            ]
        },
        {
            "name": "kohlrahbi",
            "specs": [
                [
                    "==",
                    "1.11.2"
                ]
            ]
        },
        {
            "name": "lxml",
            "specs": [
                [
                    "==",
                    "5.3.0"
                ]
            ]
        },
        {
            "name": "markdown-it-py",
            "specs": [
                [
                    "==",
                    "3.0.0"
                ]
            ]
        },
        {
            "name": "mdurl",
            "specs": [
                [
                    "==",
                    "0.1.2"
                ]
            ]
        },
        {
            "name": "more-itertools",
            "specs": [
                [
                    "==",
                    "10.5.0"
                ]
            ]
        },
        {
            "name": "numpy",
            "specs": [
                [
                    "==",
                    "2.2.0"
                ]
            ]
        },
        {
            "name": "openpyxl",
            "specs": [
                [
                    "==",
                    "3.1.5"
                ]
            ]
        },
        {
            "name": "pandas",
            "specs": [
                [
                    "==",
                    "2.2.3"
                ]
            ]
        },
        {
            "name": "pydantic",
            "specs": [
                [
                    "==",
                    "2.10.3"
                ]
            ]
        },
        {
            "name": "pydantic-core",
            "specs": [
                [
                    "==",
                    "2.27.1"
                ]
            ]
        },
        {
            "name": "pygments",
            "specs": [
                [
                    "==",
                    "2.18.0"
                ]
            ]
        },
        {
            "name": "python-dateutil",
            "specs": [
                [
                    "==",
                    "2.9.0.post0"
                ]
            ]
        },
        {
            "name": "python-docx",
            "specs": [
                [
                    "==",
                    "1.1.2"
                ]
            ]
        },
        {
            "name": "pytz",
            "specs": [
                [
                    "==",
                    "2024.2"
                ]
            ]
        },
        {
            "name": "rich",
            "specs": [
                [
                    "==",
                    "13.9.4"
                ]
            ]
        },
        {
            "name": "shellingham",
            "specs": [
                [
                    "==",
                    "1.5.4"
                ]
            ]
        },
        {
            "name": "six",
            "specs": [
                [
                    "==",
                    "1.17.0"
                ]
            ]
        },
        {
            "name": "tomlkit",
            "specs": [
                [
                    "==",
                    "0.13.2"
                ]
            ]
        },
        {
            "name": "typer",
            "specs": [
                [
                    "==",
                    "0.15.1"
                ]
            ]
        },
        {
            "name": "typing-extensions",
            "specs": [
                [
                    "==",
                    "4.12.2"
                ]
            ]
        },
        {
            "name": "tzdata",
            "specs": [
                [
                    "==",
                    "2024.2"
                ]
            ]
        },
        {
            "name": "xlsxwriter",
            "specs": [
                [
                    "==",
                    "3.2.0"
                ]
            ]
        }
    ],
    "tox": true,
    "lcname": "ahlbatross"
}
        
Elapsed time: 1.36255s