README.md

Github-Metrics

Repo for developing a tool to visualize Github metrics from developers

Installing

Creating access to your account

First create a token on Github, you only have to tick read privileges, no need to write. After the token has been created, download this repo, insert the value on sample.ini and rename file to config.ini. Now, if you don't have, install Python 3.6.7 or higher.

Setting up your environment

After installing, all you have to do is create a virtual environment, activate the env and install everything on requirements.txt using pip install requirements.txt and run inv run. For more information, use inv -l.

To Do

Things to do to improve tool:

Backend

UNIX to utc timestamp

• Choose organization to collect data
• Collect info (mainly commits) from all users on said organization [get_stats_contributors]
  • Added lines
  • Removed lines
  • Commits
• Collect info from all users on organization with determined period (N weeks, N months, etc)

Frontend

Chart.js

Lines chart

Use Django with Chart.js

• Show collected info from user on a simple web page (raw info)
  • Amount of commits
  • Amount of PRs
  • Amount of merged PRs
  • Amount of created issues
  • Amount of closed issues
  • Amount of code reviews
• Show collected info from user on a graphic
  • Commits x Date
• Show collected info from all users on a single graphic
  • Commits x Date

Interesting links

• https://stackoverflow.com/questions/9058305/getting-attributes-of-a-class