makoralle 🪸
makoralle provides pydantic models for the German
MaKo (Marktkommunikation) processes together with serializers that turn those
models into the output formats used downstream:
- YAML – process and EBD (Entscheidungsbaum-Diagramm) representations
- WSD – the websequencediagrams DSL for sequence diagrams
- BPMN – business process model XML
- Markdown – human-readable process documentation
It is the shared, dependency-light foundation (only pydantic and PyYAML) consumed by
the private makorele parser and by the process-documentation webapp.
Separation of concerns
Part of the Hochfrequenz MaKo tooling — four repositories, one responsibility each:
- makoralle (public, PyPI) — the data model + serializers. ← this repo
- makorele (private) — the parser (BDEW PDFs → validated models).
- machine-readable_mako-prozesse (private) — the generated dataset, consumed at a pinned tag.
- mako_prozesse — the web app that presents the dataset.
Dependencies flow one way: makorele → makoralle; the dataset is produced by the tooling and consumed by the web app at a pinned tag. makoralle imports neither the parser nor the app.
Installation
pip install makoralle
Usage
The public serialization API is exposed at the package root and resolved lazily
(importing makoralle, or a light submodule like makoralle.grouping, does not
eagerly pull in the serialization stack):
from makoralle import emit_yaml, emit_wsd, emit_markdown, emit_bpmn
from makoralle.models.process import Process
# build or load a Process model, then serialize it
yaml_text = emit_yaml(process)
wsd_text = emit_wsd(process.sequence_diagrams[0])
The models live under makoralle.models (process, ebd, pid, activity, chunk)
and the serializers under makoralle.serialization.
Development
This project uses the Hochfrequenz src-layout Python template
with uv. To set up a development environment:
uv sync --group dev
Run the unit tests, linting, type checks and coverage (matching what CI runs):
uv run --group tests pytest
uv run --group linting ruff check src/makoralle unittests
uv run --group linting ruff format --check .
uv run --group type_check mypy --strict src/makoralle
uv run --group type_check mypy --strict unittests
cd unittests && uv run --group coverage coverage run -m pytest && cd ..
2 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file makoralle-0.0.5.tar.gz.
File metadata
- Download URL: makoralle-0.0.5.tar.gz
- Upload date:
- Size: 91.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
00219f5163f9a8bcf741637ed470cc0dcad66dfd1086f00d322d48d1f8110dfb
|
|
| MD5 |
f2afc491edc0aa62f1beefe47e8de6b7
|
|
| BLAKE2b-256 |
3d7a2c42aae7bdffd492ef59bc710be030d58c584d9a109400aac1abd43d5b49
|
Provenance
The following attestation bundles were made for makoralle-0.0.5.tar.gz:
Publisher:
python-publish.yml on Hochfrequenz/makoralle
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
makoralle-0.0.5.tar.gz -
Subject digest:
00219f5163f9a8bcf741637ed470cc0dcad66dfd1086f00d322d48d1f8110dfb - Sigstore transparency entry: 2514391689
- Sigstore integration time:
-
Permalink:
Hochfrequenz/makoralle@260b62bd035ebb89c6c1e9364e1cc2952007b71d -
Branch / Tag:
refs/tags/v0.0.5 - Owner: https://github.com/Hochfrequenz
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python-publish.yml@260b62bd035ebb89c6c1e9364e1cc2952007b71d -
Trigger Event:
release
-
Statement type:
File details
Details for the file makoralle-0.0.5-py3-none-any.whl.
File metadata
- Download URL: makoralle-0.0.5-py3-none-any.whl
- Upload date:
- Size: 43.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
88f7b02ca2ceaea7664afbf1c52079c4cccde32de0f63b0493dc3783272efcd8
|
|
| MD5 |
33e44d07f749659a509086d83a0c3f48
|
|
| BLAKE2b-256 |
811151616fcf20f519499f32a272b4ec19150511924916097781726929257f70
|
Provenance
The following attestation bundles were made for makoralle-0.0.5-py3-none-any.whl:
Publisher:
python-publish.yml on Hochfrequenz/makoralle
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
makoralle-0.0.5-py3-none-any.whl -
Subject digest:
88f7b02ca2ceaea7664afbf1c52079c4cccde32de0f63b0493dc3783272efcd8 - Sigstore transparency entry: 2514391707
- Sigstore integration time:
-
Permalink:
Hochfrequenz/makoralle@260b62bd035ebb89c6c1e9364e1cc2952007b71d -
Branch / Tag:
refs/tags/v0.0.5 - Owner: https://github.com/Hochfrequenz
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python-publish.yml@260b62bd035ebb89c6c1e9364e1cc2952007b71d -
Trigger Event:
release
-
Statement type:
