bpmn-lib 4.0.5__tar.gz

bpmn_lib-4.0.5/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Hennig IT Consulting GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

bpmn_lib-4.0.5/PKG-INFO

@@ -0,0 +1,129 @@
+Metadata-Version: 2.4
+Name: bpmn-lib
+Version: 4.0.5
+Summary: BPMN Process Navigation Library
+Author-email: Hennig IT Consulting GmbH <contact@hennig-it-consulting.de>
+License: MIT License
+        
+        Copyright (c) 2026 Hennig IT Consulting GmbH
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/hennig-ai/bpmn-lib
+Project-URL: Repository, https://github.com/hennig-ai/bpmn-lib
+Project-URL: Issues, https://github.com/hennig-ai/bpmn-lib
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: basic-framework<4.0.0,>=3.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=5.0.0; extra == "dev"
+Requires-Dist: pytest-xdist>=3.5.0; extra == "dev"
+Requires-Dist: pyright>=1.1.0; extra == "dev"
+Dynamic: license-file
+
+# bpmn-lib
+
+A Python library for navigating BPMN (Business Process Model and Notation) element hierarchies and managing in-memory process data. Designed for use in Python-based process automation and tooling pipelines.
+
+## What it does
+
+bpmn-lib lets you load a BPMN process model from markdown-defined schemas and data files, then navigate it programmatically:
+
+- Traverse parent-child element hierarchies (e.g. `bpmn_element → activity → task → user_task`)
+- Navigate sequence flows forward and backward
+- Query element attributes across inheritance chains
+- Resolve data associations (inputs/outputs)
+- Validate element type specificity and FK constraints
+
+## Installation
+
+```bash
+pip install bpmn-lib
+```
+
+Install with dev dependencies (for development):
+
+```bash
+pip install -e ".[dev]"
+```
+
+## Quick Start
+
+```python
+from bpmn_lib.navigator.navigator_factory import create_navigator
+
+navigator = create_navigator(
+    schema_file="path/to/schema.md",
+    data_file="path/to/data.md",
+    hierarchy_file="path/to/hierarchy.md",
+    log_dir="path/to/logs",
+    schema_name="My BPMN Schema"
+)
+
+# Navigate sequence flows
+next_elements = navigator.next_elements_in_flow(element_id)
+
+# Get all elements in a process
+elements = navigator.get_process_elements(process_id)
+
+# Read an attribute (traverses inheritance chain)
+value = navigator.get_element_attribute(element_id, "attribute_name")
+```
+
+## Architecture
+
+```
+┌─────────────────────────────────────┐
+│         Navigation Layer            │  ← BPMNHierarchyNavigator
+├─────────────────────────────────────┤
+│     Database Instance Layer         │  ← DatabaseInstance, DatabaseBuilder
+├─────────────────────────────────────┤
+│       Database Schema Layer         │  ← DatabaseSchema, TableDefinition
+├─────────────────────────────────────┤
+│          Parsing Layer              │  ← DatabaseSchemaParser, MarkdownDocument
+└─────────────────────────────────────┘
+```
+
+Schema definitions and instance data are loaded from markdown files. The factory function orchestrates the full pipeline: parse schema → load data → validate constraints → build indexes → create navigator.
+
+## Testing
+
+```bash
+pytest tests/ -v
+pytest tests/unit/ -v
+pytest tests/integration/ -v
+pytest tests/ --cov=bpmn_lib --cov-report=term-missing
+```
+
+## License
+
+MIT — see [LICENSE](LICENSE)

bpmn_lib-4.0.5/README.md

