gh-contributors-cli

This command line tool fetches contributors from a given Github repo, and then fetches their user profile plus most recent git commit of each user.

To run it, just download the most recent release and follow the instructions below.

What you need to get going

Java

To make use of this CLI you're expected to have installed the following softwares:

• Java Runtime Environment (aka JRE) 8+

If you new to Java, or to Software Engineering, you should simply try to download it from https://java.com/en/download/

Otherwise, I highly recommend you to manage your Java installations using the awesome https://sdkman.io/

Access Github

Once you have the required software installed (see #requirements) ensure you have access to Github and create a personal access token.

Step to run the tool

1 - Create your personal access token in Github

Create your personal access token in Github

Note: This is a required step in order to run the script without being rate limitted.

2 - Make the required environment variables available

Make GH_FETCH_CONTRIBUTORS_USER and GH_FETCH_CONTRIBUTORS_TOKEN environment variables available

E.g. in a terminal window run:

export GH_FETCH_CONTRIBUTORS_USER=<YOUR_GITHUB_USER_NAME_HERE>
export GH_FETCH_CONTRIBUTORS_TOKEN=<YOUR_GITHUB_ACCESS_TOKNE_HERE>

3 - Run the program

3.a - Using a jar file

There are two options to make use of a jar file.

1. Download the latest release here; or
2. Download it in your terminal using curl -L -o <your-local-file-name-and-destionation> https://github.com/cesarcneto/gh-contributors-cli/releases/download/v0.1.0-snapshot/gh-contributors-cli-0.1.0-SNAPSHOT.jar

In the same terminal window that you ran step #2, run:

java -jar gh-contributors-cli-latest.jar --repo apache/spark

3.b - Using leiningen

In the same terminal window that you ran step #2, run:

lein run gh-contributors-cli.main --repo apache/apark

Once the command run is completed, a file called result.csv should be created at .data/apache/spark (assuming that you provided --repo apache/spark to the script). From this point, you should be able to import this csv file into your favorite spreadsheet tool and have fun! ^.^

IMPORTANT NOTE: This script will keep data cached in .data folder. Make sure you delete the folder whenever you want to fetch data for a given repo again.

Notes

This was originally a Babashka script created here to help hiring managers to reach out to OpenSource contributors.