Skip to main content

Command-line application to get or set github commit status.

Project description

Latest Version License Downloads


This command-line application is mainly for continuous build and integration environments. It allows one to set provide all of the details necessary to mark a commit, for pull requests, to read “All is Well” or “Merge with Caution” with an optional hyperlink to the CI build server, or description of build failure.

This is done using the Github v3 API.

This is not a very serious package, there are not any plans to advance it further. It was authored because existing github python client packages such as pygithub3 did not offer the ability to communicate with the ‘statuses’ api endpoints, and it is preferred to provide well-readable command-line arguments in the build script than to use curl directly.


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

pip install ghstat

Generate a personal access token,, enabling scope repo:status and public_repo or private_repo, respectively.

Use this token for the –token parameter.


failing a build on set --token 0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d \
              --commit 72b74be0de46392a05d8f470b64272b8036e63f8 \
              --user jquast --repo ghstat --state success

retrieving the status of a commit: get --token 0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d \
              --commit 72b74be0de46392a05d8f470b64272b8036e63f8 \
              --user jquast --repo ghstat

linking to a private bamboo and github enterprise account: set --token 0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d \
              --commit 0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a \
              --user jquast \
              --repo ghstat \
              --state success \
              --description 'build successful' \
              --target-url '' \
              --base-url ''


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


  • Initial release to pypi

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for ghstat, version 0.1.1
Filename, size File type Python version Upload date Hashes
Filename, size ghstat-0.1.1-cp27-none-macosx_10_10_x86_64.whl (5.4 kB) File type Wheel Python version 2.7 Upload date Hashes View
Filename, size ghstat-0.1.1.tar.gz (3.6 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page