Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

Web-based client for Yarr!

Project description

Circle CI Dependency Status PyPI version Docker pulls

Web client for Yarr! in Python.


Using Docker

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

Using a package manager

$ pip install yarr.client

From source

$ git clone
$ cd yarr.client
$ pip install -r requirements.txt
$ pip install -e .



$ yarr.client

 * Running on
 * Restarting with reloader


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!

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

  -c, --config FILE         Path to Flask config file (params:
  -h, --help                Output this help and exit
  -v, --version             Output version and exit

  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


Published under MIT License.

Project details

Release history Release notifications

This version
History Node


History Node


History Node


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
yarr.client-0.2.1.tar.gz (12.7 kB) Copy SHA256 hash SHA256 Source None Sep 11, 2015

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page