alicetragedy / octohat

Hang your non-code contributions on your hat rack.

Octohat

It's easy to see your direct code contributions on GitHub, but what about everything else?

Octohat takes a github repo name, and returns a list of every github user that has interacted with a project, but has not committed code.

Interactions include:

• raising or commenting on an issue
• raising or commenting on a pull request
• commenting on a commit

"Let's All Build a Hat Rack" (#LABHR) is an original concept by Leslie Hawthorn

WARNING

octohat in Python and octohat in Ruby both create callable octohat entites. Strange things may occur if you try to install both on your system.

Installation

pip install octohat

Usage

octohat [-h] [-g] [-l LIMIT] repo_name

positional arguments:
  repo_name                githubuser/repo

optional arguments:
  -g, --generate-html      Generate output as HTML
  -l LIMIT, --limit LIMIT  Limit to the last x Issues/Pull Requests

Define an environment variable for "GITHUB_TOKEN" to use an authentication token (allows for deeper searching)

Run this repo locally

To do

• parallel processing
• wiki contributions
• include merge-only contributors as non-code contributors

Code of Conduct

Octohat operates under a Code of Conduct.

License

Octohat is distributed under the MIT license.

Octohub is Copyright (c) 2013 Alon Swartz (turnkeylinux), used inline under the GPLv3 license.