A simple interface for the the famous lib mermaid-js to create diagrams.
Project description
Mermaid-py
this package works as an interface for the famous mermaid-js library that uses scripts to create diagrams.
Description
mermaid-py is a dynamic Python library designed to serve as a seamless interface for the renowned Mermaid library. Built upon the powerful capabilities of Python, mermaid-py empowers developers and data enthusiasts to effortlessly create stunning diagrams, flowcharts, and visualizations directly within their Python environments.
Examples
first install mermaid-py
by pip install mermaid-py
.
import mermaid as md
from mermaid.graph import Graph
graph: Graph = Graph('first-graph',"""
graph TD;
mer(Mermaid)
flow(FlowChart);
clas(ClassDiagram)
gra(Graph)
erDigram(ERDiagram)
erdiagram-link(Link)
entity(Entity)
flow-link(Link)
node(Node)
mer --> flow
mer --> clas
mer --> gra
mer --> erDigram
flow --> node & flow-link
erDigram --> entity & erdiagram-link
""")
graphe: md.Mermaid = md.Mermaid(graph)
graphe # !! note this work just in notbooke that render html.
the result will be like this
graph TD;
mer(Mermaid)
flow(FlowChart);
clas(ClassDiagram)
gra(Graph)
erDigram(ERDiagram)
pie(PieDiagram)
reqDiagram(RequiremntDiagram)
userj(UserJourney)
erdiagram-link(Link)
entity(Entity)
flow-link(Link)
node(Node)
requiremnt(Requiremnt)
element(Element)
actor(Actor)
section(Section)
task(Task)
mer --> flow & clas & gra & erDigram & pie & reqDiagram & userj
flow --> node & flow-link
erDigram --> entity & erdiagram-link
reqDiagram --> requiremnt & element
userj --> actor & section & task
Technologies Used
- Python3
- Poetry
To contribute to mermaid-py
If you'd like to contribute to this open source project folow this steps:
- Forke the repo and then clone it.
- Navigate to the project directory:
cd mermaid-py
. - create a local enviroment
python3 -m venv env
. - activate the env
source env/bin/activate
. - install the dependecies
poetry install
. - happy coding :) .
List of Diagrames
-
FlowChart -
Sequence Diagram - Class Diagram
-
State Diagram -
Entity Relationship Diagram -
User Journey - Gantt
-
Pie Chart - Quadrant Chart
-
Requirement Diagram - Gitgraph (Git) Diagram 🔥
- C4 Diagram 🦺⚠️
- Mindmaps 🔥
- Timeline 🔥
- Zenuml 🔥
- Sankey 🔥
- XYChart 🔥
License
This project is licensed under the MIT License.
Contact
If you have any questions or want to get in touch, you can reach out to me at rachidouhammou21@gmail.com.
Project details
Release history Release notifications | RSS feed
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
Hashes for mermaid_py-0.2.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 64e36f05b7e2e8f0607d2cf3a8619d4b8241b67bd2444672f736a959d6206134 |
|
MD5 | 2b9ce3e5753a631369186a4e4bddb522 |
|
BLAKE2b-256 | 38b2304cb3cdebb1d0a4d43ca02b4ea2bf4eb986c19cefada0d34f3d2c60fda3 |