⚠ Rename: ebddocx2table is now ebdamame (#178)

Author: hf-kklein

.gitignore

@@ -133,4 +133,4 @@ dmypy.json
 # vscode settings
 .vscode/
 
-src/_ebddocx2table_version.py
+src/_ebdamame_version.py

README.md

@@ -1,27 +1,24 @@
-# ebddocx2table
+# ebdamame
 
-> [!IMPORTANT]
-⚠ This is the last version using the name `ebddocx2table`. Both the repository and the Python package will be renamed to `ebdamame`.
+![Unittests status badge](https://github.com/Hochfrequenz/ebdamame/workflows/Unittests/badge.svg)
+![Coverage status badge](https://github.com/Hochfrequenz/ebdamame/workflows/Coverage/badge.svg)
+![Linting status badge](https://github.com/Hochfrequenz/ebdamame/workflows/Linting/badge.svg)
+![Black status badge](https://github.com/Hochfrequenz/ebdamame/workflows/Black/badge.svg)
+![PyPi Status Badge](https://img.shields.io/pypi/v/ebdamame)
 
-![Unittests status badge](https://github.com/Hochfrequenz/ebd_docx_to_table/workflows/Unittests/badge.svg)
-![Coverage status badge](https://github.com/Hochfrequenz/ebd_docx_to_table/workflows/Coverage/badge.svg)
-![Linting status badge](https://github.com/Hochfrequenz/ebd_docx_to_table/workflows/Linting/badge.svg)
-![Black status badge](https://github.com/Hochfrequenz/ebd_docx_to_table/workflows/Black/badge.svg)
-![PyPi Status Badge](https://img.shields.io/pypi/v/ebddocx2table)
-
-🇩🇪 Dieses Repository enthält ein Python-Paket namens [`ebddocx2table`](https://pypi.org/project/ebddocx2table), das genutzt werden kann, um aus .docx-Dateien maschinenlesbare Tabellen, die einen Entscheidungsbaum (EBD) modellieren, zu extrahieren (scrapen).
+🇩🇪 Dieses Repository enthält ein Python-Paket namens [`ebdamame`](https://pypi.org/project/ebdamame) (früher: `ebddocx2table`), das genutzt werden kann, um aus .docx-Dateien maschinenlesbare Tabellen, die einen Entscheidungsbaum (EBD) modellieren, zu extrahieren (scrapen).
 Diese Entscheidungsbäume sind Teil eines regulatorischen Regelwerks für die deutsche Energiewirtschaft und kommen in der Eingangsprüfung der Marktkommunikation zum Einsatz.
 Die mit diesem Paket erstellten maschinenlesbaren Tabellen können mit [`ebdtable2graph`](https://pypi.org/project/ebdtable2graph) in echte Graphen und Diagramme umgewandelt werden.
 Exemplarische Ergebnisse des Scrapings finden sich als .json-Dateien im Repository [`machine-readable_entscheidungsbaumdiagramme`](https://github.com/Hochfrequenz/machine-readable_entscheidungsbaumdiagramme/).
 
-🇬🇧 This repository contains the source code of the Python package [`ebddocx2table`](https://pypi.org/project/ebddocx2table).
+🇬🇧 This repository contains the source code of the Python package [`ebdamame`](https://pypi.org/project/ebdamame) (formerly published as `ebddocx2table`).
 
 ## Rationale
 
-Assume, that you want to analyse or visualize the Entscheidungsbaumdiagramme (EBD) by EDI@Energy.
+Assume that you want to analyse or visualize the Entscheidungsbaumdiagramme (EBD) by EDI@Energy.
 The website edi-energy.de, as always, only provides you with PDF or Word files instead of _really_ digitized data.
 
-The package `ebddocx2table` scrapes the `.docx` files and returns data in a model defined in the "sister" package [`ebdtable2graph`](https://pypi.org/project/ebdtable2graph).
+The package `ebdamame` scrapes the `.docx` files and returns data in a model defined in the "sister" package [`ebdtable2graph`](https://pypi.org/project/ebdtable2graph).
 
 Once you scraped the data (using this package) you can plot it with [`ebdtable2graph`](https://pypi.org/project/ebdtable2graph).
 
@@ -30,7 +27,7 @@ Once you scraped the data (using this package) you can plot it with [`ebdtable2g
 In any case, install the repo from PyPI:
 
 ```bash
-pip install ebddocx2table
+pip install ebdamame
 ```
 
 ### Use as a library
@@ -41,8 +38,8 @@ from pathlib import Path
 
 import cattrs
 
-from ebddocx2table import TableNotFoundError, get_all_ebd_keys, get_ebd_docx_tables  # type:ignore[import]
-from ebddocx2table.docxtableconverter import DocxTableConverter  # type:ignore[import]
+from ebdamame import TableNotFoundError, get_all_ebd_keys, get_ebd_docx_tables  # type:ignore[import]
+from ebdamame.docxtableconverter import DocxTableConverter  # type:ignore[import]
 
 docx_file_path = Path("unittests/test_data/ebd20230629_v34.docx")
 # download this .docx File from edi-energy.de or find it in the unittests of this repository.

main.py

@@ -29,8 +29,8 @@
 from ebdtable2graph.plantuml import GraphTooComplexForPlantumlError
 
 # pylint:disable=import-error
-from ebddocx2table import TableNotFoundError, get_all_ebd_keys, get_ebd_docx_tables  # type:ignore[import]
-from ebddocx2table.docxtableconverter import DocxTableConverter  # type:ignore[import]
+from ebdamame import TableNotFoundError, get_all_ebd_keys, get_ebd_docx_tables  # type:ignore[import]
+from ebdamame.docxtableconverter import DocxTableConverter  # type:ignore[import]
 
 
 def _dump_puml(puml_path: Path, ebd_graph: EbdGraph) -> None:

pyproject.toml

@@ -1,5 +1,5 @@
 [project]
-name = "ebddocx2table"
+name = "ebdamame"
 description = "A scraper to library to scrape .docx files with 'Entscheidungsbaumdiagramm' tables into a truely machine readable structure"
 license = { text = "GPL" }
 requires-python = ">=3.11"
@@ -27,8 +27,8 @@ dependencies = [
 dynamic = ["readme", "version"]
 
 [project.urls]
-Changelog = "https://github.com/Hochfrequenz/ebddocx2table/releases"
-Homepage = "https://github.com/Hochfrequenz/ebddocx2table"
+Changelog = "https://github.com/Hochfrequenz/ebdamame/releases"
+Homepage = "https://github.com/Hochfrequenz/ebdamame"
 
 [tool.black]
 line-length = 120

src/_ebddocx2table_version.py

@@ -0,0 +1 @@
+version = "0.1.dev59+gc9c489e.d20230707"

src/ebddocx2table/__init__.py src/ebdamame/__init__.pysrc/ebddocx2table/__init__.py renamed to src/ebdamame/__init__.py

@@ -26,7 +26,7 @@ deps =
     # add your fixtures like e.g. pytest_datafiles here
 setenv = PYTHONPATH = {toxinidir}/src
 commands =
-    pylint ebddocx2table
+    pylint ebdamame
     pylint main.py
     # add single files (ending with .py) or packages here
 
@@ -37,7 +37,7 @@ deps =
     -r requirements.txt
     -r dev_requirements/requirements-type_check.txt
 commands =
-    mypy --show-error-codes src/ebddocx2table
+    mypy --show-error-codes src/ebdamame
     mypy --show-error-codes unittests
     mypy --show-error-codes main.py
     # add single files (ending with .py) or packages here

src/ebddocx2table/docxtableconverter.py src/ebdamame/docxtableconverter.pysrc/ebddocx2table/docxtableconverter.py renamed to src/ebdamame/docxtableconverter.py

@@ -9,28 +9,28 @@
 from docx import Document  # type:ignore[import]
 from docx.table import Table  # type:ignore[import]
 
-import ebddocx2table
+import ebdamame
 
 
 def get_document(datafiles, filename: str) -> Document:
     """
     a datafiles compatible wrapper around ebddocx2table.get_document
     """
     path = datafiles / Path(filename)
-    return ebddocx2table.get_document(path)
+    return ebdamame.get_document(path)
 
 
 def get_ebd_docx_tables(datafiles, filename: str, ebd_key: str) -> List[Table]:
     """
     a datafiles compatible wrapper around ebddocx2table.get_ebd_docx_tables
     """
     path = datafiles / Path(filename)
-    return ebddocx2table.get_ebd_docx_tables(path, ebd_key=ebd_key)
+    return ebdamame.get_ebd_docx_tables(path, ebd_key=ebd_key)
 
 
-def get_all_ebd_keys(datafiles, filename: str) -> Dict[str, Tuple[str, ebddocx2table.EbdChapterInformation]]:
+def get_all_ebd_keys(datafiles, filename: str) -> Dict[str, Tuple[str, ebdamame.EbdChapterInformation]]:
     """
     a datafiles compatible wrapper around ebddocx2table.get_all_ebd_keys
     """
     path = datafiles / Path(filename)
-    return ebddocx2table.get_all_ebd_keys(path)
+    return ebdamame.get_all_ebd_keys(path)