my description of the package
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-pyby
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.5.tar.gz
(2.9 kB
view details)
Built Distribution
File details
Details for the file mermaid_py-0.1.5.tar.gz
.
File metadata
- Download URL: mermaid_py-0.1.5.tar.gz
- Upload date:
- Size: 2.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.6.1 CPython/3.11.6 Linux/6.2.0-1015-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | aaec4cb87498c1d63c1ce352821f06e81b0d51834a2e1200e6d8388e8f25a1c2 |
|
MD5 | 99737d2b899bccaab9cd3733c3b75c9a |
|
BLAKE2b-256 | 18872584efc20d02436e4cc45c3e9cd0e948ad80ea813a22acca97bf0cb34163 |
File details
Details for the file mermaid_py-0.1.5-py3-none-any.whl
.
File metadata
- Download URL: mermaid_py-0.1.5-py3-none-any.whl
- Upload date:
- Size: 3.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.6.1 CPython/3.11.6 Linux/6.2.0-1015-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6cf87e2241d3d62d6c024da422a284d0c82f5417db0f9d62fc258ae4e8377991 |
|
MD5 | a6e11d3d6ca75123c3dad776632dc31c |
|
BLAKE2b-256 | a4ce7db39e6f95db9c68922aff9f6cc4068bebf26fd5887628f61d66958abf2f |