Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/percival33/github-api
API retrieving specific data from GithubAPI
https://github.com/percival33/github-api
api fastapi github-api python3
Last synced: 2 days ago
JSON representation
API retrieving specific data from GithubAPI
- Host: GitHub
- URL: https://github.com/percival33/github-api
- Owner: Percival33
- License: mit
- Created: 2022-04-22T11:10:22.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-07-14T16:15:29.000Z (over 2 years ago)
- Last Synced: 2024-11-22T20:37:25.551Z (2 months ago)
- Topics: api, fastapi, github-api, python3
- Language: Python
- Homepage:
- Size: 49.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Github API
## About
> *This is a former recruitment task for devops intern position.*
Task was to create API which returns specific data about GitHub user using [GitHub REST API](https://docs.github.com/en/rest).
I've used [FastAPI](https://fastapi.tiangolo.com/) to create this project. I assumed this API will be only used on local machine, so every request made is authorized with Github credentials (if present).
## Installation
1. You need to have [python3](https://wiki.python.org/moin/BeginnersGuide/Download) and [pip](https://pip.pypa.io/en/stable/installation/#get-pip-py) installed on your machine. Firstly, clone the repo.
2. Change directory to folder with code. Then create new virtual environment `env` and activate it. If you don't have this package use this [link](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/) to install it.
```bash
python3 -m venv env
source env/bin/activate
```
Now you should see (env) next to prompt symbol (usually `$` sign for normal user).
3. Install dependencies and you're ready to go!
```bash
pip install -r requirements.txt
```
4. Start your server locally.
```bash
uvicorn api.main:app
```
Server is available at [127.0.0.1:8000](http://127.0.0.1:8000)!
If everything goes correctly after navigating `localhost:8000` , this is what you should see on screen to make sure everything has been setup correctly.
```json
{
"response": "It works!",
"meta": {
"limit": 0,
"remaining": 0,
"reset": 0,
"used": 0
}
}
```
After using API, turn off `virtualenv` using:
```bash
deactivate
```
## Usage
To avoid rate limit for unauthorized user from GitHub API, authenticate by creating `credentials.json`. See [creating credentials](#github-api-authorization).
1. One option is to go to [/docs](http://127.0.0.1:8000/docs) and use Swagger UI to use API
2. Other one is to make requests to endpoints in your favourite way
## API Reference
Every correct endpoint returns JSON response structured like this:
```json
{
"response": {},
"meta": {
"limit": "[int]",
"remaining": "[int]",
"reset": "[UTC epoch time in seconds]",
"used": "[int]"
}
}
```
While endpoints which do not make request to GitHub API, holds zeros in meta fields.
| Status code | Description |
| :---------: | :----------------------------------------------------- |
| `401` | Returned when no credentials or invalid are passed |
| `403` | Returned when Github API rate limit is hit |
| `404` | Returned when no data is found |
| `500` | Returned when this API or Github API are not available |
| `200` | Returned in all other situations |
To take a look on full documentation about API, you can get it at [/docs](http://127.0.0.1:8000/docs)
## GitHub API authorization
To increase your rate limit to 5000 requests per hour, authentication is needed. To do so, GitHub username and [Personal Access Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) are needed. Your token does not require any authorizations. To be automatically authorized create `credentials.json` file structured like this:
```json
{
"user": "your_github_username",
"token": "personal_access_token"
}
```
and restart server.
### Running tests and checks
To run tests or linter, make sure you are in main directory, installed `requirements.txt` and just type:
**Make sure `env` is still enabled**.
- run tests
```bash
pytest
```
- to run linter `flake8` type:
```bash
flake8 --exclude env/
```
## TODO (in the future)
- [ ] add unit tests
- [ ] add API tests