hutch_python.bug.post_to_github

hutch_python.bug.post_to_github(report, user=None, pw=None, proxies=None)

Post an issue report to GitHub

Authentication can be done in three different ways depending on preference. First, the call can be made with the username and password specified. If this is not done we first look for a configuration file web.cfg that has a section labeled GitHub which looks like:

[GITHUB]
user=username
pw=password
proxy=http://proxyhost:port

If this is not available the username and password will be requested via the command line. The proxy specification allows posts from hosts without direct connection to the internet. Please consult PCDS for information about available hosts and ports.

Parameters:

• report (dict) –

  A report dictionary with keys:

  • title

  • author

  • commands

  • description

  • env

  • logfiles

  • output

  • dev_pkgs

• user (str, optional) – Username of GitHub profile.

• pw (str, optional) – Password for GitHub profile. This will be queried for if not provided in the function call.

• proxies (dict, optional) – Mapping of protocol to hostname and port.