Skip to main content

Connector components for the Sayou Data Platform

Project description

sayou-visualizer

PyPI version License

The Interactive Observability Engine for Sayou Fabric.

sayou-visualizer provides a transparent layer to monitor and visualize the execution flow of Sayou components. By attaching to any pipeline, it transforms invisible execution logs into intuitive, interactive HTML Knowledge Graphs.

It separates the logic of Observation (Tracer) from Presentation (Renderer), allowing you to debug complex pipelines and visualize data lineage without modifying your core logic.

💡 Core Philosophy

"Trace the Process, Render the Insight."

Observability should not be an afterthought. We decouple the responsibility into two roles:

  1. Tracer (Recorder): The "Camera". It silently observes events (on_start, on_finish) from the pipeline via the Callback system and builds an internal graph structure.

  2. Renderer (Painter): The "Canvas". It takes the recorded graph and generates human-readable artifacts (e.g., Interactive HTML, Static Images).

This separation enables a Non-intrusive Monitoring experience, where visualization is just a plug-and-play feature.

📦 Installation

pip install sayou-visualizer

⚡ Quick Start

The VisualizerPipeline acts as a facade, easily attaching to other pipelines to generate reports.

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

def main():
    connector = ConnectorPipeline()

    viz = VisualizerPipeline()
    viz.attach_to(connector)

    print("🚀 Running Pipeline...")
    iterator = connector.run("http://example.com")
    for packet in iterator:
        print(f"Processed: {packet.task.uri}")

    print("🎨 Generating Report...")
    viz.report("examples/pipeline_flow.html")

if __name__ == "__main__":
    main()

🔑 Key Concepts

Tracers

  • GraphTracer: Listens to pipeline events and constructs a NetworkX Directed Acyclic Graph (DAG) in real-time. It distinguishes between Components (Generator/Fetcher) and Data (Tasks).

Renderers

  • PyVisRenderer: Converts the internal graph into an interactive HTML file powered by Vis.js. Features physics-based layout and modern dark UI.
  • RichRenderer (Planned): Displays a tree-structure summary directly in the console using the Rich library.

🤝 Contributing

We welcome contributions for new Renderers (e.g., MatplotlibRenderer, StreamlitRenderer) or specialized Tracers for new components!

📜 License

Apache 2.0 License © 2025 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.0.2.tar.gz (13.4 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.0.2-py3-none-any.whl (12.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sayou_visualizer-0.0.2.tar.gz
  • Upload date:
  • Size: 13.4 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.0.2.tar.gz
Algorithm Hash digest
SHA256 9dd110e70b4b231903415648e1c302a0d3c37f3c23c83ec10ba63610190ffb4c
MD5 96218095a455f1c08c9936137cefb72d
BLAKE2b-256 538c3f37dc6b94644a7fa856779ae92142fc557d0b37e791fc98e757521c4d70

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sayou_visualizer-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 1e07e1994fab5b9fb6bd246f0b8dc887e16e849fc8683a6e63fa55a117cf13d9
MD5 972616fae61096826fc9f0a6c8e68773
BLAKE2b-256 42cc19c3d12fb55d4d955b49f85445be350739cb85acfb60cfdd2e21253721a5

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