{"library":"mermaid-builder","title":"Mermaid Builder","description":"Mermaid Builder is a Python library designed to programmatically generate MermaidJS markup, facilitating the creation of various diagrams like flowcharts and sequence diagrams from Python code. It allows developers to script the creation of MermaidJS definitions, which can then be rendered in compatible environments such as Markdown files, GitHub, or online Mermaid playgrounds. The library is in early development, with its current version being 0.0.3, indicating rapid iteration and ongoing feature additions.","language":"python","status":"active","last_verified":"Sun May 17","install":{"commands":["pip install mermaid-builder"],"cli":null},"imports":["from mermaid_builder.flowchart import Chart","from mermaid_builder.flowchart import Node"],"auth":{"required":false,"env_vars":[]},"quickstart":{"code":"from mermaid_builder.flowchart import Chart, Node\n\n# Create a new flowchart\nchart = Chart(\"MyCompanyHierarchy\", direction=\"TD\") # Top Down direction\n\n# Add nodes\nnode_a = Node(\"Company A\")\nnode_b = Node(\"Company B\")\nnode_c = Node(\"Company C\")\nnode_d = Node(\"Company D\")\n\nchart.add_node(node_a)\nchart.add_node(node_b)\nchart.add_node(node_c)\nchart.add_node(node_d)\n\n# Define relationships\nchart.link(node_a, node_b)\nchart.link(node_a, node_c)\nchart.link(node_b, node_d)\n\n# Generate the MermaidJS markup\nmermaid_markup = chart.render()\nprint(mermaid_markup)\n\n# To view this diagram, paste the output into a MermaidJS editor (e.g., mermaid.live)\n# or use in a Markdown file that supports Mermaid rendering (e.g., GitHub).","lang":"python","description":"This quickstart demonstrates how to create a simple flowchart using `mermaid-builder`. It initializes a `Chart`, adds `Node` objects, defines links between them, and then renders the MermaidJS markdown string. The generated string can be pasted into a MermaidJS compatible viewer or Markdown file to visualize the diagram.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":{"tag":null,"tag_description":null,"last_tested":"2026-05-17","installed_version":"0.0.3","pypi_latest":"0.0.3","is_stale":false,"summary":{"python_range":"3.10–3.9","success_rate":100,"avg_install_s":1.5,"avg_import_s":0.05,"wheel_type":"wheel"},"results":[{"runtime":"python:3.10-alpine","python_version":"3.10","os_libc":"alpine (musl)","variant":"mermaid-builder","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0.05,"mem_mb":2.2,"disk_size":"17.8M"},{"runtime":"python:3.10-slim","python_version":"3.10","os_libc":"slim (glibc)","variant":"mermaid-builder","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":1.5,"import_time_s":0.03,"mem_mb":2.2,"disk_size":"18M"},{"runtime":"python:3.11-alpine","python_version":"3.11","os_libc":"alpine (musl)","variant":"mermaid-builder","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0.08,"mem_mb":2.1,"disk_size":"19.6M"},{"runtime":"python:3.11-slim","python_version":"3.11","os_libc":"slim (glibc)","variant":"mermaid-builder","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":1.5,"import_time_s":0.06,"mem_mb":2.1,"disk_size":"20M"},{"runtime":"python:3.12-alpine","python_version":"3.12","os_libc":"alpine (musl)","variant":"mermaid-builder","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0.06,"mem_mb":1.9,"disk_size":"11.5M"},{"runtime":"python:3.12-slim","python_version":"3.12","os_libc":"slim (glibc)","variant":"mermaid-builder","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":1.4,"import_time_s":0.06,"mem_mb":1.9,"disk_size":"12M"},{"runtime":"python:3.13-alpine","python_version":"3.13","os_libc":"alpine (musl)","variant":"mermaid-builder","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0.06,"mem_mb":2.2,"disk_size":"11.3M"},{"runtime":"python:3.13-slim","python_version":"3.13","os_libc":"slim (glibc)","variant":"mermaid-builder","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":1.4,"import_time_s":0.05,"mem_mb":2,"disk_size":"12M"},{"runtime":"python:3.9-alpine","python_version":"3.9","os_libc":"alpine (musl)","variant":"mermaid-builder","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0.04,"mem_mb":2.1,"disk_size":"17.3M"},{"runtime":"python:3.9-slim","python_version":"3.9","os_libc":"slim (glibc)","variant":"mermaid-builder","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":1.7,"import_time_s":0.04,"mem_mb":2.1,"disk_size":"18M"}]}}