Metadata-Version: 2.1
Name: videoboard
Version: 0.1.1
Summary: Launch a simple http server for visualizing videos and images
Home-page: https://github.com/youngwoon/videoboard
Author: Youngwoon Lee
Author-email: lywoon89@gmail.com
License: MIT
Keywords: http.server video image
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
Requires-Python: >=3
Description-Content-Type: text/markdown

# videoboard

Simple http server for visualizing videos and images.

Videoboard launches a http server which recursively searches directories and shows all videos and images grouped by directory.
It supports videos and images with extensions `mp4`, `png`, `jpg`, `jpeg`, and `gif`.

![Screenshot: videoboard](screenshot.png)

> This repo is initiated to check training and testing results for Reinforcement Learning research. <br>
> Using Python's SimpleHTTPServer requires me to navigate forward and backward. 
> It is especially annoying when multiple experiments are running. <br>
> Videoboard makes visualizing videos from multiple directories much easier.


## Usage

1. Run videoboard:
```
$ videoboard
```

Options:

* `--logdir`           : Directory where videoboard will look for videos and images recursively
* `--port`             : Port number
* `--height`           : Maximum height of image/video
* `--width`            : Maximum width of image/video
* `--file_name_length` : Maximum length of file name shown in videoboard
* `--recursive`        : Search files recursively
* `--display`          : Display videos and images

2. Check the website at `http://127.0.0.1:8000` or `http://[server]:[port]`.
Whenever click a directory, videos and images inside will be reloaded.


## Installation
*Only work on Python3*

Install from pip:
```
pip install videoboard
# or pip3 install videoboard
```

Install from the latest code:
```
git clone https://github.com/youngwoon/videoboard.git
cd videoboard
pip install -e .
```

## License

[MIT License](LICENSE)



