skip to navigation
skip to content

ghstats 1.1.1

GitHub Release download count and other statistics.

Description

  • Python script to obtain GitHub Release download count and other statistics.
  • Can be used as both a standalone script and a Python module.
  • Supports both Python 2 and 3 out of the box.

Installation

You can get ghstats using one of the following methods:

Usage

ghstats [user] [repo] [tag] [options]
ghstats [user/repo] [tag] [options]
  • Arguments:
Argument Description
user Repository owner. If not present, user will be prompted for input.
repo Repository title. If not present, user will be prompted for input.
tag Release tag name. If not present, prints the total number of downloads.
  • Options:
Option Description
-d, --detail Print detailed statistics for release(s).
-q, --quiet Print only resulting numbers and errors. Overrides -d option.
-l, --latest Get stats for the latest release. Tag argument will be ignored.
-h, --help Show help on script usage.
  • Environment Variables:
Environment Variable Description
GITHUB_TOKEN GitHub OAuth token. Use to increase API request limit.

Examples

Examples for atom/atom repository:

ghstats atom atom            # Fetch download count for all releases.
ghstats atom/atom            # Fetch download count for all releases (alt. syntax).
ghstats atom atom -q         # Quiet mode (print only numerical result).
ghstats atom atom -d         # Detailed description for every release.
ghstats atom atom -l         # Fetch download count for the latest release.
ghstats atom atom -l -d      # Detailed description for the latest release.
ghstats atom atom -l -q      # Quiet mode for the latest release.
ghstats atom atom v1.0.0     # Fetch download count for "v1.0.0" release.
ghstats atom atom v1.0.0 -d  # Detailed description for "v1.0.0" release.
ghstats atom atom v1.0.0 -q  # Quiet mode for "v1.0.0" release.
ghstats                      # Get input for username and repository from user.
ghstats -h                   # Print help.

Changelog

v1.1.1

v1.1.0

  • Fix error on Unicode titles (issue #1).
  • Fix error on draft release (issue #4).

v1.0.1

v1.0.0

  • Initial release.

License

MIT License

You are free to use, modify, distribute (including commercial purposes) as long as you credit the original author and include the license text.

License text: MIT License

 
File Type Py Version Uploaded on Size
ghstats-1.1.1-py2.py3-none-any.whl (md5) Python Wheel py2.py3 2016-09-27 8KB
ghstats-1.1.1.tar.gz (md5) Source 2016-09-27 6KB