FilesExpand file tree

 master

/

github.py

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

98 lines (74 loc) · 3.53 KB

 master

/

github.py

Copy path

Top

File metadata and controls

• Code
• Blame

98 lines (74 loc) · 3.53 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

import requests

# First, make sure to follow the steps to create your own GitHub application:

# https://docs.github.com/en/free-pro-team@latest/developers/apps/creating-an-oauth-app

# REPLACE the following variables with your Client ID and Client Secret

CLIENT_ID = "<REPLACE_WITH_CLIENT_ID>"

CLIENT_SECRET = "<REPLACE_WITH_CLIENT_SECRET>"

# REPLACE the following variable with what you added in the

# "Authorization callback URL" field.

REDIRECT_URI = "<REPLACE_WITH_REDIRECT_URI>"

# In this method you'll ask the GitHub API for a URL to redirect the user

# for authentication.

def create_oauth_link():

params = {

"client_id": CLIENT_ID,

"redirect_uri": REDIRECT_URI,

"scope": "user",

"response_type": "code",

}

# This endpoint is defined in the GitHub documentation:

# https://docs.github.com/en/free-pro-team@latest/developers/apps/authorizing-oauth-apps#1-request-a-users-github-identity

endpoint = "https://github.com/login/oauth/authorize"

response = requests.get(endpoint, params=params)

# When you make the request above, GitHub will redirect you to their

# website to input your credentials. Since you're doing this

# programmatically, you need to get the `url` parameter and print it in

# the console instead.

return response.url

# In this method you'll exchange the code you got from the GitHub API with

# an access token.

def exchange_code_for_access_token(code=None):

params = {

"client_id": CLIENT_ID,

"client_secret": CLIENT_SECRET,

"redirect_uri": REDIRECT_URI,

"code": code,

}

# Here you define the content type you're expecting to get.

# In this case – JSON.

headers = {"Accept": "application/json"}

# This endpoint is defined in the GitHub documentation:

# https://docs.github.com/en/free-pro-team@latest/developers/apps/authorizing-oauth-apps#2-users-are-redirected-back-to-your-site-by-github

endpoint = "https://github.com/login/oauth/access_token"

response = requests.post(endpoint, params=params, headers=headers).json()

return response["access_token"]

# Finally in this method you'll print the user information re. its name,

# username and number of private repositories.

def print_user_info(access_token=None):

# Now you need to send the `access_token` in the headers

# when calling the API.

headers = {"Authorization": f"token {access_token}"}

# This endpoint is defined in the GitHub documentation:

# https://docs.github.com/en/free-pro-team@latest/rest/reference/users#get-the-authenticated-user

endpoint = "https://api.github.com/user"

response = requests.get(endpoint, headers=headers).json()

# The response will be a dictionary with multiple user-related field.

# You can try `print(response)` to see all of them.

name = response["name"]

username = response["login"]

private_repos_count = response["total_private_repos"]

print(

f"{name} ({username}) | "

f"number of private repositories: {private_repos_count}"

)

# So, one last time, step by step:

# 1. Create a link to redirect the user to for authentication:

link = create_oauth_link()

print(f"Follow the link to start the authentication with GitHub: {link}")

# 2. Paste the code you got from GitHub after authenticating

code = input("GitHub code: ")

# 3. Exchange that code with an access token

access_token = exchange_code_for_access_token(code)

print(f"Exchanged code {code} with access token: {access_token}")

# 4. Fetch user information

print_user_info(access_token=access_token)