Registry / serialization / mermaid-python

mermaid-python

library0.1pypypi✓ verified 85d ago

mermaid-python is a Python package (version 0.1) for generating diagrams using Mermaid JS. It allows you to define Mermaid diagrams as strings and render them into standalone HTML files. The project has not seen updates since its initial release over three years ago (March 2021), meaning it may not support newer Mermaid JS features or address recent issues. It is effectively abandoned.

serialization data

pip install mermaid-python

package ↗

INSTALL

IMPORT

SIG · MERMAID-PYTHON

mermaid-python

serializationpythonv0.1

Install

4.7s avg

Import

14ms

Disk

72MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v0.1 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.920 runs

installs and imports cleanly · install 0.0s · import 0.011s · 80.1MB

glibc

py 3.10–3.920 runs

installs and imports cleanly · install 4.7s · import 0.008s · 81MB

72MB installed

● package 72MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

Mermaid

✓ from mermaid import Mermaid

This quickstart demonstrates how to define a Mermaid graph using a string and render it into a standalone HTML file. The `Mermaid` class takes the diagram definition, and `to_file()` saves it. You then open the HTML file in a browser to see the rendered diagram.

from mermaid import Mermaid # Define your Mermaid diagram string diagram_code = """ graph TD; A[Start] --> B{Process?}; B -- Yes --> C[Do Something]; C --> D[End]; B -- No --> D; """ # Create a Mermaid object graph = Mermaid(diagram_code) # Render the diagram to an HTML file output_filename = "my_mermaid_diagram.html" graph.to_file(output_filename) print(f"Diagram saved to {output_filename}") # Open 'my_mermaid_diagram.html' in a web browser to view the diagram.

Debug

Known issues

gotchaThe mermaid-python project is effectively abandoned and has not been updated since its 0.1 release over three years ago (March 2021).

fix

Be aware that it may not support recent Mermaid JS features, syntax changes, or security fixes from newer Mermaid JS versions. Consider alternative, more actively maintained libraries, or directly using Mermaid JS with a dedicated CLI or web service.

affects: 0.1

gotchamermaid-python only renders diagrams to standalone HTML files.

fix

For direct SVG or PNG image output, you will need to open the generated HTML file in a headless browser (e.g., using Playwright, Selenium, or Puppeteer via a subprocess) and take a screenshot, or integrate with an external Mermaid CLI tool (like `mermaid-cli` or `@mermaid-js/mermaid-cli`).

affects: 0.1

gotchaIf the generated HTML file does not display your diagram, or shows a rendering error, it's almost always due to invalid Mermaid JS syntax in your input string.

fix

Validate your Mermaid diagram string using the official Mermaid Live Editor (https://mermaid.live/) before passing it to the `Mermaid()` constructor. Check the browser's developer console when opening the HTML file for Mermaid JS specific errors.

affects: 0.1

Errors

Common errors & fixes

ModuleNotFoundError: No module named 'mermaid'

The 'mermaid-python' library is not installed in your current Python environment, or the environment where you installed it is not active.

fix

Ensure you have installed the library correctly: `pip install mermaid-python`. If using virtual environments, activate the correct environment before running your script.

The generated HTML file is blank or contains only the Mermaid source code, not the diagram.

This usually indicates that the Mermaid JavaScript failed to render the diagram, most commonly due to invalid or malformed Mermaid diagram syntax in the input string.

fix

Verify your Mermaid diagram string for any syntax errors using the Mermaid Live Editor (https://mermaid.live/). Also, open the generated HTML file in a browser and check its developer console for JavaScript errors related to Mermaid.

FileNotFoundError: [Errno 2] No such file or directory: 'non_existent_path/my_diagram.html'

The path provided to `graph.to_file()` includes directories that do not exist.

fix

Ensure that the directory where you intend to save the HTML file exists. You can create it programmatically using `os.makedirs(os.path.dirname(output_filename), exist_ok=True)` before calling `to_file()`.

Upgrade

Version history

0.1latest on PyPI · released Apr 28, 2023

Audit

Dependencies

beautifulsoup4requiredUsed for parsing and manipulating HTML generated by Mermaid.

jinja2requiredUsed for templating the HTML output.

markdownrequiredUsed internally, likely for handling markdown within diagram definitions (though the core usage is direct Mermaid string).

Agent activity

4 hits · last 30 days

node

Resources

packagehttps://pypi.org/project/mermaid-python/ ↗