Skip to main content

Lumen

Illuminate your data

Build Status Linux/MacOS/Windows Build Status
Coverage codecov
Latest dev release Github tag dev-site
Latest release Github release PyPI version lumen version conda-forge version defaults version
Docs gh-pages site
Support Discourse

Purpose

The Lumen project provides a framework to build data-driven dashboards from a simple yaml specification. It is designed to query data from any source, filter it in various ways and then provide views of that information, which can be anything from a simply indicator to a table or a plot.

Since Lumen is built on Panel it supports a wide range of plotting libraries and other components to explore and visualize data. Thanks to integration with Intake, lightweight package for finding, investigating, loading and disseminating data, Lumen can query data from a wide range of sources including many file formats such as CSV or Parquet but also SQL and many others.

The library is organized into a small number of simply object types including:

  • Source: A Source provides any number of tables along with a JSON schema describing the contents of those tables.
  • Filter: A Filter object is given the schema of a field in one of the tables and generates queries which filter the data supplied by a Source.
  • View: A View can query a table from a Source and generates a viewable representation.
  • Transform: A Transform can apply arbitrary transformation to the tables.

All of these base types can be easily subclassed to provide custom data sources, filters, transforms and views.

Getting started

Lumen works with Python 3 and above on Linux, Windows, or Mac. The recommended way to install Lumen is using the conda command provided by Anaconda or Miniconda:

conda install -c pyviz lumen

or using PyPI:

pip install lumen

Once installed you will be able to start a Lumen server by running:

lumen serve dashboard.yaml --show

This will open a browser serving the application or dashboard declared by your yaml file in a browser window. During development it is very helpful to use the --autoreload flag, which will automatically refresh and update the application in your browser window, whenever you make an edit to the dashboard yaml specification. In this way you can quickly iterate on your dashboard.

Try it out! Click on one of the examples below, copy the yaml specification and launch your first Lumen application.

Examples

London Bike Points
NYC Taxi
Palmer Penguins
Precipitation

Metadata

Release files for lumen 0.3.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for lumen 0.3.1
File Size Uploaded
lumen-0.3.1.tar.gz 44.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for lumen 0.3.1
File Interpreter ABI Platform
lumen-0.3.1-py2.py3-none-any.whl Python 2, Python 3 none any Details

Total release size: 94.7 kB

Release files / lumen-0.3.1.tar.gz

Download URL lumen-0.3.1.tar.gz
Size 44.8 kB
Tags Source
SHA-256 checksum
How to use checksums
391c9c26b88b75c290c9ff11252c3f254110e3cc12cb35690b0c5153f5dc309a
BLAKE2b-256 checksum
How to use checksums
faf3c12b5ac5016f84020dfb2f1d9c04080df77357cb8db3d80631434118456b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/52.0.0.post20210125 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.7.10

Release files / lumen-0.3.1-py2.py3-none-any.whl

Download URL lumen-0.3.1-py2.py3-none-any.whl
Size 49.8 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
58536471383c89f5b4bb2e5d79fe8ad1a5982ec2fba7c9e815d8895e69feb50a
BLAKE2b-256 checksum
How to use checksums
5648c4eced93b225f7d3eb0702dce10fe0d27b013073cdb93b53a894922c91ed
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/52.0.0.post20210125 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.7.10

Release history Release notifications | RSS feed

1.3.0

2 release files

1.2.1

2 release files

1.2.0

2 release files

1.1.0

2 release files

1.0.0

2 release files

0.10.0

2 release files

0.9.0

2 release files

0.8.0

2 release files

0.7.0

2 release files

0.6.3

2 release files

0.6.2

2 release files

0.6.1

2 release files

0.6.0

2 release files

0.5.1

2 release files

0.5.0

2 release files

0.4.1

2 release files

0.4.0

2 release files

0.3.2

2 release files

This release

0.3.1 This release

2 release files

0.3.0

2 release 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