How to call GitHub REST API from Ubuntu

In brief, I needed to get a list of the members currently in my organization at GitHub.

There are multiple ways to do so, including:

  1. Direct calls to the API from curl
    sudo apt install curl
  2. Python using PyGitHub
    pip install pygithub
  3. Ruby using octokit
    gem install octokit

I tried all 3 and all work in a wonderful way, but I had to choose one eventually

For the simple task I needed of getting members of my GitHub organization, I just used the first method above, using the following call:

curl 'https://api.github.com/orgs/my_organization/members?page=3&per_page=100' -u "myusername:mypassword" >> myoutput.json

Another example for getting a list of the outside collaborators in my organization:

curl 'https://api.github.com/orgs/my_organization/members?page=3&per_page=100' -u "myusername:mypassword" >> myoutput.json

Where:

per_page=100: controls how many records appear per page (pagination), the maximum I could get is 100, so I had to get 2 pages in total.

page=3: The page number in case you have more than 100 records

-u: To add your GitHub username and password, in case the information you request needs authentication

Note: To convert the json to csv, I just went to https://json-csv.com/ and it did a pretty good job for me.

Enjoy!

Sources:

  1. GitHub API V3 Documentation
  2. octokit Documentation
  3. PyGitHub Documentation
  4. Many articles on StackOverflow and ServerFault

About SoCRaT

Research Support and Infrastructure Engineer, OSS & Linux Geek
This entry was posted in Ubuntu, Uncategorized and tagged , , , , , , , , , , . Bookmark the permalink.

One Response to How to call GitHub REST API from Ubuntu

  1. ΞXΤЯ3МΞ says:

    Were is that like button 🙂

    Like

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google+ photo

You are commenting using your Google+ account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s