efoli 0.0.1__tar.gz

efoli-0.0.1/.github/dependabot.yml

@@ -0,0 +1,18 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "pip" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"
+    reviewers:
+      - "@Hochfrequenz/python-developers-review-team"
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

efoli-0.0.1/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,70 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [main]
+  schedule:
+    - cron: "29 14 * * 6"
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: ["python"]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://git.io/codeql-language-support
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v3
+        with:
+          languages: ${{ matrix.language }}
+          # If you wish to specify custom queries, you can do so here or in a config file.
+          # By default, queries listed here will override any specified in a config file.
+          # Prefix the list here with "+" to use these queries and those in the config file.
+          # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+      # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+      # If this step fails, then you should remove it and run the build manually (see below)
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v3
+
+      # ℹ️ Command-line programs to run using the OS shell.
+      # 📚 https://git.io/JvXDl
+
+      # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+      #    and modify them (or add more) to build your code if your project
+      #    uses a compiled language
+
+      #- run: |
+      #   make bootstrap
+      #   make release
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v3

efoli-0.0.1/.github/workflows/coverage.yml

@@ -0,0 +1,26 @@
+name: "Coverage"
+
+on:
+  push:
+    branches: [main]
+  pull_request: {}
+jobs:
+  coverage:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: ["3.12"]
+        os: [ubuntu-latest]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install tox
+      - name: Run Tests and Record Coverage
+        run: |
+          tox -e coverage

efoli-0.0.1/.github/workflows/dependabot_automerge.yml

@@ -0,0 +1,18 @@
+name: Dependabot auto-approve / -merge
+on: pull_request
+
+jobs:
+  dependabot:
+    permissions:
+      contents: write
+      pull-requests: write
+    runs-on: ubuntu-latest
+    env:
+      PR_URL: ${{github.event.pull_request.html_url}}
+      GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+    if: ${{ github.actor == 'dependabot[bot]' }}
+    steps:
+      - name: Approve a PR
+        run: gh pr review --approve "$PR_URL"
+      - name: Enable auto-merge for Dependabot PRs
+        run: gh pr merge --auto --squash "$PR_URL"

efoli-0.0.1/.github/workflows/dev_test.yml

@@ -0,0 +1,28 @@
+name: "Test Dev Environment"
+# Checks that the dev environment (tox -e dev) can be set up.
+# This might not work, if different linting/testing envs refer to different versions of the same lib (e.g. typing-extensions).
+# Different versions of the same package might work for isolated specific envs (only linting, only testing...) but the dev environment inherits from all of them.
+on:
+  push:
+    branches: [main]
+  pull_request: {}
+jobs:
+  check:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12"]
+        os: [ubuntu-latest]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install Dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install tox
+      - name: Create a Dev Environment
+        run: |
+          tox -e dev

efoli-0.0.1/.github/workflows/formatting.yml

@@ -0,0 +1,27 @@
+name: "Formatting"
+
+on:
+  push:
+    branches: [main]
+  pull_request: {}
+jobs:
+  black:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: ["3.12"]
+        os: [ubuntu-latest]
+        tool: ["black", "isort"]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r dev_requirements/requirements-formatting.txt
+      - name: ${{ matrix.tool }} Code Formatter
+        run: |
+          ${{ matrix.tool }} . --check

efoli-0.0.1/.github/workflows/no_byte_order_mark.yml

@@ -0,0 +1,15 @@
+name: Prevent ByteOrderMarks
+
+on:
+  push:
+    branches:
+      - main
+  pull_request: {}
+
+jobs:
+  bom-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: arma-actions/bom-check@v1
+        name: Check for BOM

efoli-0.0.1/.github/workflows/packaging_test.yml

@@ -0,0 +1,26 @@
+name: "Packaging Test"
+
+on:
+  push:
+    branches: [main]
+  pull_request: {}
+jobs:
+  check_packaging:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: ["3.12"]
+        os: [ubuntu-latest]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install tox
+      - name: Run Packaging Test
+        run: |
+          tox -e test_packaging

