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.6.tar.gz (13.0 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.6-py3-none-any.whl (12.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sayou_visualizer-0.0.6.tar.gz
  • Upload date:
  • Size: 13.0 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.6.tar.gz
Algorithm Hash digest
SHA256 508a45d5f6cd017297f3b5dbd529a84fc0be7b553469a430865e214448dc624d
MD5 516f818fd8d7cfc4211a781d3d80fcfb
BLAKE2b-256 ac7714b454fe43574b4800e1284f0d6ded528c6cc59815a408c356edf333b4ec

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sayou_visualizer-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 fdffed98a9f4542bca2d2f7c12b64ac262a5e2f41db648a230eb36049c5584c4
MD5 4cabe260d552c494c346f05a6701569b
BLAKE2b-256 10d2d4e6bc608ebfc3a6bdb37d2c1bee6c388c7d26fe6e71767ea688dc8e119e

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