Simple Flask server app that retrieves user profile details from Github API and processes it using dedicated functions. App returns data for requested user:
- list of repositories (repo name & number of stars)
- sum of stars from all repositories
- three mostly used programming languages (based of number of bytes of code)
Data is returned in JSON and whole app works as REST API.
Fork this repo and clone it to your choosen directory (alternatively you can just download a .zip file and unpack it).
git clone https://github.com/kajarosz/github-api-server-app.git
Install dependencies - required packages are listed in requirements.txt file. You may need to use pip3 instead of just pip.
pip install -r requirements.txt
Run run_app.py file in Python. You may need to use python3 instead of just python.
python run_app.py
Flask web server starts at port 127.0.0.1:5000 by default. In order to access particular API resources follow below schema:
- User repositories list: 127.0.0.1:5000/user/<user_name>/repos
- Sum of user stars: 127.0.0.1:5000/user/<user_name>/stars
- Top 3 languages: 127.0. 0.1:5000/user/<user_name>/top3-languages
<user_name> states for user name, which can be found e.g. in profile URL.
In project directory run:
pytest
This is a simple project designed mostly for personal use - it utilizes Github API without authentication. High traffic is not expected for this app, so I decided that there's no reason to complicate the code. Authentication would require client to privide Github token, which can lead to some unnecessary safety concerns. However, lack of authentication means that app use is limited to 60 requests per hour (Github API limitations). If project grows and there's higher volume of requests, to fullfil client needs authenticated Github API access should be developed.
Another thing to improve would be functional tests (test_routes.py). Right now performing test requires internet connection, because app routes refer to external functions, which request data from Github API. Mockup functions should be developed, so routes functions could consume mockup data output, which would not be denepdent on internet connection or Github API access.