Metrics Dashboard

A tool to calculate metrics on GitHub repositories.

Table of Contents

• Metrics Dashboard
  • Table of Contents
  • About
  • Developing for Metrics Dashboard
    • Steps to start developing for Metrics Dashboard in VS Code
    • Software needed to develop for Metrics Dashboard WITHOUT VS Code
  • Running Metrics Dashboard

About

Metrics Dashboard is an open source project created by the Loyola University Chicago Software and Systems Laboratory.

For a full project abstract as well as academic papers written on this project, see this project page

Developing for Metrics Dashboard

Steps to start developing for Metrics Dashboard in VS Code

NOTE: The steps listed here assume that you have VS Code installed. If not, scroll down to the next section to see a list of software that needs to be installed to develop for this project.

Requirements for developing Metrics Dashboard in VS Code:

• Docker
• Remote Containers extension from Microsoft

Steps:

1. Fork this project
2. Open the Metrics Dashboard project
3. When prompted, open the project within the Development Container

Software needed to develop for Metrics Dashboard WITHOUT VS Code

Requirements for developing Metrics Dashboard:

• Python 3.9+
• Pip
• The contents of .devcontainer/requirements.txt
  • black
  • colorama
  • flask
  • isort
  • pandas
  • requests
  • sphinx
  • sphinx-rtd-theme
  • travis-sphinx
  • tqdm

Steps: 0: Fork this project

1. Open this project in your favorite text editor or IDE

Running Metrics Dashboard

NOTE: At this point, Metrics Dashboard is entirely written in Python 3.9+ compatible code. NOTE: At this point, Metrics Dashboard is only capable of downloading and storing data from a repository.

Requirements for running Metrics Dashboard:

• Python 3.9+
• Pip
• The contents of .devcontainer/requirements.txt
  • black
  • colorama
  • flask
  • isort
  • pandas
  • requests
  • sphinx
  • sphinx-rtd-theme
  • travis-sphinx
  • tqdm
• GitHub Personal Access Token with repo scopes at the minimum

Steps: 0. Fork this project

1. Open this project in a terminal or command line interface
2. Change directory to Data-Collection
3. Run python dataCollection.py -u URL -t GITHUB_TOKEN -o DATABASE.db
   • URL is the GitHub URL of the project formatted like: https://github.com/USERNAME/REPOSITORY
   • GITHUB_TOKEN is the GitHub Personal Access Token
   • DATABASE is the filename of the database file.
     • NOTE: The database file needs to end in .db otherwise the program WILL NOTE WORK