efoli


Nameefoli JSON
Version 1.4.0 PyPI version JSON
download
home_pageNone
SummaryEnums and related helper functions that model EDIFACT relevant data for German utilities
upload_time2024-12-09 14:26:18
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseMIT
keywords bdew edifact enums
VCS
bugtrack_url
requirements pytz
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # E-Foli

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
![Python Versions (officially) supported](https://img.shields.io/pypi/pyversions/efoli.svg)
![Pypi status badge](https://img.shields.io/pypi/v/efoli)
![Unittests status badge](https://github.com/Hochfrequenz/efoli/workflows/Unittests/badge.svg)
![Coverage status badge](https://github.com/Hochfrequenz/efoli/workflows/Coverage/badge.svg)
![Linting status badge](https://github.com/Hochfrequenz/efoli/workflows/Linting/badge.svg)
![Black status badge](https://github.com/Hochfrequenz/efoli/workflows/Formatting/badge.svg)

`efoli` is a Python package, that contains
- an Enum `EdifactFormat` that models EDIFACT formats used by German utilities like, e.g.
  - `UTILMD`
  - `MSCONS`
  - `INVOIC`
  - …
- an Enum `EdifactFormatVersion` that models validity periods of different message versions, e.g.
  - `FV2310` is valid from 2023-10-01 onwards
  - `FV2404` is valid from 2024-04-03 onwards
  - …
- helper methods that allow
  - to derive the `EdifactFormat` from a given _Prüfidentifikator_ (e.g. `55001`➡`UTILMD`)
  - that derive the `EdifactFormatVersion` from a given date(time) (e.g. `2024-01-01`➡`FV2310`)

It's not much, but we need it at many places.
This is why we use this package as a central place to define these formats and versions.

## Installation
```bash
pip install efoli
```

## Setup for Local Development
Follow the instructions from our [template repository](https://github.com/Hochfrequenz/python_template_repository?tab=readme-ov-file#how-to-use-this-repository-on-your-machine).
tl;dr: `tox`.

## Contribute
You are very welcome to contribute to this template repository by opening a pull request against the main branch.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "efoli",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "bdew, edifact, enums",
    "author": null,
    "author_email": "Hochfrequenz Unternehmensberatung GmbH <info+github@hochfrequenz.de>",
    "download_url": "https://files.pythonhosted.org/packages/56/27/89b21bbac8b9e772f76b7b8f9fecac90d82845f1018d9deef1265520975a/efoli-1.4.0.tar.gz",
    "platform": null,
    "description": "# E-Foli\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)\n![Python Versions (officially) supported](https://img.shields.io/pypi/pyversions/efoli.svg)\n![Pypi status badge](https://img.shields.io/pypi/v/efoli)\n![Unittests status badge](https://github.com/Hochfrequenz/efoli/workflows/Unittests/badge.svg)\n![Coverage status badge](https://github.com/Hochfrequenz/efoli/workflows/Coverage/badge.svg)\n![Linting status badge](https://github.com/Hochfrequenz/efoli/workflows/Linting/badge.svg)\n![Black status badge](https://github.com/Hochfrequenz/efoli/workflows/Formatting/badge.svg)\n\n`efoli` is a Python package, that contains\n- an Enum `EdifactFormat` that models EDIFACT formats used by German utilities like, e.g.\n  - `UTILMD`\n  - `MSCONS`\n  - `INVOIC`\n  - \u2026\n- an Enum `EdifactFormatVersion` that models validity periods of different message versions, e.g.\n  - `FV2310` is valid from 2023-10-01 onwards\n  - `FV2404` is valid from 2024-04-03 onwards\n  - \u2026\n- helper methods that allow\n  - to derive the `EdifactFormat` from a given _Pr\u00fcfidentifikator_ (e.g. `55001`\u27a1`UTILMD`)\n  - that derive the `EdifactFormatVersion` from a given date(time) (e.g. `2024-01-01`\u27a1`FV2310`)\n\nIt's not much, but we need it at many places.\nThis is why we use this package as a central place to define these formats and versions.\n\n## Installation\n```bash\npip install efoli\n```\n\n## Setup for Local Development\nFollow the instructions from our [template repository](https://github.com/Hochfrequenz/python_template_repository?tab=readme-ov-file#how-to-use-this-repository-on-your-machine).\ntl;dr: `tox`.\n\n## Contribute\nYou are very welcome to contribute to this template repository by opening a pull request against the main branch.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Enums and related helper functions that model EDIFACT relevant data for German utilities",
    "version": "1.4.0",
    "project_urls": {
        "Changelog": "https://github.com/Hochfrequenz/efoli/releases",
        "Homepage": "https://github.com/Hochfrequenz/efoli"
    },
    "split_keywords": [
        "bdew",
        " edifact",
        " enums"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "905bcbed7809654e44a239569b416c9f5bea89ff0b9bb41bff85887711418df3",
                "md5": "2630eaa59427203b622951068138bb13",
                "sha256": "f40fe3cce9ddae2df9522cb4fb1b06e0d845fb00b26921c639cb94675419075b"
            },
            "downloads": -1,
            "filename": "efoli-1.4.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2630eaa59427203b622951068138bb13",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 5842,
            "upload_time": "2024-12-09T14:26:16",
            "upload_time_iso_8601": "2024-12-09T14:26:16.897363Z",
            "url": "https://files.pythonhosted.org/packages/90/5b/cbed7809654e44a239569b416c9f5bea89ff0b9bb41bff85887711418df3/efoli-1.4.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "562789b21bbac8b9e772f76b7b8f9fecac90d82845f1018d9deef1265520975a",
                "md5": "67b7af60042cf7b8fd392a0203af7850",
                "sha256": "63fa8a5d41d571a7aeb662f4d70914a9f461e22fb48646209683ae41447a7132"
            },
            "downloads": -1,
            "filename": "efoli-1.4.0.tar.gz",
            "has_sig": false,
            "md5_digest": "67b7af60042cf7b8fd392a0203af7850",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 10533,
            "upload_time": "2024-12-09T14:26:18",
            "upload_time_iso_8601": "2024-12-09T14:26:18.837663Z",
            "url": "https://files.pythonhosted.org/packages/56/27/89b21bbac8b9e772f76b7b8f9fecac90d82845f1018d9deef1265520975a/efoli-1.4.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-09 14:26:18",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Hochfrequenz",
    "github_project": "efoli",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "pytz",
            "specs": [
                [
                    "==",
                    "2024.2"
                ]
            ]
        }
    ],
    "tox": true,
    "lcname": "efoli"
}
        
Elapsed time: 1.49180s