ghstat 0.3.0

Installation

The stable version of this package is maintained on pypi, install using pip:

pip install ghstat

Generate a personal access token, https://github.com/settings/applications, enabling scope repo:status and public_repo or private_repo, respectively.

Use this token for the –token parameter, or as the environment variable GITHUB_APP_TOKEN

Examples

Failing a build on github.com:

ghstat.py set --token 0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d \
              --commit 72b74be0de46392a05d8f470b64272b8036e63f8 \
              --user jquast --repo ghstat --state success

Retrieving the status of a commit as json data to stdout:

ghstat.py get --token 0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d \
              --commit 72b74be0de46392a05d8f470b64272b8036e63f8 \
              --user jquast --repo ghstat

Linking to a private bamboo and github enterprise account:

ghstat.py set --token 0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d \
              --commit 0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a \
              --user jquast \
              --repo ghstat \
              --state success \
              --description 'build successful' \
              --target-url 'https://bamboo.mycorp.com/browse/PROJ-BUILD10-1' \
              --base-url 'https://github.mycorp.com/api/v3/'

Others

githubdate: Same thing, only it uses an .ini file instead of cmd-line parameters.

Changes

0.3.0

• For descriptions of length greater than 140, truncate and emit a warning to standard error. It will be changed to a length of 140 ending in text marker `` (…)``.

0.2.0

• Support python 3

• Support token as environment value GITHUB_APP_TOKEN

• Resolve IndexError when retrieving status for a commit without any.

0.1.0

• Initial release to pypi