Metadata-Version: 2.1
Name: jupyter-flex
Version: 0.9.1
Summary: Build dashboards using Jupyter Notebooks
Project-URL: homepage, https://github.com/danielfrg/jupyter-flex
Project-URL: repository, https://github.com/danielfrg/jupyter-flex
Project-URL: documentation, https://github.com/danielfrg/jupyter-flex
Author-email: Daniel Rodriguez <daniel@danielfrg.com>
Maintainer-email: Daniel Rodriguez <daniel@danielfrg.com>
License-Expression: Apache-2.0
Keywords: dashboards,jupyter,jupyterlab,notebooks,voila
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
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: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.8
Requires-Dist: ipykernel>=6.21.3
Requires-Dist: jinja2>=3.1.2
Requires-Dist: markupsafe>=2.0.1
Requires-Dist: nbconvert>=7.2.9
Requires-Dist: voila>=0.4.0
Provides-Extra: docs
Requires-Dist: mkdocs; extra == 'docs'
Requires-Dist: mkdocs-jupyter>=0.23.0; extra == 'docs'
Requires-Dist: mkdocs-material; extra == 'docs'
Requires-Dist: mkdocs-minify-plugin; extra == 'docs'
Requires-Dist: pygments; extra == 'docs'
Requires-Dist: pymdown-extensions; extra == 'docs'
Provides-Extra: test
Requires-Dist: coverage[toml]; extra == 'test'
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-cov; extra == 'test'
Requires-Dist: pytest-html; extra == 'test'
Requires-Dist: pytest-image-diff; extra == 'test'
Requires-Dist: pytest-selenium; extra == 'test'
Requires-Dist: pytest-splinter; extra == 'test'
Description-Content-Type: text/markdown

<p align="center">
    <img src="https://raw.githubusercontent.com/danielfrg/jupyter-flex/main/docs/assets/img/logo.png" width="450px">
</p>

<p align="center">
    <a href="https://pypi.org/project/jupyter-flex/">
        <img src="https://img.shields.io/pypi/v/jupyter-flex.svg">
    </a>
    <a href="https://pypi.org/project/mkdocs-jupyter">
        <img src="https://img.shields.io/pypi/pyversions/jupyter-flex.svg">
    </a>
    <a href="https://github.com/danielfrg/jupyter-flex/actions/workflows/test.yml">
        <img src="https://github.com/danielfrg/jupyter-flex/workflows/test/badge.svg">
    </a>
    <a href="https://github.com/danielfrg/jupyter-flex/actions/workflows/docs.yml">
        <img src="https://github.com/danielfrg/jupyter-flex/workflows/docs/badge.svg">
    </a>
    <a href="https://codecov.io/gh/danielfrg/jupyter-flex?branch=main">
        <img src="https://codecov.io/gh/danielfrg/jupyter-flex/branch/main/graph/badge.svg">
    </a>
    <a href="https://github.com/danielfrg/jupyter-flex/blob/main/LICENSE.txt">
        <img src="https://img.shields.io/:license-Apache%202-blue.svg">
    </a>
    <a href="https://mybinder.org/v2/gh/danielfrg/jupyter-flex/main?urlpath=voila%2Ftree%2Fexamples">
        <img src="https://mybinder.org/badge_logo.svg">
    </a>
</p>

<p align="center">
  <a href="https://jupyter-flex.danielfrg.com">Documentation</a>
  ·
  <a href="#installation">Installation</a>
</p>

# Build dashboards using Jupyter Notebooks

- Use Markdown headers and Jupyter Notebook cell tags to define the dashboard layout and its components
- Flexible and easy way to specify row and column based layouts
- Use [nbconvert](https://nbconvert.readthedocs.io/en/latest/) to create static reports
- Use [Voila](https://github.com/voila-dashboards/voila) to start a live Jupyter Kernel for fully dynamic applications
- Support for [Jupyter widgets](https://ipywidgets.readthedocs.io/en/latest/)

<a href="https://mybinder.org/v2/gh/danielfrg/jupyter-flex/main?urlpath=%2Fvoila%2Frender%2Fexamples%2Fmovie-explorer.ipynb"><img src="https://jupyter-flex.danielfrg.com/assets/img/screenshots/jupyter_flex.tests.test_examples/apps_movie-explorer-reference.png" alt="Jupyter-flex: Movie Explorer"  width=270></a>
<a href="https://jupyter-flex.danielfrg.com/examples/nba-scoring.html"><img src="https://jupyter-flex.danielfrg.com/assets/img/screenshots/jupyter_flex.tests.test_examples/apps_nba-scoring-reference.png" alt="Jupyter-flex: NBA Scoring" width=270></a>
<a href="https://jupyter-flex.danielfrg.com/examples/altair.html"><img src="https://jupyter-flex.danielfrg.com/assets/img/screenshots/jupyter_flex.tests.test_examples/plots_altair-reference.png" alt="Jupyter-flex: Bokeh plots"  width=270></a>

## Installation

```shell
pip install jupyter-flex
```

## Documentation

Learn more in the [jupyter-flex documentation](https://jupyter-flex.danielfrg.com).

## Contributing

See [CONTRIBUTING.md](https://github.com/danielfrg/jupyter-flex/blob/main/CONTRIBUTING.md).
