prefect_github.credentials
¶
Credential classes used to perform authenticated interactions with GitHub
GitHubCredentials
¶
Bases: CredentialsBlock
Block used to manage GitHub authentication.
Attributes:
Name | Type | Description |
---|---|---|
token |
SecretStr
|
the token to authenticate into GitHub. |
Examples:
Load stored GitHub credentials:
from prefect_github import GitHubCredentials
github_credentials_block = GitHubCredentials.load("BLOCK_NAME")
Source code in prefect_github/credentials.py
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 |
|
get_client
¶
Gets an authenticated GitHub GraphQL HTTPEndpoint client.
Returns:
Type | Description |
---|---|
HTTPEndpoint
|
An authenticated GitHub GraphQL HTTPEndpoint client. |
Example
Gets an authenticated GitHub GraphQL HTTPEndpoint client.
from prefect_github import GitHubCredentials
github_credentials = GitHubCredentials(token=token)
client = github_credentials.get_client()
Source code in prefect_github/credentials.py
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 |
|
get_endpoint
¶
Gets an authenticated GitHub GraphQL HTTPEndpoint.
Returns:
Type | Description |
---|---|
HTTPEndpoint
|
An authenticated GitHub GraphQL HTTPEndpoint |
Example
Gets an authenticated GitHub GraphQL HTTPEndpoint.
from prefect import flow
from prefect_github import GitHubCredentials
@flow
def example_get_endpoint_flow():
token = "token_xxxxxxx"
github_credentials = GitHubCredentials(token=token)
endpoint = github_credentials.get_endpoint()
return endpoint
example_get_endpoint_flow()
Source code in prefect_github/credentials.py
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 |
|