jakequilty / github-metrics Goto Github PK

PEP8 mandates all lowercase names for modules

AC:

• All module names are lowercase

https://g2.antv.vision/en

Using system-installed libraries is a big no-no for portable python code and for idempotent development so we need to add some info about it into the README

AC:

• README has info on how to use python3 -m venv to isolate the installed libraries for this project

Manual installation of dependencies is discouraged. pip3 should be used for those (which necessitates setup.py and requirements.txt

AC:

• You can use pip to install requirements for this project

This project has some indication of what version of code is running in both CLI and setup.py that is pulled from the same source.

AC:

• We can print out the code version on the CLI
• Code version in setup.py matches the CLI version
• Both version are pulled from the same place (to avoid duplication / desync)

The script hits the 5000 api requests in an hour limit before finishing. Need to either find a way to pull necessary data in less calls, or set up a counter and have it wait....the entire hour.....before continuing when the limit is reached.

Use of "foo" + blah + "bar" type strings is discouraged due to jumble of symbols needing to be visually parsed so we should transition to "foo %s bar".format(blah)"-type formatting strings in code.

AC:

• Composed strings use <string>.format()

Some linting would be good on the codebase

AC:

• Pylint is run on the codebase on PRs

The script is scanning all of the repos in each organization and that is time and API calls that don't need to be spent. Need to make it scan repos only owned by a specific team.

All modules should ideally have some sort of unit test framework (eg. nose2)

AC:

• Code has unit tests

This code should really use objects instead of these patched members of the class for unmarshaling data.

AC:

• Code has ORM-like mapping for PR/Issues

Orgs as well as GH username/password should ideally be retrieved from the CLI with a fallback for env vars. argparse library should help here.

AC:

• Orgs can be specified on the CLI
• Github credentials can be specified on the CLI