efoli-0.0.1/.github/workflows/python-publish.yml

@@ -0,0 +1,61 @@
+# This GitHub workflow is only needed for python package releases which are supposed to be published on pypi.
+# It requires the Github "environments" feature (see instructions below) it might not be available for private free accounts (but works for public or organization repos).
+# After creating the "release" environment in the Github repo settings, you need to enter your Github organization/user name + repo name + "python-publish.yml" workflow file name in the PyPI UI to make this work.
+
+# This workflow uploads a Python Package using Twine when a release is created.
+# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [ created, edited ]
+
+jobs:
+  tests:
+    if: startsWith(github.ref, 'refs/tags/v')
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: [ "3.12" ]
+        os: [ ubuntu-latest ]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install tox
+        run: |
+          python -m pip install --upgrade pip
+          pip install tox
+      - name: Run tox
+        run: |
+          tox
+
+  build-n-publish:
+    name: Build and publish Python 🐍 distributions 📦 to PyPI and TestPyPI
+    runs-on: ubuntu-latest
+    # Specifying a GitHub environment, # Specifying a GitHub environment, which is strongly recommended by PyPI: https://docs.pypi.org/trusted-publishers/adding-a-publisher/
+    # you have to create an environment in your repository settings and add the environment name here
+    environment: release
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+    needs: tests
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r dev_requirements/requirements-packaging.txt
+      - name: Build wheel and source distributions
+        run: |
+          python -m build
+      - name: Publish distribution 📦 to PyPI
+        if: startsWith(github.ref, 'refs/tags/v')
+        uses: pypa/gh-action-pypi-publish@release/v1

efoli-0.0.1/.github/workflows/pythonlint.yml

@@ -0,0 +1,28 @@
+name: "Linting"
+
+on:
+  push:
+    branches: [main]
+  pull_request: {}
+jobs:
+  pylint:
+    name: Python Code Quality and Lint
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: ["3.12"]
+        os: [ubuntu-latest]
+        linter-env: ["linting", "type_check", "spell_check"]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install Dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install tox
+      - name: Run ${{ matrix.linter-env }} via Tox
+        run: |
+          tox -e ${{ matrix.linter-env }}

efoli-0.0.1/.github/workflows/unittests.yml

@@ -0,0 +1,26 @@
+name: "Unittests"
+
+on:
+  push:
+    branches: [main]
+  pull_request: {}
+jobs:
+  pytest:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12"]
+        os: [ubuntu-latest]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install Dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install tox
+      - name: Run the Unit Tests via Tox
+        run: |
+          tox -e tests

efoli-0.0.1/.gitignore

@@ -0,0 +1,136 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+.idea/
+
+# vscode settings
+.vscode/
+
+src/_your_package_version.py

efoli-0.0.1/.pre-commit-config.yaml

@@ -0,0 +1,24 @@
+# to update all repo revisions just run: pre-commit autoupdate
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+  - repo: https://github.com/psf/black
+    rev: 23.9.1
+    hooks:
+      - id: black
+        language_version: python3
+  - repo: https://github.com/pycqa/isort
+    rev: 5.12.0
+    hooks:
+      - id: isort
+        name: isort (python)
+      - id: isort
+        name: isort (cython)
+        types: [cython]
+      - id: isort
+        name: isort (pyi)
+        types: [pyi]

efoli-0.0.1/PKG-INFO

@@ -0,0 +1,59 @@
+Metadata-Version: 2.3
+Name: efoli
+Version: 0.0.1
+Summary: Enums and related helper functions that model EDIFACT relevant data for German utilities
+Project-URL: Changelog, https://github.com/Hochfrequenz/efoli/releases
+Project-URL: Homepage, https://github.com/Hochfrequenz/efoli
+Author-email: Hochfrequenz Unternehmensberatung GmbH <info+github@hochfrequenz.de>
+License: MIT
+Keywords: bdew,edifact,enums
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+# 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 need 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.

efoli-0.0.1/README.md

@@ -0,0 +1,38 @@
+# 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 need 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.

