Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

Web-based client for Yarr!

Project Description

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.

Release History

Release History

This version
History Node

0.2.1

History Node

0.2.0

History Node

0.1.0

Download Files

Download Files

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

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
yarr.client-0.2.1.tar.gz (12.7 kB) Copy SHA256 Checksum SHA256 Source Sep 11, 2015

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting