| Tags | api github logical-operators |
| Hard Prerequisites | |
| IMPORTANT: Please review these prerequisites, they include important information that will help you with this content. | |
|
|
In this project, you’ll make use of Github’s awesome API. We chose Github for this project because:
Your directory structure should look like this:
├── requirements.txt
└── src
└── consume_github_api.py
Your directory structure should look like this:
├── src
| └── consume_github_api.js
└── package.json
Remember to export your function:
module.exports = { YOUR_FUNCTION_NAME };
Please make use of Gradle from the command line to set up your project. You can learn more about Gradle here:
[TODO] TOPIC: African Coding Network SyllabusWhen you use gradle to create your project, give your project the following name: consume_github_api.
The directory structure should look like this:
├── gradle
│ └── wrapper
│ ├── gradle-wrapper.jar
│ └── gradle-wrapper.properties
├── gradlew
├── gradlew.bat
├── settings.gradle
└── app
├── build.gradle
└── src
└── main
└── java
└── consume_github_api
└── ConsumeGithubAPI.java <-------- names are important
First, get familiar with consuming APIs from the command line. Play with this. Getting started with the Github API V3.
Remember, curl is your friend. And so is man. (try typing in man curl at the command line)
Write a function called “get pull requests”. Make sure you are making use of the appropriate naming convention for the language you are working in.
The function should take in the following arguments:
The function should return a list or array of pull requests on the repo such that the PRs were created, updated, merged or closed between the given two dates.
Play around with this public repo and see if you can make it work.
Example usage:
If you are working in JavaScript we should be able to call your function like this: getPullRequests({ owner, repo, startDate, endDate}). Take note of those curly brackets.
// Javascript
getPullRequests({
owner: "Umuzi-org",
repo: "ACN-syllabus",
startDate: "2022-03-01",
endDate: "2022-03-10",
});
# Python
get_pull_requests(
owner="Umuzi-org",
repo="ACN-syllabus",
startDate="2022-03-01",
endDate="2022-03-10"
)
// Java
getPullRequests(
"Umuzi-org",
"ACN-syllabus",
"2022-03-01",
"2022-03-10"
);
Here is an example of what the final data structure should look like if it was converted into JSON. This isn’t the exact data you should expect, just pay close attention to the structure:
[
{"id": 876359209, "user":"FaithMo", "title":"added data sci and eng info", "state":"open", "created_at":"2022-03-10"},
{"id": 874927260, "user":"ry-oc", "title":"update sololearn python and all contentlinks etc", "state":"closed", "created_at": "2022-03-09"},
{"id": 872630389, "user":"Andy-Nkumane", "title":"added clarity on python error raising", "state":"open", "created_at":"2022-03-07"},
{"id": 872484561, "user":"Kate-bit-dev", "title":"Update _index.md", "state":"closed", "created_at":"2022-03-06"},
{"id": 872482562, "user":"Kate-bit-dev", "title":"Update _index.md", "state":"open", "created_at":"2022-03-06"},
{"id": 872481470, "user":"Kate-bit-dev", "title":"Update _index.md", "state":"closed", "created_at":"2022-03-06"},
{"id": 872480774, "user":"Kate-bit-dev", "title":"Update _index.md", "state":"closed", "created_at":"2022-03-06"},
{"id": 872480210, "user":"Kate-bit-dev", "title":"Update _index.md", "state":"closed", "created_at":"2022-03-06"},
...
]
Note that:
If the function is called with an “owner” that does not exist then the function should raise/throw and error. The error should include the following info:
owner argumentFor example “repository owner snoopdoggiedog not found”.
If the owner is found but the repo seems to not exist then raise or throw an appropriate error.
Errors have been implemented in every modern language (even this one) because they are really useful. An error/exception is great because it tells a programmer:
A good error message tells a programmer exactly what is wrong and how to fix it.
A good programmer doesn’t just catch errors and squash them thoughtlessly. And a good programmer puts effort into writing good error messages.
Pagination is a process that is used to divide a large dataset into smaller chunks (pages).
It is there to allow us to efficiently query through large data one page at a time. This means we are able to gradually fetch the data we need with little to no performance issues on both the client and server. For example, without pagination you would have to load an entire chat history just to see the latest message sent to you.
Please implement pagination. Your get_pull_requests function should return a list/array of ALL the matching pull requests, not just the first page.
Please fetch the maximum number of PRs per page(100) to avoid making too many api calls.
Repos on Github can either be public or private. If you are trying to access a private repository then you’ll need to authenticate using a token. Kindly generate the classic token and not the fine-grained token for this project authentication.
Upgrade your code so that It makes use of an environmental variable called GITHUB_TOKEN.
If the token is provided then it should ALWAYS be included in the header of requests sent to Github. If it is not provided then it should not be included.
state and title property may not be the exact same).