https://github.com/bluecap-se/yarr.client

Web client for Yarr!
https://github.com/bluecap-se/yarr.client

client-side docker flask

Last synced: 7 days ago
JSON representation

Web client for Yarr!

• Host: GitHub
• URL: https://github.com/bluecap-se/yarr.client
• Owner: bluecap-se
• License: mit
• Created: 2014-09-30T18:35:24.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2015-09-11T12:04:40.000Z (about 9 years ago)
• Last Synced: 2024-09-23T07:32:20.026Z (10 days ago)
• Topics: client-side, docker, flask
• Language: Python
• Homepage: https://pypi.org/project/yarr.client/
• Size: 383 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: HISTORY.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Yarr! client

[![Circle CI](https://img.shields.io/circleci/project/bluecap-se/yarr.client.svg?style=flat-square)](https://circleci.com/gh/bluecap-se/yarr.client)

[![Dependency Status](https://img.shields.io/gemnasium/bluecap-se/yarr.client.svg?style=flat-square)](https://gemnasium.com/bluecap-se/yarr.client)

[![PyPI version](https://img.shields.io/pypi/v/yarr.client.svg?style=flat-square)](https://pypi.python.org/pypi/yarr.client/)

[![Docker pulls](https://img.shields.io/docker/pulls/bluecap/yarr.client.svg?style=flat-square)](https://registry.hub.docker.com/u/bluecap/yarr.client/)

Web client for [Yarr!](https://github.com/bluecap-se/yarr) in Python.

## Install

### Using Docker

```console

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

```

### Using a package manager

```console

$ pip install yarr.client

```

### From source

```console

$ git clone https://github.com/bluecap-se/yarr.client.git

$ cd yarr.client

$ pip install -r requirements.txt

$ pip install -e .

```

## Usage

### Quickstart

```console

$ yarr.client

 * Running on http://0.0.0.0:5000/

 * Restarting with reloader

```

### Options

The configuration file params are defined in the [Flask documentation](http://flask.pocoo.org/docs/0.10/config/#builtin-configuration-values).

Additional, app-specific params are `YARR_URL` and `YARR_API_TOKEN`. `YARR_URL` is the path to the [Yarr!](https://github.com/bluecap-se/yarr)

server, and `YARR_API_TOKEN` needs to be set if the server has a corresponding token specified in its config.

```console

$ 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.

```console

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

```

## Run tests

```console

$ 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`:

```console

$ py.test -f

```

### Test coverage

```console

$ coverage run --source yarr_client -m py.test

$ coverage html

$ open htmlcov/index.html

```

## License

Published under [MIT License](https://github.com/bluecap-se/yarr.client/blob/master/LICENSE).