FilesExpand file tree

main

/

auth.py

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

45 lines (39 loc) · 1.76 KB

main

/

auth.py

Copy path

Top

File metadata and controls

• Code
• Blame

45 lines (39 loc) · 1.76 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

"""This is the module that contains functions related to authenticating to GitHub with a personal access token."""

from github import Auth, Github

def auth_to_github(

token: str,

gh_app_id: int | None,

gh_app_installation_id: int | None,

gh_app_private_key_bytes: bytes,

ghe: str,

gh_app_enterprise_only: bool,

) -> Github:

"""

Connect to GitHub.com or GitHub Enterprise, depending on env variables.

Args:

token (str): the GitHub personal access token

gh_app_id (int | None): the GitHub App ID

gh_app_installation_id (int | None): the GitHub App Installation ID

gh_app_private_key_bytes (bytes): the GitHub App Private Key

ghe (str): the GitHub Enterprise URL

gh_app_enterprise_only (bool): Set this to true if the GH APP is created on GHE and needs to communicate with GHE api only

Returns:

Github: the GitHub connection object

"""

ghe = ghe.rstrip("/")

if gh_app_id and gh_app_private_key_bytes and gh_app_installation_id:

app_auth = Auth.AppAuth(int(gh_app_id), gh_app_private_key_bytes.decode())

installation_auth = app_auth.get_installation_auth(int(gh_app_installation_id))

if ghe and gh_app_enterprise_only:

github_connection = Github(base_url=f"{ghe}/api/v3", auth=installation_auth)

else:

github_connection = Github(auth=installation_auth)

elif ghe and token:

github_connection = Github(base_url=f"{ghe}/api/v3", auth=Auth.Token(token))

elif token:

github_connection = Github(auth=Auth.Token(token))

else:

raise ValueError(

"GH_TOKEN or the set of [GH_APP_ID, GH_APP_INSTALLATION_ID, GH_APP_PRIVATE_KEY] environment variables are not set"

)

return github_connection