Skip to main content

A tool for generating chart documentation websites

Project description

ChartBook

A developer platform for data science teams.

PyPI - Version PyPI - Python Version

Discover, document, and share data science work across your organization. ChartBook provides a centralized catalog for data pipelines, charts, and documentation—making it easy to find, understand, and reuse analytics work.

Terminology

ChartBook supports two project types:

  • Pipeline — A single analytics pipeline with its own charts, dataframes, and documentation
  • Catalog — A collection of multiple pipelines aggregated into a unified documentation site

See the Concepts page for the full terminology including ChartBooks and ChartHub.

Features

  • Pipeline Catalog — Organize and discover data pipelines across your team
  • Documentation Generation — Build searchable documentation websites from your analytics work
  • Data Governance — Track data sources, licenses, and access permissions
  • Programmatic Data Access — Load pipeline outputs directly into pandas or polars
  • Multi-Pipeline Catalogs — Aggregate multiple pipelines into a single documentation site

Installation

Recommended:

pip install chartbook[all]

This gives you everything: data loading, plotting utilities, and the CLI for building documentation.

Minimal install (data loading only):

pip install chartbook[data]

Development:

pip install -e ".[dev]"

Quick Start

Load data from a pipeline

from chartbook import data

df = data.load(pipeline_id="EX", dataframe_id="repo_public")

Build documentation

chartbook build

See the documentation for configuration options and detailed guides.

Documentation

Full documentation is available at backofficedev.github.io/chartbook.

Contributing

Contributions are welcome. See CONTRIBUTING for guidelines.

License

Modified BSD License

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

chartbook-0.0.2.tar.gz (11.0 MB view details)

Uploaded Source

Built Distribution

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

chartbook-0.0.2-py3-none-any.whl (11.0 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: chartbook-0.0.2.tar.gz
  • Upload date:
  • Size: 11.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.28.1

File hashes

Hashes for chartbook-0.0.2.tar.gz
Algorithm Hash digest
SHA256 c5e7c6f8c5f8efdc33e24058f426d24b3651f6867d0e7aac2c740def37909699
MD5 e79667b9ff7d6b56106b030d3b4d08dd
BLAKE2b-256 420f0c42fb2ee39b540a03ca7bd8925f0e0d2db29d455ca88db0913d3f5bd563

See more details on using hashes here.

File details

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

File metadata

  • Download URL: chartbook-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 11.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.28.1

File hashes

Hashes for chartbook-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 94dc7884e87591f42e3c294425ac8e1bf3180767150151925e1472e5fcdfc52c
MD5 b6fc8604807c95e6f7206f39d7de038d
BLAKE2b-256 ae2a93fdf51a410f8495c524a0bc91a1e8c593f4143f61e12159cf79935b9e91

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