mermaid-py 0.1.6

A simple interface for the the famous lib mermaid-js to create diagrams.

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:

1. Forke the repo and then clone it.
2. Navigate to the project directory: cd mermaid-py.
3. create a local enviroment python3 -m venv env.
4. activate the env source env/bin/activate.
5. install the dependecies poetry install.
6. 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 [e-mail].