The services that can be shown on a Flash dashboard.
Project description
The services that can be shown on a Flash dashboard. Includes the service update code and any custom templates not available in the core Flash package.
Documentation
Documentation is available on PythonHosted.
Available services
The following service definitions include the configuration options:
codeship - for CI builds on Codeship
api_token (required)
project_id (required)
coveralls - for coverage reporting on Coveralls (currently only supports open-source builds)
ci_service (required - the name of the service the project is accessed via, e.g. 'github')
account (required - the name of the account the project is in, e.g. "textbook")
repo (required - the name of the project repository within that account, e.g. "flash")
ok_threshold (the minimum coverage level to show as an OK state, defaults to 80%)
neutral_threshold (the minimum coverage level to show as a neutral state, defaults to 50%)
github - for project repositories on GitHub
api_token (required),
account (required - the name of the account the project is in, e.g. "textbook")
repo (required - the name of the project repository within that account, e.g. "flash")
branch (the name of the branch to show commits from, defaulting to the repository’s default branch, which is usually master).
tracker - for projects on Pivotal Tracker
api_token (required)
project_id (required)
travis - for CI builds on Travis CI (currently only supports open-source builds on the .org site).
account (required)
app (required)
Writing a service
The idea behind this package is to make it easier to add new service providers to Flash. Each new service should subclass Service (or one of its more specific children, where appropriate) from the core.py file. The mix-in classes in auth.py can be used to implement authentication to the service API endpoint as needed (currently both header and query parameter token validation are supported).
Any service-specific partial templates (using the Jinja2 templating language) should be placed in templates/partials and service-specific client-side behaviour should live in a new function in the SERVICES object in static/scripts/services.js, keyed by the FRIENDLY_NAME of the service.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for flash_services-0.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b631b67086a5438725065dd57af3a8c9f797902435c863c34d5e77b47ed5e432 |
|
MD5 | ef4ad697883f76b815dd3b3411fe15f4 |
|
BLAKE2b-256 | edde7c77f3bc3ca736d627a3fad4e7b09e77c7fa8ebc28935edb1a51b88828ef |