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
Briefly describe your project here. Explain what it does and what makes it special.
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;
A-->B;
A-->C;
B-->D;
C-->D;""")
graphe: Mermaid = Mermaid(graph)
graphe # !! note this work just in notbooke that render html.
the result will be like this
graph TD;
A-->B;
A-->C;
B-->D;
C-->D;
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 :) .
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
mermaid_py-0.1.6.tar.gz
(3.1 kB
view hashes)
Built Distribution
Close
Hashes for mermaid_py-0.1.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 63292dfbb41e21e69457e1e8b84ac14919a4a58e6c19cf3b0f4e1b5cff2e062a |
|
MD5 | f21c27d91b677b2f4a364fb6e392390f |
|
BLAKE2b-256 | 68926d3671a49481b3764427d95ce08769babea1626a6b484620a896636dd43e |