Metadata-Version: 2.1
Name: canvas_summary
Version: 1.0.2
Summary: A Canvas component that visualizes an overview of a dataset
Home-page: https://github.com/satishlokkoju/deepview
Author: Satish Lokkoju
Author-email: satish.lokkoju@gmail.com
License: Apache 2.0
Keywords: Jupyter,Widgets,IPython
Platform: Linux
Platform: Mac OS X
Platform: Windows
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Framework :: Jupyter
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: ipywidgets>=7.0.0
Requires-Dist: canvas_ux
Provides-Extra: examples
Provides-Extra: docs
Requires-Dist: jupyter_sphinx; extra == "docs"
Requires-Dist: nbsphinx; extra == "docs"
Requires-Dist: nbsphinx-link; extra == "docs"
Requires-Dist: pytest_check_links; extra == "docs"
Requires-Dist: pypandoc; extra == "docs"
Requires-Dist: recommonmark; extra == "docs"
Requires-Dist: sphinx>=1.5; extra == "docs"
Requires-Dist: sphinx_book_theme; extra == "docs"

# Canvas Summary Widget

A component that displays an overview of the provided dataset table.
To configure it, pass a list of `SummaryElement`.
One `SummaryElement` is defined as:

```
export interface SummaryElement {
    name: string;
    data: number | ChartData;
}
```

`ChartData` is defined as:

```
export interface ChartData {
    spec: VegaLiteSpec;
    data: Record<string, unknown>;
}
```

## Installation

```bash
pip install canvas_summary
```

## Usage

To learn how to use Canvas, see the [documentation](https://betterwithdata.github.io/ml-Canvas/).

## Development

To learn about how to build Canvas from source and how to contribute to the framework, please look at [CONTRIBUTING.md](../CONTRIBUTING.md) and the [development documentation](https://betterwithdata.github.io/ml-Canvas/contributing.html).
