Skip to main content

Limelight

Limelight is a portable package format for data-driven figures and analysis stories, and a desktop app for reading them.

A Limelight package is a folder, or a .limelight archive with the same layout, holding a project.dhall manifest alongside the datasets it describes, the figure specs drawn from them, and a story that walks a reader through the analysis. The app opens either form, validates the manifest, resolves the data, renders the figures, and follows the story.

Packages are meant to be produced by libraries and tools rather than by hand; limelight.writer is the Python library for building them, and limelight.reader for opening them without the app.

Installing

pip install limelight-app

The distribution is limelight-app (PyPI would not allow plain limelight), but the package imports as limelight and the commands are named as below.

A package's project.dhall manifest is read by a built-in evaluator, so nothing beyond the Python dependencies is needed. A hand-written manifest that uses Dhall features beyond what the writer emits (functions, if, merge, interpolation) is handed to dhall-to-json instead, if one is on PATH or named by LIMELIGHT_DHALL_TO_JSON.

Native installers for Windows, macOS and Linux are built by packaging/; see packaging/README.md.

Using it

limelight-gui example.limelight            # open a package in the desktop app
limelight-cli summary example.limelight    # print a summary of a package
limelight-cli verify example.limelight     # validate one or more packages
limelight-cli pdf example.limelight        # render a package's story to PDF

LL is the short form of both: LL example.limelight opens the app, and LL verify example.limelight (or summary, json, pdf) runs the CLI.

The scripts in examples/ build sample packages into _build/examples/, and src/limelight/language-reference/ holds the Dhall types a manifest is written against; the writer copies them into every package it builds.

Developing

uv sync --all-groups
uv run pytest

Download files

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

Source Distribution

limelight_app-0.0.2.tar.gz (3.0 MB view details)

Uploaded Source

Built Distribution

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

limelight_app-0.0.2-py3-none-any.whl (153.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: limelight_app-0.0.2.tar.gz
  • Upload date:
  • Size: 3.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for limelight_app-0.0.2.tar.gz
Algorithm Hash digest
SHA256 dd9b423730c4e6a8b078975431f89a1e63082711c1ad6531a79d96297ef7b49c
MD5 78d4dd374e1b590a2357878eb68e1438
BLAKE2b-256 1922a219c2e01856aed104ff05ba01d3d75777d857df8a8cd72b3dd7f6666391

See more details on using hashes here.

Provenance

The following attestation bundles were made for limelight_app-0.0.2.tar.gz:

Publisher: publish.yml on mikehulluk/limelight

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

  • Download URL: limelight_app-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 153.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for limelight_app-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 500772fcbb9e0075f0d99670034e3689ae1f504e27ec844fc9c502583d0ae90a
MD5 274cddd3ba7aab1685418a1af779c842
BLAKE2b-256 e9b9800fe615175807d3e25dd62897dec312ed557ed929cf6d7a815dde94e880

See more details on using hashes here.

Provenance

The following attestation bundles were made for limelight_app-0.0.2-py3-none-any.whl:

Publisher: publish.yml on mikehulluk/limelight

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.0.3

2 files

This release

0.0.2 This release

2 files

0.0.1

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page