Metadata-Version: 2.4
Name: mitm-tooling
Version: 0.10.0
Author-email: Leah Tacke Genannt Unterberg <l.tgu@pads.rwth-aachen.de>
License: MIT License
        
        Copyright (c) 2025 Leah Tacke Genannt Unterberg, PADS RWTH Aachen University
        
        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.
License-File: LICENSE
Requires-Python: <3.14,>=3.12
Requires-Dist: alembic>=1.16
Requires-Dist: genson>=1.3.0
Requires-Dist: numpy>=2
Requires-Dist: pandas[compression,computation,performance]>=2.0
Requires-Dist: pydantic>=2.11
Requires-Dist: ruamel-yaml>=0.18
Requires-Dist: sqlalchemy-utils>=0.38.0
Requires-Dist: sqlalchemy>=2
Requires-Dist: stream-zip
Provides-Extra: pm
Requires-Dist: pm4py; extra == 'pm'
Description-Content-Type: text/markdown

# mitm-tooling

This python package contains basic functionality to work with "Models-in-the-Middle" (MitM) data sets.
It bundles a generic mechanism to load and export relational data as a configurable MitM.

## Package Structure

- `mitm_tooling/data_types`: Defines the basic attribute data types supported in MitMs.
- `mitm_tooling/definition`: Contains MitM definitions. Currently, only `MAED` is supported.
- `mitm_tooling/extraction/relational`: Functionality for mapping and (virtually) transforming relational databases.
  This is
  used by
  the [maed\[/mitm\]-exporter-backend](https://git-ce.rwth-aachen.de/machine-data/maed-exporter/maed-exporter-backend).
- `mitm_tooling/extraction/anything`: An environment for applying the above to (relatively) arbitrary data sources.
- `mitm_tooling/representation`: Defines different representations of MitM data. From the proposed zipped format to
  dataframes and a relational DB representation.
    - `/sql`: Defines the relational representation along with utilities for inserting any (mapped) MitM data, by
      essentially executing a (streamable) ETL pipeline.
- `mitm_tooling/transformation`: Functionality for converting different representations into each other. Also contains
    - `/superset`: Functionality for generating superset-importable definitions, particularly programmatically defined
      dynamic dashboards. This is used by
      the [superset-mitm-service](https://git-ce.rwth-aachen.de/machine-data/superset-mitm-service).
- `mitm_tooling/io`: Im/Export functionality.
- `mitm_tooling/utilities`: Some utility functions.

For more details, consider the API documentation:

<a href="https://machine-data.pages.git-ce.rwth-aachen.de/mitm-tooling/" style="display:inline-block;padding:10px 20px;background:#0078d4;color:#fff;border-radius:6px;text-decoration:none;font-weight:bold;">
  <img src="https://cdn.jsdelivr.net/npm/@fortawesome/fontawesome-free@6.4.2/svgs/solid/book.svg" alt="API Docs" width="24" height="24" style="vertical-align:middle;margin-right:8px;">
  Package Docs
</a>

## Extension Points

1. Adding new MitMs via a `.yaml` definition.
2. Adding transformation capabilities to/from other formats.
3. Adding new model-specific visualization creators (e.g.,
   `mitm_tooling/transformation/superset/visualizations/maed/dashboards.py`)
4. Extending the relational representation with more mutation capabilities (e.g., instance updates).