Skip to main content

An observability tool built to track, inspect and visualize intermediate steps in a pipeline, allowing user to easily debug or analyze through a dashboard.

Project description

steps-track/lib-py

This is the Python library implementation for steps-track

StepsTrack is an observability tool built to help tracking, visualizing and inspecting intermediate steps in a complex pipeline-based application. It automatically captures and stores the intermediate data, results and execution times of each steps in a pipeline, visualizing the execution details and allowing easier debug or analysis through an analytic dashboard.

Installation

pip install steps-track

Quick Start

import asyncio
from steps_track import Pipeline, Step
from steps_track.transport import HttpTransport

async def main():
    http_transport = HttpTransport(
        base_url='http://localhost:3000',
    )

    pipeline = Pipeline('my-pipeline', options={
        'auto_save': 'finish',
        'transport': http_transport,
    })

    async def pipeline_track(st: Step):
        async def step1(st: Step):
            # Step 1 logic
            await st.record('key', 'value')
            
        await st.step('step1', step1)
        
        async def step2(st: Step):
            # Step 2 logic
            return 'result'
            
        await st.step('step2', step2)

    await pipeline.track(pipeline_track)

    # Export output
    exported = pipeline.output_pipeline_meta()

    # Gantt Chart Visualization
    gantt_chart_buffer = await pipeline.gantt_quickchart()

if __name__ == "__main__":
    asyncio.run(main())

See GitHub repository for more usages and repository introduction.

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

steps_track-1.12.7.tar.gz (13.9 kB view details)

Uploaded Source

Built Distribution

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

steps_track-1.12.7-py3-none-any.whl (17.0 kB view details)

Uploaded Python 3

File details

Details for the file steps_track-1.12.7.tar.gz.

File metadata

  • Download URL: steps_track-1.12.7.tar.gz
  • Upload date:
  • Size: 13.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.2 CPython/3.13.3 Linux/6.8.0-1021-azure

File hashes

Hashes for steps_track-1.12.7.tar.gz
Algorithm Hash digest
SHA256 9f30373535ea511107f037b7266157210e41f8506aa5d9e8b5bee0c6000d2820
MD5 f4b937d7133822a59b6b501ca9f3e91f
BLAKE2b-256 fa1d688eabbeeb1699debc300a4bf70a481772654e065c737c86caa4fa481e64

See more details on using hashes here.

File details

Details for the file steps_track-1.12.7-py3-none-any.whl.

File metadata

  • Download URL: steps_track-1.12.7-py3-none-any.whl
  • Upload date:
  • Size: 17.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.2 CPython/3.13.3 Linux/6.8.0-1021-azure

File hashes

Hashes for steps_track-1.12.7-py3-none-any.whl
Algorithm Hash digest
SHA256 9f239468e9ca0511ea5a46d08aabe164c8d9f3bdf6577672138f6cc7ad577e67
MD5 81151af0a36129c2d90bcda60d6baa80
BLAKE2b-256 f7a85c12e677cbb65f4fda51430afeb1b1e0f206a1b21b8f8008bec34edca72a

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