efoli-0.0.1/dev_requirements/requirements-coverage.in

@@ -0,0 +1,2 @@
+# specific requirements for the tox coverage env
+coverage

efoli-0.0.1/dev_requirements/requirements-coverage.txt

@@ -0,0 +1,9 @@
+# SHA1:6dafbcf610e9f81897b65ee9142715ab2e793f9e
+#
+# This file is autogenerated by pip-compile-multi
+# To update, run:
+#
+#    pip-compile-multi
+#
+coverage==7.6.0
+    # via -r dev_requirements/requirements-coverage.in

efoli-0.0.1/dev_requirements/requirements-formatting.in

@@ -0,0 +1,3 @@
+# specific requirements for the formatting envs
+black
+isort

efoli-0.0.1/dev_requirements/requirements-formatting.txt

@@ -0,0 +1,21 @@
+# SHA1:2c7ffcd29222de3114c7f7994911f1b69d06b6b3
+#
+# This file is autogenerated by pip-compile-multi
+# To update, run:
+#
+#    pip-compile-multi
+#
+black==24.4.2
+    # via -r dev_requirements/requirements-formatting.in
+click==8.1.7
+    # via black
+isort==5.13.2
+    # via -r dev_requirements/requirements-formatting.in
+mypy-extensions==1.0.0
+    # via black
+packaging==24.0
+    # via black
+pathspec==0.12.1
+    # via black
+platformdirs==4.2.0
+    # via black

efoli-0.0.1/dev_requirements/requirements-linting.in

@@ -0,0 +1,2 @@
+# specific requirements for the tox linting env
+pylint

efoli-0.0.1/dev_requirements/requirements-linting.txt

@@ -0,0 +1,21 @@
+# SHA1:0e15f8789b9d62fe90d1f1b0b6a7e32f13b99b19
+#
+# This file is autogenerated by pip-compile-multi
+# To update, run:
+#
+#    pip-compile-multi
+#
+astroid==3.2.4
+    # via pylint
+dill==0.3.8
+    # via pylint
+isort==5.13.2
+    # via pylint
+mccabe==0.7.0
+    # via pylint
+platformdirs==4.2.0
+    # via pylint
+pylint==3.2.6
+    # via -r dev_requirements/requirements-linting.in
+tomlkit==0.12.4
+    # via pylint

efoli-0.0.1/dev_requirements/requirements-packaging.in

@@ -0,0 +1,3 @@
+# requirements for the hatchling build ssystem
+build
+twine

efoli-0.0.1/dev_requirements/requirements-packaging.txt

@@ -0,0 +1,72 @@
+#
+# This file is autogenerated by pip-compile with Python 3.12
+# by the following command:
+#
+#    pip-compile dev_requirements/requirements-packaging.in
+#
+build==1.2.1
+    # via -r requirements-packaging.in
+certifi==2024.7.4
+    # via requests
+cffi==1.16.0
+    # via cryptography
+charset-normalizer==3.3.2
+    # via requests
+cryptography==42.0.5
+    # via secretstorage
+docutils==0.20.1
+    # via readme-renderer
+idna==3.7
+    # via requests
+importlib-metadata==7.0.2
+    # via twine
+jaraco-classes==3.3.1
+    # via keyring
+jeepney==0.8.0
+    # via
+    #   keyring
+    #   secretstorage
+keyring==24.3.1
+    # via twine
+markdown-it-py==3.0.0
+    # via rich
+mdurl==0.1.2
+    # via markdown-it-py
+more-itertools==10.2.0
+    # via jaraco-classes
+nh3==0.2.15
+    # via readme-renderer
+packaging==24.0
+    # via build
+pkginfo==1.10.0
+    # via twine
+pycparser==2.21
+    # via cffi
+pygments==2.17.2
+    # via
+    #   readme-renderer
+    #   rich
+pyproject-hooks==1.0.0
+    # via build
+readme-renderer==43.0
+    # via twine
+requests==2.32.0
+    # via
+    #   requests-toolbelt
+    #   twine
+requests-toolbelt==1.0.0
+    # via twine
+rfc3986==2.0.0
+    # via twine
+rich==13.7.1
+    # via twine
+secretstorage==3.3.3
+    # via keyring
+twine==5.1.1
+    # via -r requirements-packaging.in
+urllib3==2.2.2
+    # via
+    #   requests
+    #   twine
+zipp==3.19.1
+    # via importlib-metadata

