mirror of
https://github.com/TheAlgorithms/Python.git
synced 2024-11-24 05:21:09 +00:00
098f02bc04
* fixes #3944 authentication error * Fixes: #3944 authentication error * Fixed docstring failure in pre-commit, Fixed request.get params to GitHub REST API standards * run black formatter * Add USER_TOKEN constant and checks if empty, removes deprecated docstring * Add descriptive dict type hint, change headers format to f-string * Add Accept header * Fix pre-commit error * Fix pre-commit error * Add test for fetch_github_info * Remove test function from main file * Create test_fetch_github_info.py * Update test_fetch_github_info.py * Update test_fetch_github_info.py * No need to cover __name__ == __main__ block Co-authored-by: Dhruv Manilawala <dhruvmanila@gmail.com>
51 lines
1.4 KiB
Python
51 lines
1.4 KiB
Python
#!/usr/bin/env python3
|
|
"""
|
|
Created by sarathkaul on 14/11/19
|
|
Updated by lawric1 on 24/11/20
|
|
|
|
Authentication will be made via access token.
|
|
To generate your personal access token visit https://github.com/settings/tokens.
|
|
|
|
NOTE:
|
|
Never hardcode any credential information in the code. Always use an environment
|
|
file to store the private information and use the `os` module to get the information
|
|
during runtime.
|
|
|
|
Create a ".env" file in the root directory and write these two lines in that file
|
|
with your token::
|
|
|
|
#!/usr/bin/env bash
|
|
export USER_TOKEN=""
|
|
"""
|
|
import os
|
|
from typing import Any, Dict
|
|
|
|
import requests
|
|
|
|
BASE_URL = "https://api.github.com"
|
|
|
|
# https://docs.github.com/en/free-pro-team@latest/rest/reference/users#get-the-authenticated-user
|
|
AUTHENTICATED_USER_ENDPOINT = BASE_URL + "/user"
|
|
|
|
# https://github.com/settings/tokens
|
|
USER_TOKEN = os.environ.get("USER_TOKEN", "")
|
|
|
|
|
|
def fetch_github_info(auth_token: str) -> Dict[Any, Any]:
|
|
"""
|
|
Fetch GitHub info of a user using the requests module
|
|
"""
|
|
headers = {
|
|
"Authorization": f"token {auth_token}",
|
|
"Accept": "application/vnd.github.v3+json",
|
|
}
|
|
return requests.get(AUTHENTICATED_USER_ENDPOINT, headers=headers).json()
|
|
|
|
|
|
if __name__ == "__main__": # pragma: no cover
|
|
if USER_TOKEN:
|
|
for key, value in fetch_github_info(USER_TOKEN).items():
|
|
print(f"{key}: {value}")
|
|
else:
|
|
raise ValueError("'USER_TOKEN' field cannot be empty.")
|