@@ -0,0 +1,77 @@
+# bpmn-lib
+
+A Python library for navigating BPMN (Business Process Model and Notation) element hierarchies and managing in-memory process data. Designed for use in Python-based process automation and tooling pipelines.
+
+## What it does
+
+bpmn-lib lets you load a BPMN process model from markdown-defined schemas and data files, then navigate it programmatically:
+
+- Traverse parent-child element hierarchies (e.g. `bpmn_element → activity → task → user_task`)
+- Navigate sequence flows forward and backward
+- Query element attributes across inheritance chains
+- Resolve data associations (inputs/outputs)
+- Validate element type specificity and FK constraints
+
+## Installation
+
+```bash
+pip install bpmn-lib
+```
+
+Install with dev dependencies (for development):
+
+```bash
+pip install -e ".[dev]"
+```
+
+## Quick Start
+
+```python
+from bpmn_lib.navigator.navigator_factory import create_navigator
+
+navigator = create_navigator(
+    schema_file="path/to/schema.md",
+    data_file="path/to/data.md",
+    hierarchy_file="path/to/hierarchy.md",
+    log_dir="path/to/logs",
+    schema_name="My BPMN Schema"
+)
+
+# Navigate sequence flows
+next_elements = navigator.next_elements_in_flow(element_id)
+
+# Get all elements in a process
+elements = navigator.get_process_elements(process_id)
+
+# Read an attribute (traverses inheritance chain)
+value = navigator.get_element_attribute(element_id, "attribute_name")
+```
+
+## Architecture
+
+```
+┌─────────────────────────────────────┐
+│         Navigation Layer            │  ← BPMNHierarchyNavigator
+├─────────────────────────────────────┤
+│     Database Instance Layer         │  ← DatabaseInstance, DatabaseBuilder
+├─────────────────────────────────────┤
+│       Database Schema Layer         │  ← DatabaseSchema, TableDefinition
+├─────────────────────────────────────┤
+│          Parsing Layer              │  ← DatabaseSchemaParser, MarkdownDocument
+└─────────────────────────────────────┘
+```
+
+Schema definitions and instance data are loaded from markdown files. The factory function orchestrates the full pipeline: parse schema → load data → validate constraints → build indexes → create navigator.
+
+## Testing
+
+```bash
+pytest tests/ -v
+pytest tests/unit/ -v
+pytest tests/integration/ -v
+pytest tests/ --cov=bpmn_lib --cov-report=term-missing
+```
+
+## License
+
+MIT — see [LICENSE](LICENSE)

bpmn_lib-4.0.5/pyproject.toml

