Metadata-Version: 2.1
Name: Dataviewer
Version: 0.4.6
Summary: Dataviewer for project files
Home-page: https://gitlab.com/imdc/apps/dataviewer
Author: kdd
Author-email: kobededecker@gmail.com
License: GPL-3.0-or-later
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Requires-Dist: Flask (==1.0.1)
Requires-Dist: Flask-Cors (==3.0.8)

# Dataviewer

This dataviewer will turn a folder of project files (images and csv files) into 
an interactive dataviewer with live-reload functionality. A tree structure of the 
data folder is renewed every 5 seconds, and each image and table is reloaded every
5 seconds as well.

This means you can launch the tool, run your processing scripts and watch your 
images appear and change over time.

## installation

To install the dataviewer from the Pypi registry, run the following command:

```
pip install dataviewer
```

## Folder setup

Create a folder structure in which you will dump project files. This will mostly 
match the way you are already working with project outputs.
The folder structure should look like this:

```
Project
| - scenario1
| | - Location 1
| | | - Img1.png
| | | - Img2.jpg
| | | - table1.csv
| | | - table2.csv
| | - Location 2
| | | - Img1.png
| | | - Img2.jpg
| | | - table1.csv
| | | - table2.csv
| - scenario2
| | ...
```

## Usage

Open a terminal window and navigate to the project folder as described above, and 
launch the dataviewer by running `viewer`.

```
cd c:\Users\xxx\Project
viewer
```

The tool will by default run on following URL: [http://localhost:80/](http://localhost:80).

Port and Host can be changed by adding options to the `viewer` command. e.g.:

```
viewer --host 127.0.0.1 --port 83
```


## Development

Modifying the layout of the web application can be done in the Vue project.
Fork the project, navigate into the `dataviewer` directory and run `yarn install`.

For development, run `yarn serve`.
For production builds, run `yarn build`.

Install the python module by running `pip install . --upgrade`.


## Deploy
- Build dataviewer: `yarn build`
- Bump version in setup.py.
- Create python build: 
```
activate py3
python setup.py sdist bdist_wheel
python -m twine upload dist/Dataviewer-version*
```

## Changelog
- Install changelog-manager: `npm i -g changelog-manager`
- Add changelog entry: `changelog-manager add`
- Create release: `release.bat`

