A (quite) simple that helps creating on-the-fly Mermaid diagrams
Project description
Python-Mermaid
This modules aims to implement a simple way for developers/admin-sys/devops to create on-the-fly Mermaid diagrams.
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
Check issues for more information
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
To launch tests:
poetry run pytest
To check linting:
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 ?
- Do not hesitate to fork the repository and send PRs with your changes
- No time to code ? Send a bug/feature issue here
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
python_mermaid-0.1.3.tar.gz
(16.9 kB
view hashes)
Built Distribution
Close
Hashes for python_mermaid-0.1.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7d283d98b21b97feb428593905fb8b35e4cd8dbd038aa3ef1e09118d4a91ea89 |
|
MD5 | e6a09988b6080a9d8ed18edb3958857e |
|
BLAKE2b-256 | 320e0cfafb065fa97132c61fd7d086e29aa94e62e51028d4577ef08dcd13dae7 |