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 GitHub Stars Documentation

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="fred_charts", dataframe_id="interest_rates")

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.4.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.4-py3-none-any.whl (11.0 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: chartbook-0.0.4.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.4.tar.gz
Algorithm Hash digest
SHA256 e0eda695646aa6cca1848428a063572f11c4b21672a204523dee8a7f9db7b3d5
MD5 6f8cab1074f118f3a521615170686f63
BLAKE2b-256 bd8b7f7e1698823fc3d9a29ec8233f92fc444094844c1ceaa105a5018647b0dc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: chartbook-0.0.4-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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 9e390d7f1aff0896ca8b46eaf7a5eba8f34afe4cdc8fde8f3e4788eb5d3ef946
MD5 f6ae28647ef71df8ed95353081655601
BLAKE2b-256 a712d327474e12e1056b18460f4c33729dad9aac27a4d615d021c4a4b7719518

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