# alrasheeda/st-link-analysis architecture

> Architecture diagram of the GitHub repository alrasheeda/st-link-analysis, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-06-13). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/alrasheeda/st-link-analysis
- Repository: https://github.com/alrasheeda/st-link-analysis

## Overview

##### Project type and purpose
- This is a full-stack open-source Streamlit component (“st-link-analysis”) for interactive graph visualizations.
- Purpose: expose a Python API (st_link_analysis, NodeStyle, EdgeStyle) that wraps a Cytoscape.js-based frontend, enabling Streamlit apps to render and interact with link-analysis graphs.

##### File structure
Top-level:
- .github/ — CI templates & workflows (Node/Python builds, tests)
- examples/ — demo Streamlit apps and example data
- st_link_analysis/ — main package
– component/ — Python wrapper code (component.py, event definitions)
– frontend/ — JavaScript/Cytoscape.js code, webpack config, package.json
- tests/ — pytest test suite
- pyproject.toml, README.md, CHANGELOG.md, LICENSE

Architectural patterns:
- Separation of concerns: Python “backend” (Streamlit wrapper) vs. JS “frontend” (graph rendering)
- Build pipeline: npm/webpack compiles frontend; pip builds Python package

##### README for additional insights
- Describes API, features, setup steps for Python and Node, dev/test commands
- References Streamlit component bridge and Cytoscape.js as core technologies
- Mentions a Render deployment for the live demo

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Backend (Python)"
        direction TB
        App["Streamlit App"]:::python
        Wrapper["Python Wrapper"]:::python
        Events["Event Definitions"]:::python
        Icons["Icon Management"]:::python
        Layouts["Layout Configurations"]:::python
        Styles["NodeStyle/EdgeStyle"]:::python
        RPC["Streamlit Component API"]:::external
        App -->|"calls st_link_analysis() API"| Wrapper
        Wrapper -->|"uses events.py"| Events
        Wrapper -->|"uses icons.py"| Icons
        Wrapper -->|"uses layouts.py"| Layouts
        Wrapper -->|"uses styles.py"| Styles
        Wrapper -->|"invokes RPC"| RPC
    end

    subgraph "Frontend (JS/Cytoscape)"
        direction TB
        Webpack["Webpack Config"]:::js
        PackageJSON["package.json"]:::js
        HTML["index.html"]:::js
        EntryJS["index.js"]:::js
        StyleCSS["style.css"]:::js
        Renderer["Graph Renderer"]:::js
        Toolbar["Toolbar UI"]:::js
        InfoPanel["Info Panel UI"]:::js
        NodeActions["Node Actions UI"]:::js
        Viewbar["Viewbar UI"]:::js
        Utils["Utils (helpers, state, styles)"]:::js
        Assets["Static Assets"]:::js
        RPC -->|"loads iframe bundle"| HTML
        HTML --> EntryJS
        EntryJS --> Renderer
        EntryJS --> Toolbar
        EntryJS --> InfoPanel
        EntryJS --> NodeActions
        EntryJS --> Viewbar
        EntryJS --> Utils
        EntryJS --> StyleCSS
        EntryJS --> Assets
        Webpack --> PackageJSON
        Webpack --> EntryJS
    end

    subgraph "CI/CD & Deployment"
        direction TB
        Actions["GitHub Actions"]:::external
        PyPI["PyPI"]:::external
        Render["Render.com Demo"]:::external
        Actions -->|"publishes to"| PyPI
        Actions -->|"deploys examples to"| Render
    end

    Examples["Examples & Demos"]:::python
    Data["Demo Data Files"]:::external
    DemoScripts["Example Usage Scripts"]:::python
    Tests["Test Suite"]:::python
    pyproject["Project Metadata & Config"]:::external

    App --> Examples
    Examples -->|"uses data"| Data
    Examples -->|"includes scripts"| DemoScripts
    Actions --> Tests
    Actions --> pyproject

    classDef python fill:#D0E6FF,stroke:#0366D6,color:#0366D6;
    classDef js fill:#FFE0B2,stroke:#E65100,color:#E65100;
    classDef external fill:#E8F5E9,stroke:#2E7D32,color:#2E7D32;

    click Wrapper "https://github.com/alrasheeda/st-link-analysis/blob/main/st_link_analysis/component/component.py"
    click Events "https://github.com/alrasheeda/st-link-analysis/blob/main/st_link_analysis/component/events.py"
    click Icons "https://github.com/alrasheeda/st-link-analysis/blob/main/st_link_analysis/component/icons.py"
    click Layouts "https://github.com/alrasheeda/st-link-analysis/blob/main/st_link_analysis/component/layouts.py"
    click Styles "https://github.com/alrasheeda/st-link-analysis/blob/main/st_link_analysis/component/styles.py"
    click Webpack "https://github.com/alrasheeda/st-link-analysis/blob/main/st_link_analysis/frontend/webpack.config.js"
    click PackageJSON "https://github.com/alrasheeda/st-link-analysis/blob/main/st_link_analysis/frontend/package.json"
    click HTML "https://github.com/alrasheeda/st-link-analysis/blob/main/st_link_analysis/frontend/src/index.html"
    click EntryJS "https://github.com/alrasheeda/st-link-analysis/blob/main/st_link_analysis/frontend/src/index.js"
    click StyleCSS "https://github.com/alrasheeda/st-link-analysis/blob/main/st_link_analysis/frontend/src/style.css"
    click Renderer "https://github.com/alrasheeda/st-link-analysis/blob/main/st_link_analysis/frontend/src/components/graph.js"
    click Toolbar "https://github.com/alrasheeda/st-link-analysis/blob/main/st_link_analysis/frontend/src/components/toolbar.js"
    click InfoPanel "https://github.com/alrasheeda/st-link-analysis/blob/main/st_link_analysis/frontend/src/components/infopanel.js"
    click NodeActions "https://github.com/alrasheeda/st-link-analysis/blob/main/st_link_analysis/frontend/src/components/nodeActions.js"
    click Viewbar "https://github.com/alrasheeda/st-link-analysis/blob/main/st_link_analysis/frontend/src/components/viewbar.js"
    click Utils "https://github.com/alrasheeda/st-link-analysis/blob/main/st_link_analysis/frontend/src/utils/helpers.js"
    click Utils "https://github.com/alrasheeda/st-link-analysis/blob/main/st_link_analysis/frontend/src/utils/state.js"
    click Utils "https://github.com/alrasheeda/st-link-analysis/blob/main/st_link_analysis/frontend/src/utils/styles.js"
    click Assets "https://github.com/alrasheeda/st-link-analysis/tree/main/st_link_analysis/frontend/src/assets/icons"
    click Assets "https://github.com/alrasheeda/st-link-analysis/tree/main/st_link_analysis/frontend/src/fonts"
    click Examples "https://github.com/alrasheeda/st-link-analysis/blob/main/examples/app.py"
    click Data "https://github.com/alrasheeda/st-link-analysis/blob/main/examples/data/claims.json"
    click Data "https://github.com/alrasheeda/st-link-analysis/blob/main/examples/data/company.json"
    click Data "https://github.com/alrasheeda/st-link-analysis/blob/main/examples/data/social.json"
    click DemoScripts "https://github.com/alrasheeda/st-link-analysis/blob/main/examples/demos/edge_style.py"
    click DemoScripts "https://github.com/alrasheeda/st-link-analysis/blob/main/examples/demos/event_listeners.py"
    click DemoScripts "https://github.com/alrasheeda/st-link-analysis/blob/main/examples/demos/layout.py"
    click DemoScripts "https://github.com/alrasheeda/st-link-analysis/blob/main/examples/demos/node_actions.py"
    click DemoScripts "https://github.com/alrasheeda/st-link-analysis/blob/main/examples/demos/node_style.py"
    click Tests "https://github.com/alrasheeda/st-link-analysis/blob/main/tests/test_events.py"
    click Tests "https://github.com/alrasheeda/st-link-analysis/blob/main/tests/test_node_actions.py"
    click Tests "https://github.com/alrasheeda/st-link-analysis/blob/main/tests/test_smoke.py"
    click Tests "https://github.com/alrasheeda/st-link-analysis/blob/main/tests/conftest.py"
    click Actions "https://github.com/alrasheeda/st-link-analysis/blob/main/.github/workflows/pr_checks.yml"
    click pyproject "https://github.com/alrasheeda/st-link-analysis/blob/main/pyproject.toml"
```
