Dynnammo / python_mermaid

Python-Mermaid

This modules aims to implement a simple way for developers/admin-sys/devops to create on-the-fly Mermaid diagrams.

✅ Use of this module when:

• keeping up-to-date diagrams about systems that can can be discovered with automated scripts :
  • architecture of a server (packages, services,...)
  • architecture of a folder (files and subfolders,...)
• keeping up-to-date diagrams about a data-visualization tool (like Metabase, Lightdash etc.)
  • list of collections and indicators with their links for modification

❌ Do not use this module for

• making a single instance diagram that doesn't need to be updated : documentation, presentation etc.

Installation

pip install python_mermaid

How to use

All examples are available here

Run the script below to see diagram generation

# Creating a simple flowchart diagram
from python_mermaid.diagram import (
    MermaidDiagram,
    Node,
    Link
)

# Family members
meg = Node("Meg")
jo = Node("Jo")
beth = Node("Beth")
amy = Node("Amy")
robert = Node("Robert March")

the_march_family = [meg, jo, beth, amy, robert]

# Create links
family_links = [
    Link(robert, meg),
    Link(robert, jo),
    Link(robert, beth),
    Link(robert, amy),
]

chart = MermaidDiagram(
    title="Little Women",
    nodes=the_march_family,
    links=family_links
)

print(chart)

Returns the following

---
title: Little Women
---
graph 
meg["Meg"]
jo["Jo"]
beth["Beth"]
amy["Amy"]
robert_march["Robert March"]
robert_march ---> meg
robert_march ---> jo
robert_march ---> beth
robert_march ---> amy

which results can be seen here

Roadmap

October 2023

1-to-1 implementation of flowchart

• All features of flowchart
  • Chart title
  • Nodes shapes
  • Links between nodes
  • Subgraph
    • Links between nodes with subgraphs
    • Directions (#24)
  • Interaction
  • Styling and classes (#19 and #20)
  • Basic support for fontawesome (#23)

November 2023

• Main Features of stateflow-v2
  • Nodes
  • Notes
  • Start and End nodes
  • Named links between nodes
  • Graph configuration

End 2023

• Architecture improvements for easing diagram creation

Development

• Requirements: install Poetry. Here is the official method below. ⚠️ Please consider getting a look at Poetry's documentation if it doesn't work. ⚠️

curl -sSL https://install.python-poetry.org | python3 -

• All-in-one command below to clone and install dependencies

curl -sSL https://install.python-poetry.org | python3 -
git clone https://github.com/Dynnammo/python_mermaid
cd python_mermaid
poetry shell
poetry install --with dev

Quick commands

• Launch tests: poetry run pytest
• Check linting: poetry run ruff check .
• Check typing: poetry run mypy python_mermaid

To check linting:
```shell
poetry run flake8

This project comes with a tool called pre-commit that checks if your code is correctly linted. If you want to use it, run the following

pre-commit install

Contribute

Wanna help ? Find a bug ?

1. Do not hesitate to fork the repository and send PRs with your changes
2. No time to code ? Send a bug/feature issue here