mermaiden

mermaiden generates deterministic Mermaid source from typed Python diagram models. It supports the Mermaid syntax families registered by the package and validates each diagram before rendering its text.

The package produces Mermaid text only. Render it with Mermaid in a browser, Markdown viewer, or your own CLI workflow.

Installation

Python 3.12 or later is required.

pip install mermaiden

Quick start

from mermaiden.application import Application

application = Application.create()
diagrams = application.available_diagrams()
print(diagrams)

Application.available_diagrams() returns the supported diagram catalog. Application.diagram_info(diagram_id) returns the typed diagram API for an individual syntax. CLI workflows are available through python -m mermaiden.cli.

Application API

Application is the boundary for API and persistence adapters. Create a diagram by Mermaid syntax id, apply a named domain command, and persist the JSON-safe snapshot returned by the application.

from mermaiden.application import Application, DiagramCommand

application = Application.create()
diagram = application.create_diagram("sequenceDiagram")
application.apply(diagram, DiagramCommand("add_participant", {"id": "api", "label": "API"}))

payload = application.snapshot(diagram).to_dict()
restored = application.restore(payload)
source = application.render(restored)

Snapshots have a versioned envelope and may be stored as JSON. Application.restore() validates restored state before returning it. Command argument values use the diagram operation names; JSON string values are accepted for enum arguments.

The caller can discover the REST contract without maintaining a manifest. diagram_description() returns JSON Schema for the diagram's elements, relations, annotations, and commands. command_payload() returns the generated Pydantic request model for one command.

description = application.diagram_description("sequenceDiagram")
payload_type = application.command_payload("sequenceDiagram", "add_participant")
payload = payload_type.model_validate({"id": "api", "kind": "control"})

Development

The repository uses a single host-mode CI target:

make ci

It installs the development dependencies, runs linting, type checks, tests, compatibility validation, Mermaid CLI rendering, and wheel validation. To open the locally generated diagram preview, run:

make diagrams-test

Release

Releases are versioned by annotated vX.Y.Z tags. After make ci passes, create and push the tag, then publish the GitHub release:

git tag -a v2.0.0 -m "v2.0.0"
git push origin v2.0.0
gh release create v2.0.0 --verify-tag --generate-notes --title v2.0.0

Development Status
- 3 - Alpha
Intended Audience
- Developers
License
- OSI Approved :: MIT License
Programming Language
- Python :: 3
- Python :: 3 :: Only
Typing
- Typed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mermaiden-4.0.0.tar.gz (78.4 kB view details)

Uploaded Aug 24, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

mermaiden-4.0.0-py3-none-any.whl (159.3 kB view details)

Uploaded Aug 24, 2026 Python 3

File details

Details for the file mermaiden-4.0.0.tar.gz.

File metadata

Download URL: mermaiden-4.0.0.tar.gz
Upload date: Aug 24, 2026
Size: 78.4 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for mermaiden-4.0.0.tar.gz
Algorithm	Hash digest
SHA256	`d172aee9226df36974aa9bf3dd23f95988010d75436083b0a6a0855f15f2ee68`
MD5	`6ac593a800ef8972d40c5f22708d113f`
BLAKE2b-256	`f58310d2cae74b0a8893b2137b3196401c39d3ace209925aeb04f3eefbbf1b2b`

See more details on using hashes here.

Provenance

The following attestation bundles were made for mermaiden-4.0.0.tar.gz:

Publisher: release.yml on szpak-dev/mermaiden

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: mermaiden-4.0.0.tar.gz
- Subject digest: d172aee9226df36974aa9bf3dd23f95988010d75436083b0a6a0855f15f2ee68
- Sigstore transparency entry: 2581098042
- Sigstore integration time: Aug 24, 2026
Source repository:
- Permalink: szpak-dev/mermaiden@54f34d8b5bc463b7fdabbc2cb1abff96c19a64f7
- Branch / Tag: refs/tags/v4.0.0
- Owner: https://github.com/szpak-dev
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yml@54f34d8b5bc463b7fdabbc2cb1abff96c19a64f7
- Trigger Event: release