@@ -0,0 +1,29 @@
+[build-system]
+requires = [ "setuptools>=45", "wheel",]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "bpmn-lib"
+version = "4.0.5"
+description = "BPMN Process Navigation Library"
+readme = "README.md"
+requires-python = ">=3.8"
+classifiers = [ "Development Status :: 4 - Beta", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.11", "Programming Language :: Python :: 3.12", "Programming Language :: Python :: 3.13", "Topic :: Software Development :: Libraries",]
+dependencies = [ "basic-framework>=3.0.0,<4.0.0",]
+[[project.authors]]
+name = "Hennig IT Consulting GmbH"
+email = "contact@hennig-it-consulting.de"
+
+[project.license]
+file = "LICENSE"
+
+[project.urls]
+Homepage = "https://github.com/hennig-ai/bpmn-lib"
+Repository = "https://github.com/hennig-ai/bpmn-lib"
+Issues = "https://github.com/hennig-ai/bpmn-lib"
+
+[project.optional-dependencies]
+dev = [ "pytest>=8.0.0", "pytest-cov>=5.0.0", "pytest-xdist>=3.5.0", "pyright>=1.1.0",]
+
+[tool.setuptools.packages.find]
+where = [ "src",]

bpmn_lib-4.0.5/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

bpmn_lib-4.0.5/src/bpmn_lib/__init__.py

@@ -0,0 +1,38 @@
+"""
+BPMN Process Navigation Library.
+
+This library provides classes for navigating and managing BPMN element hierarchies,
+database schema definitions, and validation utilities.
+"""
+
+from bpmn_lib.navigator.bpmn_hierarchy_navigator import BPMNHierarchyNavigator
+from bpmn_lib.database.instance.database_instance import DatabaseInstance
+from bpmn_lib.database.instance.database_builder import DatabaseBuilder
+from bpmn_lib.database.schema.database_schema import DatabaseSchema
+from bpmn_lib.database.schema.database_schema_parser import DatabaseSchemaParser
+from bpmn_lib.database.schema.table_definition import TableDefinition
+from bpmn_lib.database.schema.column_definition import ColumnDefinition
+from bpmn_lib.database.schema.foreign_key_relationship import ForeignKeyRelationship
+from bpmn_lib.utils.validation_result import ValidationResult
+from basic_framework import MarkdownDocument
+
+__all__ = [
+    # Navigator
+    "BPMNHierarchyNavigator",
+    # Database Instance
+    "DatabaseInstance",
+    "DatabaseBuilder",
+    # Database Schema
+    "DatabaseSchema",
+    "DatabaseSchemaParser",
+    "TableDefinition",
+    "ColumnDefinition",
+    "ForeignKeyRelationship",
+    # Utils
+    "ValidationResult",
+    "MarkdownDocument",
+]
+
+from importlib.metadata import version
+
+__version__: str = version("bpmn-lib")

bpmn_lib-4.0.5/src/bpmn_lib/database/__init__.py

@@ -0,0 +1,25 @@
+"""Database module for schema and instance management."""
+
+from bpmn_lib.database.schema.database_schema import DatabaseSchema
+from bpmn_lib.database.schema.database_schema_parser import DatabaseSchemaParser
+from bpmn_lib.database.schema.table_definition import TableDefinition
+from bpmn_lib.database.schema.column_definition import ColumnDefinition
+from bpmn_lib.database.schema.foreign_key_relationship import ForeignKeyRelationship
+from bpmn_lib.database.instance.database_instance import DatabaseInstance
+from bpmn_lib.database.instance.database_builder import DatabaseBuilder
+from bpmn_lib.database.instance.database_bulk_validator import DatabaseBulkValidator
+from bpmn_lib.database.instance.database_index_builder import DatabaseIndexBuilder
+
+__all__ = [
+    # Schema
+    "DatabaseSchema",
+    "DatabaseSchemaParser",
+    "TableDefinition",
+    "ColumnDefinition",
+    "ForeignKeyRelationship",
+    # Instance
+    "DatabaseInstance",
+    "DatabaseBuilder",
+    "DatabaseBulkValidator",
+    "DatabaseIndexBuilder",
+]

bpmn_lib-4.0.5/src/bpmn_lib/database/instance/__init__.py

@@ -0,0 +1,13 @@
+"""Database instance module."""
+
+from bpmn_lib.database.instance.database_instance import DatabaseInstance
+from bpmn_lib.database.instance.database_builder import DatabaseBuilder
+from bpmn_lib.database.instance.database_bulk_validator import DatabaseBulkValidator
+from bpmn_lib.database.instance.database_index_builder import DatabaseIndexBuilder
+
+__all__ = [
+    "DatabaseInstance",
+    "DatabaseBuilder",
+    "DatabaseBulkValidator",
+    "DatabaseIndexBuilder",
+]

bpmn_lib-4.0.5/src/bpmn_lib/database/instance/database_builder.py

@@ -0,0 +1,151 @@
+"""
+DatabaseBuilder - Koordiniert den Aufbau der Datenbank in Phasen.
+"""
+
+from typing import Dict
+from basic_framework.proc_frame import log_msg, log_and_raise
+from basic_framework.container_utils.container_in_memory import ContainerInMemory
+from basic_framework.container_utils.abstract_container import AbstractContainer
+from bpmn_lib.database.schema.database_schema import DatabaseSchema
+from bpmn_lib.database.instance.database_instance import DatabaseInstance
+from bpmn_lib.utils.validation_result import ValidationResult
+from bpmn_lib.database.instance.database_bulk_validator import DatabaseBulkValidator
+from bpmn_lib.database.instance.database_index_builder import DatabaseIndexBuilder
+
+
+class DatabaseBuilder:
+    """Koordiniert den Aufbau der Datenbank in Phasen."""
+
+    def __init__(self, schema: DatabaseSchema, result: ValidationResult) -> None:
+        """
+        Initialisiert den DatabaseBuilder.
+
+        Args:
+            schema: DatabaseSchema mit Tabellendefinitionen
+            result: ValidationResult für Fehlerberichte
+
+        Raises:
+            TypeError: Wenn schema oder result None ist (Python's Typsystem)
+        """
+        self._schema: DatabaseSchema = schema
+
+        # DatabaseInstance erstellen mit neuem Konstruktor
+        self._instance: DatabaseInstance = DatabaseInstance(self._schema)
+
+        # Validator und IndexBuilder erstellen mit neuen Konstruktoren
+        self._bulk_validator: DatabaseBulkValidator = DatabaseBulkValidator(self._instance, result)
+        self._index_builder: DatabaseIndexBuilder = DatabaseIndexBuilder(self._instance)
+
+        log_msg(f"DatabaseBuilder fuer Schema '{self._schema.get_schema_name()}' initialisiert.")
+
+    def load_all_data(self, o_data_source: Dict[str, ContainerInMemory]) -> None:
+        """Laedt alle Daten ohne Constraint-Pruefung."""
+        log_msg("Starte Bulk-Load der Daten...")
+        self._load_from_container_dictionary(o_data_source)
+
+    def _load_from_container_dictionary(self, o_container_dict: Dict[str, ContainerInMemory]) -> None:
+        """Laedt Daten aus einem Dictionary von ContainerInMemory-Objekten."""
+        n_total_rows = 0
+
+        # Fuer jede Tabelle im Dictionary
+        for v_table_name in o_container_dict.keys():
+            s_table_name = str(v_table_name)
+
+            # Pruefen ob Tabelle im Schema existiert
+            if not self._table_exists_in_schema(s_table_name):
+                log_msg(f"WARNUNG: Tabelle '{s_table_name}' existiert nicht im Schema und wird uebersprungen.")
+                continue
+
+            # Source Container holen
+            o_source_container = o_container_dict[s_table_name]
+
+            # Iterator fuer Source erstellen
+            o_source_iterator = o_source_container.create_iterator()
+
+            # Zeilen kopieren
+            n_row_count = 0
+
+            while not o_source_iterator.is_empty():
+                # Zeile in Ziel-Tabelle einfuegen
+                if self._instance.insert_row_from_iterator(s_table_name, o_source_iterator):
+                    n_row_count += 1
+
+                o_source_iterator.pp()
+
+                # Log-Nachricht alle 1000 Zeilen
+                if n_row_count % 1000 == 0:
+                    pass  # log_msg(f"Tabelle '{s_table_name}': {n_row_count} Zeilen geladen")
+
+            # log_msg(f"Tabelle '{s_table_name}': {n_row_count} Zeilen geladen.")
+            n_total_rows += n_row_count
+
+        # log_msg(f"Bulk-Load abgeschlossen. Insgesamt {n_total_rows} Zeilen geladen.")
+
+    def load_table_data(self, s_table_name: str, o_source_container: AbstractContainer) -> None:
+        """Laedt Daten fuer eine einzelne Tabelle."""
+        # Pruefen ob Tabelle im Schema existiert
+        if not self._table_exists_in_schema(s_table_name):
+            log_and_raise(f"Tabelle '{s_table_name}' existiert nicht im Schema.")
+
+        # log_msg(f"Lade Daten fuer Tabelle '{s_table_name}'...")
+
+        # Iterator fuer Source erstellen
+        o_source_iterator = o_source_container.create_iterator()
+
+        # Zeilen kopieren
+        n_row_count = 0
+
+        while not o_source_iterator.is_empty():
+            # Zeile in Ziel-Tabelle einfuegen
+            if self._instance.insert_row_from_iterator(s_table_name, o_source_iterator):
+                n_row_count += 1
+
+            o_source_iterator.pp()
+
+            # Log-Nachricht alle 1000 Zeilen
+            if n_row_count % 1000 == 0:
+                pass  # log_msg(f"Tabelle '{s_table_name}': {n_row_count} Zeilen geladen")
+
+        # log_msg(f"Tabelle '{s_table_name}': {n_row_count} Zeilen geladen.")
+
+    def validate_all_constraints(self) -> None:
+        """Prueft nachtraeglich alle Constraints."""
+        log_msg("Starte Validierung aller Constraints...")
+
+        # BulkValidator ausfuehren
+        self._bulk_validator.validate_all()
+
+    def build_indexes_if_valid(self) -> None:
+        """Erstellt Indizes nur bei erfolgreicher Validierung."""
+        # log_msg("Erstelle Indizes...")
+
+        # IndexBuilder ausfuehren
+        self._index_builder.build_all_indexes()
+
+        # log_msg("Indizes erfolgreich erstellt.")
+
+    def create_read_only_database(self) -> DatabaseInstance:
+        """Gibt fertige DatabaseInstance zurueck."""
+        # Pruefen ob alle Schritte durchgefuehrt wurden
+        if not self._instance.is_finalized():
+            log_and_raise("create_read_only_database: Indizes wurden nicht erstellt.")
+
+        # Instanz auf Read-Only setzen
+        self._instance.set_read_only()
+
+        log_msg("Read-Only Datenbank erfolgreich erstellt.")
+        return self._instance
+
+    def _table_exists_in_schema(self, s_table_name: str) -> bool:
+        """Hilfsmethode - Prueft ob Tabelle im Schema existiert."""
+        o_table_names = self._schema.get_table_names()
+
+        for v_name in o_table_names:
+            if str(v_name) == s_table_name:
+                return True
+
+        return False
+
+    def get_instance(self) -> DatabaseInstance:
+        """Gibt die DatabaseInstance zurueck (auch vor Finalisierung)."""
+        return self._instance