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.
Metadata
Release files for yarr.client 0.2.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| yarr.client-0.2.1.tar.gz | 12.7 kB | Without provenance | Details for yarr.client-0.2.1.tar.gz |
Release files / yarr.client-0.2.1.tar.gz
| Download URL | yarr.client-0.2.1.tar.gz |
|---|---|
| Size | 12.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6df3731d71f52e783b60cfe2a5063f32fe6eb58c0600ba3725458802faae5a36
|
|
BLAKE2b-256 checksum How to use checksums |
3fa3ac0e46b35dd532572b84db341f439ea496e23c2034f799f46545249d4aef
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for yarr.client 0.2.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.