prefect.deployments.base
¶
Core primitives for managing Prefect deployments via prefect deploy
, providing a minimally opinionated
build system for managing flows and deployments.
To get started, follow along with the deloyments tutorial.
configure_project_by_recipe
¶
Given a recipe name, returns a dictionary representing base configuration options.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
recipe |
str
|
the name of the recipe to use |
required |
formatting_kwargs |
dict
|
additional keyword arguments to format the recipe |
{}
|
Raises:
Type | Description |
---|---|
ValueError
|
if provided recipe name does not exist. |
Source code in prefect/deployments/base.py
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 |
|
create_default_prefect_yaml
¶
Creates default prefect.yaml
file in the provided path if one does not already exist;
returns boolean specifying whether a file was created.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
the name of the project; if not provided, the current directory name will be used |
None
|
contents |
dict
|
a dictionary of contents to write to the file; if not provided, defaults will be used |
None
|
Source code in prefect/deployments/base.py
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 112 113 114 115 116 117 118 |
|
initialize_project
¶
Initializes a basic project structure with base files. If no name is provided, the name of the current directory is used. If no recipe is provided, one is inferred.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
the name of the project; if not provided, the current directory name |
None
|
recipe |
str
|
the name of the recipe to use; if not provided, one is inferred |
None
|
inputs |
dict
|
a dictionary of inputs to use when formatting the recipe |
None
|
Returns:
Type | Description |
---|---|
List[str]
|
List[str]: a list of files / directories that were created |
Source code in prefect/deployments/base.py
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 |
|