alphagov / learning-time-RA-sem1

Early talent assigned learning time, Semester 1 project for RyanAndrews99.
1 stars 1 forks source link

Programatically retrieve many data points about DI repos using Github API (MVP 1) #3

Open Ryan-Andrews99 opened 1 year ago

Ryan-Andrews99 commented 1 year ago

What:

I will be able to read from a YAML file, containing DI/OneLogin Repos (found here [https://github.com/alphagov/digital-identity-team-manual/blob/main/data/repos.yml] ) . I will extract the repo names from this and use these to programatically make api calls to the github API

Why:

This will allow me to retrieve data about all DI repos from github, enabling me to build a web app to present the data.

How (ACs/ Tech notes):

When: A GET request is made to the GitHub API with the list of repo names I: receive the requested data for each repo And: This data is written out to a single JSON file.

Notes:

This data should include:

  • What languages are they written in?
    • This is in the Github API
  • What package managers are they using?
    • Need to confirm if this is in the API directly
  • What versions of languages are they using?
    • Need to confirm if this is in the API directly
  • What dependencies do they use?
    • API includes some mention of dependencies, will update accordingly This should also be able to handle unexpected data shapes, and handle errors/ rate limits.