Skip to main content

See what is happening on GitHub in real time

Project description

ghtop

See what's happening on GitHub in real time (also helpful if you need to use up your API quota as quickly as possible).

ghtop provides a number of views of all current public activity from all users across the entire GitHub platform. (Note that GitHub delays all events by five minutes.)

Install

Either pip install ghtop or conda install -c fastai ghtop.

How to use

Run ghtop -h to view the help:

$ ghtop -h
usage: ghtop [-h] [--include_bots] [--types TYPES] [--filt {user,repo,org}] [--filtval FILTVAL]
             {tail,quad,users,simple}

positional arguments:
  {tail,quad,users,simple}  Operation mode to run

optional arguments:
  -h, --help                show this help message and exit
  --include_bots            Include bots (there is a lot of them!) (default: False)
  --types TYPES             Comma-separated types of event to include (e.g PushEvent)
  --filt {user,repo,org}    Filtering method
  --filtval FILTVAL         Value to filter by (for `repo` use format `owner/repo`)

There are 4 views you can choose: ghtop simple, ghtop tail, ghtop quad, or ghtop users. Each are shown and described below. All views have the following options:

  • --include_bots: By default events that appear to be from bots are excluded. Add this flag to include them
  • --types TYPES: Optional comma-separated list of event types to include (defaults to all types). For a full list of types, see the GitHub event types docs
  • --filt and --filtval: Optionally filter events to just those from one of: user, repo, or org, depending on filt. filtval is the value to filter by. See the GitHub docs for details on the public event API calls used.

Important note: while running, ghtop will make about 5 API calls per second. GitHub has a quota of 5000 calls per hour. When there are 1000 calls left, ghtop will show a warning on every call.

ghtop simple

A simple dump to your console of all events as they happen.

ghtop tail

Like simple, but removes most bots, and only includes releases, issues and PRs (open, close, and comment events). A summary of the frequency of push events is also shown at the bottom of the screen.

ghtop quad

The same information as tail, but in a split window showing separately PRs, issues, pushes, and releases. This view does not remove bot activity.

ghtop users

A summary of activity for the most active current users.


Shared under the MIT license with ♥ by @nat

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 ghtop, version 0.0.8
Filename, size File type Python version Upload date Hashes
Filename, size ghtop-0.0.8-py3-none-any.whl (6.4 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size ghtop-0.0.8.tar.gz (6.6 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page