Skip to main content

Visualizer components for the Sayou Data Platform

Project description

sayou-visualizer

PyPI version License

Overview

The Interactive Observability Engine for Sayou Fabric.

sayou-visualizer provides transparency to the "Black Box" of data pipelines. It transforms invisible execution logs and complex graph data structures into intuitive, interactive 3D Holographic Knowledge Graphs.

It serves two distinct purposes: Pipeline Telemetry (Debugging flow) and Knowledge Rendering (Showcasing data topology).


1. Architecture & Role

The Visualizer operates as a separate layer that can attach to a running pipeline (Tracer) or read static data (Renderer) to generate HTML artifacts.

graph LR
    Data[Pipeline / JSON] --> Pipeline[Visualizer Pipeline]
    
    subgraph Renderers
        Tracer[DAG Tracer]
        Analyst[Analyst KG View]
        Showcase[Showcase 3D View]
    end
    
    Pipeline --> Renderers
    Renderers --> HTML[Interactive HTML]

1.1. Core Features

  • Non-Intrusive Monitoring: Attaches to any Sayou pipeline via the callback system to visualize execution flow without modifying code.
  • Deterministic Layout: Uses physics-based rendering (Cytoscape/Force-Graph) to reveal clusters and outliers in your data.
  • Interactive Inspection: Click on nodes to inspect raw attributes, source code, or relationships in real-time.

2. Available Strategies

sayou-visualizer offers specialized views depending on who is looking at the data.

Strategy Key Target Audience Description
tracer Data Engineer Visualizes the Pipeline Execution Flow (DAG). Shows which components triggered which tasks.
analyst QA / Researcher 2D Analytic View. Focuses on strict schema validation, attribute inspection, and debugging specific relationships.
showcase Stakeholder 3D Holographic View. A visually stunning, high-performance renderer for presenting the scale and topology of the Knowledge Graph.

3. Installation

pip install sayou-visualizer

4. Usage

The VisualizerPipeline is the entry point. You can use it to render existing graph files or attach it to live pipelines.

Case A: Rendering a Knowledge Graph (3D Showcase)

Visualizes the output of sayou-assembler as an interactive 3D galaxy.

from sayou.visualizer import VisualizerPipeline

viz = VisualizerPipeline()

kg_file_path = "./output/graph_data.json"

viz.process(
    source=kg_file_path,
    destination="./output/report_showcase.html",
    strategy="showcase"
)

print("Report generated. Open 'report_showcase.html' in your browser.")

Case B: Debugging Graph Data (2D Analyst)

Generates a detailed 2D view for inspecting node attributes and edge types.

viz.process(
    source=kg_file_path,
    destination="./output/report_analyst.html",
    strategy="analyst"
)

Case C: Pipeline Tracing (Live Monitoring)

Attaches to a running Connector pipeline to visualize the crawling process.

from sayou.connector import ConnectorPipeline
from sayou.visualizer import VisualizerPipeline

connector = ConnectorPipeline()

viz = VisualizerPipeline()
viz.attach_to(connector)

connector.process(source="https://news.daum.net/tech", strategy="web")

viz.report("pipeline_trace.html")

5. Configuration Keys

Customize the visual appearance via the config dictionary.

  • showcase: node_color_by (e.g., class), particle_speed, background_color.
  • analyst: layout_algorithm (dagre/concentric), show_attributes (bool).
  • tracer: include_data_payload (bool), max_events.

6. License

Apache 2.0 License © 2026 Sayouzone

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sayou_visualizer-0.2.0.tar.gz (24.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sayou_visualizer-0.2.0-py3-none-any.whl (25.8 kB view details)

Uploaded Python 3

File details

Details for the file sayou_visualizer-0.2.0.tar.gz.

File metadata

  • Download URL: sayou_visualizer-0.2.0.tar.gz
  • Upload date:
  • Size: 24.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for sayou_visualizer-0.2.0.tar.gz
Algorithm Hash digest
SHA256 b86a45999d88da8decd3b93f357617bf479740738c3a774cd30e4ba2ea6f8577
MD5 b2fe92af121c325992a27593958065a2
BLAKE2b-256 664a2dbcd504b29bd06e77d396f7d3077ed9a07ea7bc8b7081be1c2d83097ab8

See more details on using hashes here.

File details

Details for the file sayou_visualizer-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for sayou_visualizer-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3912015aede065f6a6e9d7a6e75364cc67a8e8497324cef6b27210a19f3904d9
MD5 c9a7405eb1303d785d0a56f2c0bed27e
BLAKE2b-256 6b4e082a1b2e18096595dc033701635a23187df8fc257b4072fdb991c59ddc7f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page