|
| 1 | +# Github Size-Contributor-List |
| 2 | + |
| 3 | +## What this script accomplishes |
| 4 | + |
| 5 | +- Makes an API call to the, "Github API" in order to retrieve the information needed. It retrieves the size of the repository and the number of contributors the repo has |
| 6 | +- Information is saved to a text file called, "output.txt" |
| 7 | + |
| 8 | +## How ro run script |
| 9 | + |
| 10 | +### 1. Download script and install requests |
| 11 | +``` |
| 12 | +pip install requests |
| 13 | +``` |
| 14 | + |
| 15 | +### 2. Run script.py and specify the name of the github user and name of the repository as follows |
| 16 | +``` |
| 17 | +python script.py -o NAMEOFGITHUBUSER -n NAMEOFGITHUBREPO |
| 18 | +``` |
| 19 | + |
| 20 | +Note that the repo must be owned by the user, otherwise, it will fail. |
| 21 | + |
| 22 | + |
| 23 | +### 3. Output of the script will be written to a text file called, "output.txt". If the script has incorrect values, it won't run. If the script could not gather data, nothing will be written. |
| 24 | + |
| 25 | + |
| 26 | +## Example Output |
| 27 | + |
| 28 | + |
0 commit comments