yarr.client 0.2.0

Web-based client for Yarr!

Web client for Yarr! in Python.

Install

Using Docker

$ docker run -d -p 80:5000 bluecap/yarr.client:latest

Using a package manager

$ pip install yarr.client

From source

$ git clone https://github.com/bluecap-se/yarr.client.git
$ cd yarr.client
$ pip install -r requirements.txt
$ pip install -e .

Usage

Quickstart

$ yarr.client

 * Running on http://0.0.0.0:5000/
 * Restarting with reloader

Options

The configuration file params are defined in the Flask documentation.

Additional, app-specific params are YARR_URL and YARR_API_TOKEN. YARR_URL is the path to the Yarr! server, and YARR_API_TOKEN needs to be set if the server has a corresponding token specified in its config.

$ yarr.client -h

Yarr.client - Web Client for Yarr!

Usage:
      yarr.client runserver [--config FILE] [options]

Options:
  -c, --config FILE         Path to Flask config file (params: bit.ly/1uamUo1)
  -h, --help                Output this help and exit
  -v, --version             Output version and exit

Examples:
  yarr.client runserver
  yarr.client runserver -c /etc/production.cfg

Options with Docker

To use a custom configuration file in Docker, map your file using volumes.

$ docker run -d -p 80:5000 -v /path/to/your/config.cfg:/yarr.config.cfg bluecap/yarr.client:latest

Run tests

$ pip install -r test_requirements.txt
$ py.test

Watch for changes

To run the tests continuously, run the test command with the watch or follow flag -f:

$ py.test -f

Test coverage

$ coverage run --source yarr_client -m py.test
$ coverage html
$ open htmlcov/index.html

License

Published under MIT License.