issues.py

A simple python script to monitor yours (and other people’s) issues on GitHub projects. Most of the heavy lifting is done by github3.py – a Python wrapper for the GitHub API v3.

Installation

$ pip install issues.py

Or:

$ git clone git://github.com/sigmavirus24/issues.py.git
$ cd issues.py
$ python setup.py install

Configuration

In your $HOME directory, start a file called .issuesrc. The file uses json to organize the information in a sensible and logical way. The three keys are described in the following table:

Param Explanation
auth authentication parameters
projects projects you’re watching
options script options

auth

The auth section is a dictionary with three (straightforward) possible parameters:

  • username
  • password
  • oath

If you’re uncomfortable providing your password in plain-text, you can either use OAuth to login or you can enter your username and allow the script to prompt you each and every time you want to get issues.

You may also entirely omit this section to track issues anonymously, just keep in mind that you won’t be able to comment on or administer issues at all.

projects

This is a dictionary where the key is the owner of the repository, and the value is a list of their repositories.

options

This is another dictionary that accepts the following keys:

Key Value
filter (“assigned”, “created”, “mentioned”, “subscribed”) [1]
state (“open”, “closed”) [2]
labels e.g. “bug,ui,@high”
sort (“created”, “updated”, “comments”) [3]
direction (“asc”, “desc”) [4]
since ISO8601 formatted string [5]
[1]The default (set by the GitHub API) is “assigned”
[2]The default is “open”
[3]The default is “created”
[4]The default is “desc”
[5]An example would be “2012-07-02T18:39:03Z”

A Sample Config File

{
    "auth": {
        "username": "sigmavirus24"
    },
    "projects": {
        "sigmavirus24": [
            "Todo.txt-python",
            "github3.py",
            "issues.py",
            "sprunge.py"
        ],
        "kennethreitz": [
            "requests",
            "args",
            "clint"
        ]
    }
}

Table Of Contents

This Page