🧙‍♀️ Initial Setup (#1)

Author: hf-kklein

.github/workflows/codeql-analysis.yml

@@ -5,58 +5,57 @@
 # 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
+name: Upload Python Package
 
-# on:
-#   release:
-#     types: [created, edited]
+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
+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

.github/workflows/python-publish.yml

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

domain-specific-terms.txt

@@ -1,10 +1,10 @@
 [project]
-name = "your-favourite-package-name"
-description = "Description of your package"
+name = "bamx"
+description = "Python interface XML documents for MIG and AHBs, published by BDEW "
 license = { text = "MIT" }
 requires-python = ">=3.11"
-authors = [{ name = "your name", email = "[email protected]" }]
-keywords = ["your", "important", "keywords"]
+authors = [{ name = "Hochfrequenz Unternehmensberatung GmbH", email = "[email protected]" }]
+keywords = ["BDEW", "XML", "AHB", "MIG", "Marktkommunikation"]
 classifiers = [
     "Development Status :: 4 - Beta",
     "Environment :: Console",
@@ -20,8 +20,8 @@ dependencies = []     # add all the dependencies here
 dynamic = ["readme", "version"]
 
 [project.urls]
-Changelog = "https://github.com/Hochfrequenz/python_template_repository/releases"
-Homepage = "https://github.com/Hochfrequenz/python_template_repository"
+Changelog = "https://github.com/Hochfrequenz/bdew_ahb_mig_xml-python/releases"
+Homepage = "https://github.com/Hochfrequenz/bdew_ahb_mig_xml-python"
 
 [tool.black]
 line-length = 120
@@ -38,7 +38,7 @@ max-line-length = 120
 truethy-bool = true
 
 [tool.mypy]
-disable_error_code = ["no-untyped-def", "no-untyped-call"]
+disable_error_code = []
 
 [build-system]
 requires = ["hatchling>=1.8.0", "hatch-vcs", "hatch-fancy-pypi-readme"]
@@ -52,7 +52,7 @@ fragments = [{ path = "README.md" }]
 source = "vcs"
 
 [tool.hatch.build.hooks.vcs]
-version-file = "src/_your_package_version.py"
+version-file = "src/_bamx_version.py"
 template = '''
 version = "{version}"
 '''

pyproject.toml

@@ -0,0 +1 @@
+"""contains model classes representing MIGs and AHBs"""

src/mypackage/__init__.py renamed to src/bamx/__init__.py

@@ -0,0 +1,21 @@
+"""classes that represent MIGs"""
+
+from dataclasses import dataclass
+from datetime import date
+
+
+@dataclass(frozen=True, eq=True, order=True, unsafe_hash=True, kw_only=True)
+class MessageImplementationGuide:
+    """
+    message implementation guide (MIG)
+    """
+
+    veroeffentlichungsdatum: date
+    """
+    publishing date
+    """
+    autor: str
+    """author, most likely 'BDEW'"""
+
+    versionsnummer: str
+    """e.g. '1.1c'"""

src/bamx/models/__init__.py

@@ -0,0 +1,5 @@
+"""classes for reading xml documents"""
+
+from .migreader import MigReader
+
+__all__ = ["MigReader"]

src/bamx/models/messageimplementationguide.py

@@ -0,0 +1,53 @@
+"""
+This a docstring for the module.
+"""
+
+import xml.etree.ElementTree as ET
+from datetime import date, datetime
+from pathlib import Path
+
+from bamx.models.messageimplementationguide import MessageImplementationGuide
+
+
+class MigReader:
+    """
+    Accesses information from an XML based message implementation guide
+    """
+
+    def __init__(self, xml_path: Path):
+        """
+        initialize by providing the path to the XML file
+        """
+        self._xml_path = xml_path
+        self._element_tree = ET.parse(self._xml_path)
+
+    def get_publishing_date(self) -> date:
+        """
+        returns the publishing date of the message implementation guide
+        """
+        raw_value = self._element_tree.getroot().attrib["Veroeffentlichungsdatum"]  # e.g. '24.10.2023'
+        result = datetime.strptime(raw_value, "%d.%m.%Y").date()
+        return result
+
+    def get_author(self) -> str:
+        """
+        returns the author of the message implementation guide
+        """
+        return self._element_tree.getroot().attrib["Author"]
+
+    def get_version(self) -> str:
+        """
+        returns the version of the message implementation guide
+        """
+        return self._element_tree.getroot().attrib["Versionsnummer"]
+
+    def read(self) -> MessageImplementationGuide:
+        """
+        read the entire file and convert it to a MessageImplementationGuid instance
+        """
+        result = MessageImplementationGuide(
+            veroeffentlichungsdatum=self.get_publishing_date(),
+            autor=self.get_author(),
+            versionsnummer=self.get_version(),
+        )
+        return result