pandas-mermaid 0.2.0

Convert pandas DataFrame to Mermaid flowcharts

README.md

# pandas-mermaid

Convert a **pandas DataFrame** into a **Mermaid flowchart** definition.

## 📦 Installation

Install from **PyPI**:

```bash
pip install pandas-mermaid

Or install the latest development version from GitHub:

pip install git+https://github.com/raghuvasanthrao/pandas-mermaid.git

🚀 Usage

import pandas as pd
import pandas_mermaid.converter as pdm

# Create a sample DataFrame
df = pd.DataFrame({
    'Name': ['Node1', 'Node2', 'Node3'],
    'Value': [10, 20, 30],
})

# Convert DataFrame to Mermaid flowchart (Left-to-Right)
mermaid_chart = pdm.df_to_mermaid(df, direction="LR") #LR TB

# Print the Mermaid definition
print(mermaid_chart)

Output:

flowchart LR
    node0[Name: Node1, Value: 10]
    node1[Name: Node2, Value: 20]
    node2[Name: Node3, Value: 30]
    node0 --> node1
    node1 --> node2

You can paste the above output into Mermaid Live Editor to visualize the flowchart.

📄 License

This project is licensed under the MIT License.

---

If you want, I can also **add a rendered Mermaid diagram directly into the README** so that when someone views your GitHub page, they’ll see the flowchart without leaving the page. That would make the repo look even more appealing.  

Do you want me to add that?