Skip to main content

Timeline visualisation for CSV data and Prometheus test files

Project description

timelineviz

PyPI version Python License: MIT

Timeline visualisation for CSV data and Prometheus test files.

Example Timeline

Features

  • Plot event timelines from CSV / DataFrame timestamp data
  • Long-format logs — one timestamp column across many rows, with optional filters on level / event type (incident-style timelines)
  • Handle time gaps with broken timeline display
  • Auto-detect timestamp columns based on naming patterns
  • Visualise Prometheus promtool unit-test files — series values, eval checkpoints, and alert checks on a relative time axis
  • Customisable colour schemes
  • CLI and Python API
  • Optional next step: use saved PNGs (plus your CSV or milestone list) as input to multimodal / image-generation LLMs to produce executive-style infographics — see below

Installation

pip install timelineviz

# or with uv
uv add timelineviz

For development:

git clone https://github.com/garrywilliams/timeline_viz.git
cd timeline_viz
make install
# or: uv pip install -e ".[dev]"

Run make or make help for tests, builds, and other tasks. Details: DEVELOPING.md.

Quick Start

CSV / DataFrame Timelines

# Auto-detect timestamp columns
timelineviz data.csv --detect-timestamps --output-dir timelines

# Specify columns explicitly
timelineviz data.csv --timestamp-columns created_at updated_at completed_at
from timelineviz import plot_timeline, plot_multiple_timelines

import pandas as pd
df = pd.read_csv("data.csv")

# Single entity
plot_timeline(df.iloc[0],
              timestamp_columns=['created_at', 'updated_at', 'completed_at'],
              entity_id="12345")

# Multiple entities
plot_multiple_timelines("data.csv",
                        timestamp_columns=['created_at', 'updated_at'],
                        id_column='entity_id',
                        output_dir="timeline_images")

Event log (long format)

Use this when each row is one event and times live in a single column (typical logs). Optionally keep or drop rows using another column (for example level or event_type) so you can focus on an incident and ignore noise.

timelineviz examples/incident_log.csv --event-log --log-time-column ts \
  --log-label-column message --log-filter-column level \
  --log-include ERROR WARN --output-dir timelines --no-show
from timelineviz import plot_event_log_timeline

plot_event_log_timeline(
    "incident.csv",
    timestamp_column="ts",
    label_column="message",
    filter_column="level",
    include_values=["ERROR", "WARN"],
    output_file="incident_timeline.png",
    show_plot=False,
)

A small sample file is in examples/incident_log.csv.

Prometheus Test Timelines

Visualise promtool unit-test YAML files — see series values change over time, where evaluations happen, and when alerts fire.

timelineviz my_rules_test.yml --promtest
timelineviz my_rules_test.yml --promtest --output-dir images --no-show
from timelineviz import parse_promtest_file, plot_promtest

groups = parse_promtest_file("my_rules_test.yml")
plot_promtest(groups, output_file="promtest_timeline.png")

Promtest Example

Charts are self-documenting — each subplot shows the metric name and raw notation, value labels appear at transition points, eval/alert vertical lines are labelled, and a legend strip at the bottom explains all marker types.

Full guide: PROMTEST.md — notation reference, worked examples, and all parameters.

How It Works

CSV Timelines

Wide format (default): each entity is a row; timestamps live in separate columns (for example created_at, updated_at). Those columns become labelled points on one timeline per entity.

Long format (plot_event_log_timeline / --event-log): many rows share one timestamp column; each row is one point. Filters apply before plotting.

In both cases, when time gaps exceed a threshold, the timeline is broken into segments with slash markers indicating the breaks.

Promtest Timelines

Prometheus test files define metric series as values over discrete time steps (e.g. one value per minute). The library:

  1. Parses the YAML and expands the compact notation (1+2x51, 3, 5, 7, 9, 11)
  2. Plots each input_series as a step chart on its own subplot
  3. Draws vertical markers at eval_time checkpoints
  4. Shows alert check points with firing/pending status
  5. Labels the x-axis with relative time offsets (0s, 1m, 2m, …)

From chart output to executive infographics

timelineviz is built for faithful, technical timelines (PNG from the CLI or output_file= in Python). For stakeholder decks, board summaries, or comms, you can treat that output as source material for a second step: a multimodal or image-focused LLM (any tool that accepts an image plus a long text brief—e.g. Nano Banana or similar) together with:

  • The exported PNG (or a screenshot of the figure)
  • Your structured facts: ordered milestones, dates, short business descriptions, KPIs, risks, and the story you want told
  • A detailed creative prompt (audience, tone, layout, colour rules, and what not to invent)

The model can redesign the information as an infographic while you verify dates, labels, and numbers against your data. The sample below is an illustrative executive layout (sample healthcare journey) produced from that kind of workflow—not something timelineviz renders by itself.

Example executive infographic derived from timeline-style data and an LLM brief

Example only: narrative layout, icons, and insight rail were generated for communication design; always validate facts against your source CSV and plots.

API Reference

CSV Mode

Parameter Description
timestamp_columns Columns containing timestamp data to visualise
id_column Column that uniquely identifies each entity
threshold_days Time gap (in days) that triggers a timeline break
entity_name Type name for titles (e.g. "Patient", "Order")
label_mappings Custom display names for timestamp columns
color_scheme Dictionary of colour overrides

Promtest Mode

Parameter Description
figsize Figure dimensions (width, height) in inches
title Custom figure title
color_scheme Override colours (see PROMTEST.md)
output_file Save to PNG
dpi Resolution (default 150)

License

MIT

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

timelineviz-0.2.1.tar.gz (632.0 kB view details)

Uploaded Source

Built Distribution

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

timelineviz-0.2.1-py3-none-any.whl (37.9 kB view details)

Uploaded Python 3

File details

Details for the file timelineviz-0.2.1.tar.gz.

File metadata

  • Download URL: timelineviz-0.2.1.tar.gz
  • Upload date:
  • Size: 632.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.6

File hashes

Hashes for timelineviz-0.2.1.tar.gz
Algorithm Hash digest
SHA256 1da49b3014725648e56ab98200e8812a92a593582f719b98c565b9c27269d85a
MD5 fe10ff37bcfc66c9244e31b9f0160f61
BLAKE2b-256 0fd24a416ac040a6d54642817c10bef3f8e0c9be998cfc77b273da1466ccb10d

See more details on using hashes here.

File details

Details for the file timelineviz-0.2.1-py3-none-any.whl.

File metadata

File hashes

Hashes for timelineviz-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6547eb64c5be8369a54188fe51b9ddefcfd78940005e5203d1ec022a31532197
MD5 c5346bec3b482cfdebb0c0ff4faff578
BLAKE2b-256 e277bf6bd7fd03e97c4a18d22479e58d872fd3d4e146d9b3912b0f488c0018c7

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