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

Uploaded Python 3

File details

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

File metadata

  • Download URL: chartbook-0.0.3.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.3.tar.gz
Algorithm Hash digest
SHA256 02717058585216ace1f7b1c34d687b78409f101be3d39ed1a729e207b17e869b
MD5 def6445e75d9e941ff2c9b236c24fc6a
BLAKE2b-256 e35e91e7de17743f6b53d3b0eece99eadee0ba35e8ae4b927c8160e2d547c130

See more details on using hashes here.

File details

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

File metadata

  • Download URL: chartbook-0.0.3-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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 67bc373ae9fdd3f193f1467b1d5c72ea9ca3d0e556ab76ea51c17c3ff80427c2
MD5 5cf78c4b00b46fa0ea7fd11585ead2fa
BLAKE2b-256 1c12a6751495f5b797e37f36b6031a2a8772e1d91b03f22a8fd82862d1558ef2

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