prefect_bitbucket.credentials
¶
Module to enable authenticate interactions with BitBucket.
BitBucketCredentials
¶
Bases: CredentialsBlock
Store BitBucket credentials to interact with private BitBucket repositories.
Attributes:
Name | Type | Description |
---|---|---|
token |
Optional[SecretStr]
|
An access token to authenticate with BitBucket. This is required for accessing private repositories. |
username |
Optional[str]
|
Identification name unique across entire BitBucket site. |
password |
Optional[SecretStr]
|
The password to authenticate to BitBucket. |
url |
str
|
The base URL of your BitBucket instance. |
Examples:
Load stored BitBucket credentials:
from prefect_bitbucket import BitBucketCredentials
bitbucket_credentials_block = BitBucketCredentials.load("BLOCK_NAME")
Source code in prefect_bitbucket/credentials.py
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 99 100 101 102 103 104 105 106 107 108 109 110 111 |
|
get_client
¶
Get an authenticated local or cloud Bitbucket client.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
client_type |
Union[str, ClientType]
|
Whether to use a local or cloud client. |
required |
Returns:
Type | Description |
---|---|
Union[Cloud, Bitbucket]
|
An authenticated Bitbucket client. |
Source code in prefect_bitbucket/credentials.py
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 |
|
ClientType
¶
Bases: Enum
The client type to use.
Source code in prefect_bitbucket/credentials.py
21 22 23 24 25 |
|