Metadata-Version: 2.1
Name: InsightBoard
Version: 0.1.0
Summary: InsightBoard for data parsing and report generation
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: dash>=2.18.1
Requires-Dist: dash-table>=5.0.0
Requires-Dist: pandas>=2.2.3
Requires-Dist: dash-bootstrap-components>=1.6.0
Requires-Dist: gunicorn>=23.0.0
Requires-Dist: pyarrow>=17.0.0
Requires-Dist: openpyxl>=3.1.5
Requires-Dist: adtl[parquet]>=0.6.0
Requires-Dist: jsonschema>=4.23.0
Requires-Dist: dash-dangerously-set-inner-html>=0.0.2
Requires-Dist: tomli-w>=1.0.0

# InsightBoard

[![Unit and integration tests](https://github.com/globaldothealth/InsightBoard/actions/workflows/ci.yaml/badge.svg)](https://github.com/globaldothealth/InsightBoard/actions/workflows/ci.yaml) [![Documentation Status](https://readthedocs.org/projects/insightboard/badge/?version=latest)](https://insightboard.readthedocs.io/en/latest/?badge=latest)

A dashboard to upload and manage data and generate reports.

Documentation: [ReadTheDocs](https://insightboard.readthedocs.io/en/latest)

## Installation

Install using your favourite package manager. It is recommended to install into a virtual environment. We recommend using [uv](https://github.com/astral-sh/uv) to manage the virtual environment.

```bash
uv sync
. .venv/bin/activate
```

To launch the dashboard, simply type `InsightBoard` from the command line. The dashboard should appear in your default web browser. By default the dashboard will be available at http://localhost:8050/.

## Getting started

By default InsightBoard will create a folder called `InsightBoard/projects` in your home directory. This is where all your projects will be stored (you can change this location in the Settings panel of the dashboard).

We recommend that you store each project in a separate (version controlled) git repository within the projects folder. This will allow you to easily share your projects with others and keep track of any changes.

For example, to set up an existing project called `my_project` in the `InsightBoard/projects` folder, you can run the following commands from the command line:

```bash
cd ~/InsightBoard/projects
git clone <url> my_project
```

Details of how to create a new project are provided in the accompanying [documentation](https://insightboard.readthedocs.io/en/latest/).


## Development

To launch the dashboard in development mode, follow the [Installation](#installation) instructions but instead launch with `python -m InsightBoard`.