efoli-0.0.1/dev_requirements/requirements-spell_check.in

@@ -0,0 +1 @@
+codespell

efoli-0.0.1/dev_requirements/requirements-spell_check.txt

@@ -0,0 +1,9 @@
+# SHA1:a7062511e9640ed2a5c2dea1da5c8b5f59c0f0d7
+#
+# This file is autogenerated by pip-compile-multi
+# To update, run:
+#
+#    pip-compile-multi
+#
+codespell==2.3.0
+    # via -r dev_requirements/requirements-spell_check.in

efoli-0.0.1/dev_requirements/requirements-tests.in

@@ -0,0 +1,2 @@
+# specific requirements for the tox tests env
+pytest

efoli-0.0.1/dev_requirements/requirements-tests.txt

@@ -0,0 +1,15 @@
+# SHA1:0eaa389e1fdb3a1917c0f987514bd561be5718ee
+#
+# This file is autogenerated by pip-compile-multi
+# To update, run:
+#
+#    pip-compile-multi
+#
+iniconfig==2.0.0
+    # via pytest
+packaging==24.0
+    # via pytest
+pluggy==1.5.0
+    # via pytest
+pytest==8.3.2
+    # via -r dev_requirements/requirements-tests.in

efoli-0.0.1/dev_requirements/requirements-type_check.in

@@ -0,0 +1,2 @@
+# specific requirements for the tox type_check environment
+mypy

efoli-0.0.1/dev_requirements/requirements-type_check.txt

@@ -0,0 +1,13 @@
+# SHA1:7983aaa01d64547827c20395d77e248c41b2572f
+#
+# This file is autogenerated by pip-compile-multi
+# To update, run:
+#
+#    pip-compile-multi
+#
+mypy==1.11.1
+    # via -r dev_requirements/requirements-type_check.in
+mypy-extensions==1.0.0
+    # via mypy
+typing-extensions==4.10.0
+    # via mypy

efoli-0.0.1/domain-specific-terms.txt

@@ -0,0 +1,2 @@
+# contains 1 lower case word per line which are ignored in the spell_check
+contrl

efoli-0.0.1/pyproject.toml

