🎉 Initial PR

.gitignore

@@ -132,3 +132,13 @@ dmypy.json
 
 # vscode settings
 .vscode/
+
+# document folders
+documents/
+backup_documents/
+
+# output files
+*.xlsx
+*.csv
+*.json
+*.7z

README.md

@@ -1,66 +1,139 @@
-# Python Template Repository including Tox.ini, Unittests, Linting Actions and Coverage Measurements
-<!--- you need to replace the `organization/repo_name` in the status badge URLs --->
-![Unittests status badge](https://github.com/Hochfrequenz/python_template_repository/workflows/Unittests/badge.svg)
-![Coverage status badge](https://github.com/Hochfrequenz/python_template_repository/workflows/Coverage/badge.svg)
-![Linting status badge](https://github.com/Hochfrequenz/python_template_repository/workflows/Linting/badge.svg)
-![Black status badge](https://github.com/Hochfrequenz/python_template_repository/workflows/Black/badge.svg)
-
-This is a template repository. It doesn't contain any useful code but only a minimal working setup for a Python project including:
-
-+ a basic **project structure** with
-    + tox.ini
-    + requirements.in
-    + and a requirements.txt derived from it
-    + an example class
-    + an example unit test (using pytest)
-+ ready to use **Github Actions** for
-    + [pytest](https://pytest.org)
-    + [code coverage measurement](https://coverage.readthedocs.io) (fails below 80% by default)
-    + [pylint](https://pylint.org/) (only accepts 10/10 code rating by default)
-    + [black](https://github.com/psf/black) code formatter check
-      using [lgeiger/black-action](https://github.com/lgeiger/black-action)
-
-By default it uses Python version 3.9.
-
-## How to use this Repository on Your Machine
-
-This introduction assumes that you have tox installed already (
-see [installation instructions](https://tox.readthedocs.io/en/latest/install.html)) and that a `.toxbase` environment
-has been created.
-
-If this is the case, clone this repository and create the `dev` environment on your machine.
+# AHB Extractor
+![Unittests status badge](https://github.com/Hochfrequenz/AHBExtractor/workflows/Unittests/badge.svg)
+![Coverage status badge](https://github.com/Hochfrequenz/AHBExtractor/workflows/Coverage/badge.svg)
+![Linting status badge](https://github.com/Hochfrequenz/AHBExtractor/workflows/Linting/badge.svg)
+![Black status badge](https://github.com/Hochfrequenz/AHBExtractor/workflows/Black/badge.svg)
 
+
+This tool helps to generate machine readable files from tables inside docx documents.
+
+## Installation
+The AHB Extractor is a Python based tool. Therefor you have to make sure, that Python is running on your machine.
+### Plain
+
+Create a new virtual environment
 ```bash
-tox -e dev
+python -m venv .venv
+```
+Activate it
+#### Windows
+```
+.venv\Scripts\activate
+```
+#### MacOS/Linux
+```
+source .venv/bin/activate
 ```
 
-### How to use with PyCharm
-
-1. Create a new project using existing sources with your local working copy of this repository as root directory. Choose
-   the path `your_repo/.tox/dev/` as path of the "previously configured interpreter".
-2. Set the
-   default [test runner of your project](https://www.jetbrains.com/help/pycharm/choosing-your-testing-framework.html) to
-   pytest.
-3. Set
-   the [working directory of the unit tests](https://www.jetbrains.com/help/pycharm/creating-run-debug-configuration-for-tests.html)
-   to the project root (instead of the unittest directory)
-
-### How to use with VS Code
-
-1. Open the folder with VS Code.
-2. **Select the python interpreter** which is created by tox. Open the command pallett with `CTRL + P` and type `Python: Select Interpreter`. Select the interpreter which is placed in `.tox/dev/Scripts/python.exe` under Windows or `.tox/dev/bin/python` under Linux and macOS.
-3. **Setup pytest and pylint**. Therefore we open the file `.vscode/settings.json` which should be automatically generated during the interpreter setup. Insert the following lines into the settings:
-```json
-    "python.testing.unittestEnabled": false,
-    "python.testing.nosetestsEnabled": false,
-    "python.testing.pytestEnabled": true,
-    "pythonTestExplorer.testFramework": "pytest",
-    "python.testing.pytestArgs": [
-        "unittests"
-    ],
-    "python.linting.pylintEnabled": true
+Install the requirements with
+```
+pip install -r requirements.txt
+```
+Done.
+### With tox
+If tox is installed system-wide, then you can just run
+```
+tox
+```
+in the root directory.
+
+## Execution
+
+At the moment you have to define the filename of the AHB you want to extract in [`ahbextractor\ahbextractor.py`](./ahbextractor/ahbextractor.py).
+
+If the filename is set, you can run the script with
+```bash
+python -m ahbextractor
+```
+You should see some output like this in your terminal
 ```
-4. Enjoy 🤗
+🔍 Extracting Pruefidentifikatoren: 11039, 11040, 11041
+💥 The Excel file 11039.xlsx is open. Please close this file and try again.
+💾 Saved file for Pruefidentifikator 11040
+💾 Saved file for Pruefidentifikator 11041
+```
+
+## PDF Dokumente
+
+The following sections give a short overview where to find the start and end for the Formate.
+
+## APERAK (Fehlermeldung)
+* Datei: `CONTRL_APERAK_AHB_2_3h_20201016.pdf`
+* Start: `4.2 Tabellarische Darstellung der APERAK`
+* Ende einschließlich: `4.2 Tabellarische Darstellung der APERAK`
+
+## IFTSTA (Infomeldung)
+* Dateiname: `IFTSTA_AHB_2_0b_20201016.pdf`
+* Start: `4.1 Übermittlung des Status des Gesamtvorgangs im Rahmen des MSB-Wechsels 1/2`
+* Ende einschließlich: `4.9 Information zur Ablehnung eines Angebots oder einer Anfrage`
+
+## INSRPT (Prüfbericht)
+* Datei: `INSRPT_AHB_1_1f_Lesefassung_20191002.pdf`
+* Start: `3.1 Anwendungsfälle: Störungsmeldung, Ablehnung bzw. Bestätigung der Störungsmeldung und Ergebnisbericht`
+* Ende einschließlich: `3.3 Anwendungsfälle: Informationsmeldungen des MSB in der Sparte Strom`
+
+## INVOIC (Rechnung)
+* Datei: `INVOIC_REMADV_AHB_2_4_Lesefassung_20200701.pdf`
+* Start: `2.1.1 Abschlags-, NN-, WiM- und MSB-Rechnung`
+* Ende einschließlich: `2.1.4 Kapazitätsrechnung`
+* Start: `3.1 Anwendungsfälle REMADV`
+* Ende einschließlich: `3.1 Anwendungsfälle REMADV`
+## MSCONS (Messwerte und Zählerstände)
+* Datei: `MSCONS_AHB_2_3c_20201001_v2.pdf`
+* Start: `4.2 Anwendungsübersicht Messwert Lastgang`
+* Ende einschließlich: `4.2 Anwendungsübersicht Messwert Lastgang`
+* Start: `4.4 Anwendungsübersicht Messwert Energiemenge`
+* Ende einschließlich: `4.4 Anwendungsübersicht Messwert Energiemenge`
+* Start: `4.6 Anwendungsübersicht Messwert Zählerstand`
+* Ende einschließlich: `4.6 Anwendungsübersicht Messwert Zählerstand`
+* Start: `4.8 Anwendungsübersicht Messwert Storno`
+* Ende einschließlich: `4.8 Anwendungsübersicht Messwert Storno`
+* Start: `4.10Anwendungsübersicht Bilanzkreissummen`
+* Ende einschließlich: `4.10Anwendungsübersicht Bilanzkreissummen`
+* Start: `4.12Anwendungsübersicht Normiertes Profil / Profilschar / Vergangenheitsw. TEP`
+* Ende eischließlich: `4.12Anwendungsübersicht Normiertes Profil / Profilschar / Vergangenheitsw. TEP`
+* Start: `4.14Anwendungsübersicht EEG-Überführungszeitreihen`
+* Ende einschließlich: `4.14Anwendungsübersicht EEG-Überführungszeitreihen`
+* Start: `4.16Anwendungsübersicht Gasbeschaffenheitsdaten`
+* Ende einschließlich: `4.16Anwendungsübersicht Gasbeschaffenheitsdaten`
+* Start: `4.18Anwendungsübersicht Allokationsliste Gas / bilanzierte Menge Strom/Gas`
+* Ende einschließlich: `4.18Anwendungsübersicht Allokationsliste Gas / bilanzierte Menge Strom/Gas`
+* Start: `4.20Anwendungsübersicht Bewegungsdaten im Kalenderjahr vor Lieferbeginn`
+* Ende einschließlich: `4.20Anwendungsübersicht Bewegungsdaten im Kalenderjahr vor Lieferbeginn`
+* Start: `4.22Anwendungsübersicht Energiemenge und Leistungsmaximum`
+* Ende einschließlich: `4.22Anwendungsübersicht Energiemenge und Leistungsmaximum`
+
+## ORDERS (Bestellung)
+* Datei: `REQOTE_QUOTES_ORDERS_ORDRSP_AHB_1_0c_20201001.pdf`
+* Start: `3.1.1 Anfrage zur Übermittlung von Stammdaten im Initialprozess`
+* Ende einschließlich: `3.5 Reklamation von Werten/Lastgängen`
+* Start: `3.6.1 Anforderung eines Geräteübernahmeangebots (REQOTE)`
+* Ende einschließlich: `3.10.4 Bestätigung bzw. Ablehnung der Beendigung der Rechnungsabwicklung des Messstellenbetriebs über den LF (ORDRSP`
+
+## ORDRSP (Bestellantwort)
+* Datei: `REQOTE_QUOTES_ORDERS_ORDRSP_AHB_1_0c_20201001.pdf`
+* selbe Datei wie `ORDERS (Bestellung)`
+* Start: ``
+* Ende einschließlich: ``
+
+## QUOTES (Angebot)
+* Datei: `REQOTE_QUOTES_ORDERS_ORDRSP_AHB_1_0c_20201001.pdf`
+* selbe Datei wie `ORDERS (Bestellung)`
+* Start: ``
+* Ende einschließlich: ``
+
+## REQOTE (Anfrage)
+* Datei: `REQOTE_QUOTES_ORDERS_ORDRSP_AHB_1_0c_20201001.pdf`
+* selbe Datei wie `ORDERS (Bestellung)`
+* Start: ``
+* Ende einschließlich: ``
+
+## UTILMD (Stammdaten)
+* Datei: `UTILMD_AHB_Stammdatenänderung_1_1b_20201016.pdf`
+* Start: `8.1 Nicht bilanzierungsrelevante Änderung vom LF ohne Abhängigkeiten (jedes Stammdatum kann einzeln übermittelt werden)`
+* Ende einschließlich: `9.10 Anfrage zur Stammdatenänderung von ÜNB`
 
-## Contribute
-You are very welcome to contribute to this template repository by opening a pull request against the main branch.
+## UTILTS (Berechnungsformel)
+* Datei: `UTILTS_AHB_Berechnungsformel_1_0b_20201016.pdf`
+* Start: `4 Übermittlung der Berechnungsformel`
+* Ende einschließlich: `4 Übermittlung der Berechnungsformel`

ahbextractor/__main__.py

@@ -0,0 +1,12 @@
+"""
+This file makes the package itself executable.
+You can run it with:
+
+    python -m ahbextractor
+
+"""
+
+from ahbextractor import ahbextractor
+
+if __name__ == "__main__":
+    ahbextractor.main()

ahbextractor/ahbextractor.py

@@ -0,0 +1,40 @@
+"""
+Main script of the AHB Extractor
+"""
+
+from pathlib import Path
+
+import docx
+
+from ahbextractor.helper.read_functions import get_ahb_extract
+
+
+def main():
+    """
+    Main function of the module ahbextractor.
+    It reads the docx file and calls the function to extract all infos.
+    """
+
+    input_directory_path = Path.cwd() / "documents"
+    ahb_file_name = "UTILMD_AHB_WiM_3_1c_2021_04_01_2021_03_30.docx"
+    path_to_ahb_file = input_directory_path / ahb_file_name
+
+    output_directory_path = Path.cwd() / "output"
+    path_to_all_in_one_excel = output_directory_path / "xlsx" / f"{ahb_file_name[:-5]}.xlsx"
+
+    # Remove old "all in one excel file" if it already exists
+    if path_to_all_in_one_excel.exists():
+        path_to_all_in_one_excel.unlink(missing_ok=False)
+
+    try:
+        doc = docx.Document(path_to_ahb_file)  # Creating word reader object.
+
+    except IOError:
+        print("There was an error opening the file!")
+        return
+
+    get_ahb_extract(document=doc, output_directory_path=output_directory_path, ahb_file_name=ahb_file_name)
+
+
+if __name__ == "__main__":
+    main()