SSL Metrics - GitHub Issues Analysis
Project description
SSL Metrics GitHub Issues
Using the GitHub Issues REST API, provide insight into a specific GitHub repository issue tracker
Table of Contents
About
This project is a proof of concept demonstration that it is possible to generate useful insights into a GitHub project via it's issue tracker.
Currently, this project generates graphs of:
- Number of open issues against days
- Number of closed issues against days
- Comparison of number of open and closed issues against days
How to Run
Note on Command Line Arguments
See Command Line Arguments for program configuration from the command line
From pip
- Install
Python 3.9.6 +
- (Recommended) Create a virtual environment with
python3.9 -m venv env
and activate it - Run
pip install ssl-metrics-github-issues
- Generate a JSON data set with
ssl-metrics-github-issues-collect -r REPOSITORY -t GH_TOKEN -s FILENAME.json
- Generate graphs with
ssl-metrics-github-issues-graph -i FILENAME.json -o OPEN_ISSUES_GRAPH_FILENAME.* -c CLOSED_ISSUES_GRAPH_FILENAME.* -x JOINT_ISSUES_GRAPH_FILENAME
Command Line Arguments
ssl-metrics-github-issues-collect
-h
,--help
: Shows the help menu and exits-r
,--repository
: GitHub repository to be used. Format needs to be "OWNER/REPO". Default is numpy/numpy-t
,--token
: GitHub personal access token-s
,--save-json
: Save analysis to JSON file
ssl-metrics-github-issues-graph
Note on Graph Export Options
Arguements -c
, -o
, and -x
can be of any of the formats that matplotlibs.pyplot.savefig
function exports to.
-h
,--help
: Shows the help menu and exits-c
,--closed-issues-graph-filename
: The filename of the output graph of closed issues-i
,--input
: The input JSON file that is to be used for graphing-o
,--open-issues-graph-filename
: The filename of the output graph of open issues-x
,--joint-issues-graph-filename
: The filename of the output graph of open and closed issues
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for ssl-metrics-github-issues-0.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2f308bac7f36b06c54b152b097a575b7d00e598f6b9570e33490619b59581106 |
|
MD5 | 09295f92db805b7944a080e110b57a3a |
|
BLAKE2b-256 | 6a608aa679b35dfdc54e8ba4939f2ffddbd1f09c7eaf1de029bf5c61de4846bb |
Close
Hashes for ssl_metrics_github_issues-0.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 93483b8ed3cddce0dd2c7d62b5fa538fb81da817461429292f9890f8f8b14978 |
|
MD5 | 6c77aadebbfad37f1f9836825e0685d2 |
|
BLAKE2b-256 | 4b6131ba3a3942db1f0e971e9eadab6629b180ea0467c0a44e592b9472f4b5c8 |