Metadata-Version: 2.0
Name: flash-services
Version: 0.1.0
Summary: The services that can be shown on a Flash dashboard.
Home-page: http://github.com/textbook/flash/
Author: Jonathan Sharpe
Author-email: mail@jonrshar.pe
License: License :: OSI Approved :: ISC License (ISCL)
Platform: any
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Dist: Flask
Requires-Dist: requests

Flash Services
--------------

The services that can be shown on a `Flash`_ dashboard.

Available services
==================

The following service definitions include the configuration options:

* ``github`` - for project repositories on `GitHub`_

  * ``api_token`` (required),
  * ``account`` (required - the name of the account the project is in, e.g.
    ``"textbook"``)
  * ``app`` (required - the name of the project application 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``).

* ``codeship`` - for CI builds on `Codeship`_

  * ``api_token`` (required)
  * ``project_id`` (required)

* ``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)

.. _Codeship: https://codeship.com/
.. _Flash: https://github.com/textbook/flash
.. _GitHub: https://github.com/
.. _Pivotal Tracker: https://www.pivotaltracker.com/
.. _Travis CI: https://travis-ci.org/