@@ -0,0 +1,65 @@
+[project]
+name = "efoli"
+description = "Enums and related helper functions that model EDIFACT relevant data for German utilities"
+license = { text = "MIT" }
+requires-python = ">=3.11"
+authors = [{ name = "Hochfrequenz Unternehmensberatung GmbH", email = "info+github@hochfrequenz.de" }]
+keywords = ["edifact", "enums", "bdew"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+dependencies = []     # add all the dependencies here
+dynamic = ["readme", "version"]
+
+[project.urls]
+Changelog = "https://github.com/Hochfrequenz/efoli/releases"
+Homepage = "https://github.com/Hochfrequenz/efoli"
+
+[tool.black]
+line-length = 120
+target_version = ["py311", "py312"]
+
+[tool.isort]
+line_length = 120
+profile = "black"
+
+[tool.pylint."MESSAGES CONTROL"]
+max-line-length = 120
+
+[mypy]
+truethy-bool = true
+
+[tool.mypy]
+disable_error_code = []
+
+[build-system]
+requires = ["hatchling>=1.8.0", "hatch-vcs", "hatch-fancy-pypi-readme"]
+build-backend = "hatchling.build"
+
+[tool.hatch.metadata.hooks.fancy-pypi-readme]
+content-type = "text/markdown"
+fragments = [{ path = "README.md" }]
+
+[tool.hatch.version]
+source = "vcs"
+
+[tool.hatch.build.hooks.vcs]
+version-file = "src/_efoli_version.py"
+template = '''
+version = "{version}"
+'''
+
+[tool.hatch.build.targets.sdist]
+exclude = ["/unittests"]
+
+[tool.hatch.build.targets.wheel]
+only-include = ["src"]
+sources = ["src"]

efoli-0.0.1/requirements.txt

@@ -0,0 +1,6 @@
+#
+# This file is autogenerated by pip-compile with Python 3.11
+# by the following command:
+#
+#    pip-compile pyproject.toml
+#

efoli-0.0.1/src/_efoli_version.py

@@ -0,0 +1 @@
+version = "0.0.1"

efoli-0.0.1/src/efoli/__init__.py

@@ -0,0 +1,14 @@
+"""
+efoli contains enums and related helper functions for EDIFACT formats and format versions
+"""
+
+from .edifact_format import EdifactFormat, get_format_of_pruefidentifikator
+from .edifact_format_version import EdifactFormatVersion, get_current_edifact_format_version, get_edifact_format_version
+
+__all__ = [
+    "EdifactFormat",
+    "get_format_of_pruefidentifikator",
+    "EdifactFormatVersion",
+    "get_current_edifact_format_version",
+    "get_edifact_format_version",
+]

efoli-0.0.1/src/efoli/edifact_format.py

@@ -0,0 +1,78 @@
+"""
+contains the EdifactFormat enum and helper methods
+"""
+
+import re
+from enum import StrEnum
+
+_PRUEFI_REGEX = r"^[1-9]\d{4}$"
+pruefidentifikator_pattern = re.compile(_PRUEFI_REGEX)
+
+
+# pylint: disable=too-few-public-methods
+class EdifactFormat(StrEnum):
+    """
+    existing EDIFACT formats
+    """
+
+    APERAK = "APERAK"
+    COMDIS = "COMDIS"  #: communication dispute
+    CONTRL = "CONTRL"  #: control messages
+    IFTSTA = "IFTSTA"  #: Multimodaler Statusbericht
+    INSRPT = "INSRPT"  #: Prüfbericht
+    INVOIC = "INVOIC"  #: invoice
+    MSCONS = "MSCONS"  #: meter readings
+    ORDCHG = "ORDCHG"  #: changing an order
+    ORDERS = "ORDERS"  #: orders
+    ORDRSP = "ORDRSP"  #: orders response
+    PRICAT = "PRICAT"  #: price catalogue
+    QUOTES = "QUOTES"  #: quotes
+    REMADV = "REMADV"  #: zahlungsavis
+    REQOTE = "REQOTE"  #: request quote
+    PARTIN = "PARTIN"  #: market partner data
+    UTILMD = "UTILMD"  #: utilities master data
+    UTILMDG = "UTILMDG"  #: utilities master data for 'Gas'
+    UTILMDS = "UTILMDS"  #: utilities master data for 'Strom'
+    UTILMDW = "UTILMDW"  #: utilities master data 'Wasser'
+    UTILTS = "UTILTS"  #: formula
+
+    def __str__(self) -> str:
+        return self.value
+
+
+_edifact_mapping: dict[str, EdifactFormat] = {
+    "99": EdifactFormat.APERAK,
+    "29": EdifactFormat.COMDIS,
+    "21": EdifactFormat.IFTSTA,
+    "23": EdifactFormat.INSRPT,
+    "31": EdifactFormat.INVOIC,
+    "13": EdifactFormat.MSCONS,
+    "39": EdifactFormat.ORDCHG,
+    "17": EdifactFormat.ORDERS,
+    "19": EdifactFormat.ORDRSP,
+    "27": EdifactFormat.PRICAT,
+    "15": EdifactFormat.QUOTES,
+    "33": EdifactFormat.REMADV,
+    "35": EdifactFormat.REQOTE,
+    "37": EdifactFormat.PARTIN,
+    "11": EdifactFormat.UTILMD,
+    "25": EdifactFormat.UTILTS,
+    "91": EdifactFormat.CONTRL,
+    "92": EdifactFormat.APERAK,
+    "44": EdifactFormat.UTILMD,  # UTILMD for GAS since FV2310
+    "55": EdifactFormat.UTILMD,  # UTILMD for STROM since FV2310
+}
+
+
+def get_format_of_pruefidentifikator(pruefidentifikator: str) -> EdifactFormat:
+    """
+    returns the format corresponding to a given pruefi
+    """
+    if not pruefidentifikator:
+        raise ValueError("The pruefidentifikator must not be falsy")
+    if not pruefidentifikator_pattern.match(pruefidentifikator):
+        raise ValueError(f"The pruefidentifikator '{pruefidentifikator}' is invalid.")
+    try:
+        return _edifact_mapping[pruefidentifikator[:2]]
+    except KeyError as key_error:
+        raise ValueError(f"No Edifact format was found for pruefidentifikator '{pruefidentifikator}'.") from key_error

efoli-0.0.1/src/efoli/edifact_format_version.py

@@ -0,0 +1,61 @@
+"""contains the EdifactFormatVersion enum"""
+
+import datetime
+from enum import StrEnum
+
+
+class EdifactFormatVersion(StrEnum):
+    """
+    One format version refers to the period in which an AHB is valid.
+    """
+
+    FV2104 = "FV2104"  #: valid from 2021-04-01 until 2021-10-01
+    FV2110 = "FV2110"  #: valid from 2021-10-01 until 2022-04-01
+    FV2210 = "FV2210"  #: valid from 2022-10-01 onwards ("MaKo 2022", was 2204 previously)
+    FV2304 = "FV2304"  #: valid from 2023-04-01 onwards
+    FV2310 = "FV2310"  #: valid from 2023-10-01 onwards
+    FV2404 = "FV2404"  #: valid from 2024-04-01 onwards
+    FV2410 = "FV2410"  #: valid from 2024-10-01 onwards
+    FV2504 = "FV2504"  #: valid from 2025-04-04 onwards
+    FV2510 = "FV2510"  #: valid from 2025-10-01 onwards
+    # whenever you add another value here, please also make sure to add its key date to get_edifact_format_version below
+
+    def __str__(self) -> str:
+        return self.value
+
+
+def get_edifact_format_version(key_date: datetime.datetime) -> EdifactFormatVersion:
+    """
+    Retrieves the appropriate Edifact format version applicable for the given key date.
+
+    This function determines the correct Edifact format version by comparing the provided key date
+    against a series of predefined datetime thresholds. Each threshold corresponds to a specific
+    version of the Edifact format.
+
+    :param key_date: The date for which the Edifact format version is to be determined.
+    :return: The Edifact format version valid for the specified key date.
+    """
+    format_version_thresholds = [
+        (datetime.datetime(2021, 9, 30, 22, 0, 0, 0, tzinfo=datetime.timezone.utc), EdifactFormatVersion.FV2104),
+        (datetime.datetime(2022, 9, 30, 22, 0, 0, 0, tzinfo=datetime.timezone.utc), EdifactFormatVersion.FV2110),
+        (datetime.datetime(2023, 3, 31, 22, 0, 0, 0, tzinfo=datetime.timezone.utc), EdifactFormatVersion.FV2210),
+        (datetime.datetime(2023, 9, 30, 22, 0, 0, 0, tzinfo=datetime.timezone.utc), EdifactFormatVersion.FV2304),
+        (datetime.datetime(2024, 4, 2, 22, 0, 0, 0, tzinfo=datetime.timezone.utc), EdifactFormatVersion.FV2310),
+        (datetime.datetime(2024, 9, 30, 22, 0, 0, 0, tzinfo=datetime.timezone.utc), EdifactFormatVersion.FV2404),
+        (datetime.datetime(2025, 4, 3, 22, 0, 0, 0, tzinfo=datetime.timezone.utc), EdifactFormatVersion.FV2410),
+        (datetime.datetime(2025, 9, 30, 22, 0, 0, 0, tzinfo=datetime.timezone.utc), EdifactFormatVersion.FV2504),
+    ]
+
+    for threshold_date, version in format_version_thresholds:
+        if key_date < threshold_date:
+            return version
+
+    return EdifactFormatVersion.FV2510
+
+
+def get_current_edifact_format_version() -> EdifactFormatVersion:
+    """
+    returns the edifact_format_version that is valid as of now
+    """
+    tz_aware_now = datetime.datetime.utcnow().replace(tzinfo=datetime.timezone.utc)
+    return get_edifact_format_version(tz_aware_now)

efoli-0.0.1/src/efoli/py.typed

@@ -0,0 +1,2 @@
+# This file marks mypackage as PEP561 compatible.
+# Further reading: https://mypy.readthedocs.io/en/stable/installed_packages.html#creating-pep-561-compatible-packages

efoli-0.0.1/tox.ini

@@ -0,0 +1,95 @@
+[tox]
+envlist =
+    tests
+    linting
+    coverage
+    type_check
+skip_missing_interpreters = True
+skipsdist = True
+
+[testenv]
+commands = python -m pip install --upgrade pip
+
+[testenv:tests]
+# the tests environment is called by the Github action that runs the unit tests
+deps =
+    -r requirements.txt
+    -r dev_requirements/requirements-tests.txt
+setenv = PYTHONPATH = {toxinidir}/src
+commands = python -m pytest --basetemp={envtmpdir} {posargs}
+
+[testenv:linting]
+# the linting environment is called by the Github Action that runs the linter
+deps =
+    {[testenv:tests]deps}
+    -r dev_requirements/requirements-linting.txt
+    # add your fixtures like e.g. pytest_datafiles here
+setenv = PYTHONPATH = {toxinidir}/src
+commands =
+    pylint efoli
+    pylint unittests --rcfile=unittests/.pylintrc
+    # add single files (ending with .py) or packages here
+
+[testenv:type_check]
+# the type_check environment checks the type hints using mypy
+setenv = PYTHONPATH = {toxinidir}/src
+deps =
+    {[testenv:tests]deps}
+    -r dev_requirements/requirements-type_check.txt
+commands =
+    mypy --show-error-codes src/efoli --strict
+    mypy --show-error-codes unittests --strict
+    # add single files (ending with .py) or packages here
+
+[testenv:spell_check]
+# the spellcheck environment checks the code for typos
+setenv = PYTHONPATH = {toxinidir}/src
+deps =
+    -r requirements.txt
+    -r dev_requirements/requirements-spell_check.txt
+commands =
+    codespell --ignore-words=domain-specific-terms.txt src
+    codespell --ignore-words=domain-specific-terms.txt README.md
+    # add single files (ending with .py) or packages here
+
+[testenv:coverage]
+# the coverage environment is called by the Github Action that runs the coverage measurement
+changedir = unittests
+deps =
+    {[testenv:tests]deps}
+    -r dev_requirements/requirements-coverage.txt
+setenv = PYTHONPATH = {toxinidir}/src
+commands =
+    coverage run -m pytest --basetemp={envtmpdir} {posargs}
+    coverage html --omit .tox/*,unittests/*
+    coverage report --fail-under 80 --omit .tox/*,unittests/*
+
+[testenv:compile_requirements]
+deps =
+    pip-compile-multi
+commands =
+    pip-compile-multi -d dev_requirements --autoresolve
+
+[testenv:dev]
+# the dev environment contains everything you need to start developing on your local machine.
+deps =
+    {[testenv:tests]deps}
+    {[testenv:linting]deps}
+    {[testenv:type_check]deps}
+    {[testenv:coverage]deps}
+    {[testenv:spell_check]deps}
+    -r dev_requirements/requirements-formatting.txt
+    pip-tools
+    pre-commit
+commands =
+    python -m pip install --upgrade pip
+    pip install -r requirements.txt
+    pre-commit install
+
+[testenv:test_packaging]
+skip_install = true
+deps =
+    -r dev_requirements/requirements-packaging.txt
+commands =
+    python -m build
+    twine check dist/*