Command line interface for working with projects.
clone
async
Clone an existing project for a given deployment.
Source code in src/prefect/cli/project.py
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141 | @project_app.command()
async def clone(
deployment_name: str = typer.Option(
None,
"--deployment",
"-d",
help="The name of the deployment to clone a project for.",
),
deployment_id: str = typer.Option(
None,
"--id",
"-i",
help="The id of the deployment to clone a project for.",
),
):
"""
Clone an existing project for a given deployment.
"""
if deployment_name and deployment_id:
exit_with_error(
"Can only pass one of deployment name or deployment ID options."
)
if not deployment_name and not deployment_id:
exit_with_error("Must pass either a deployment name or deployment ID.")
if deployment_name:
async with get_client() as client:
try:
deployment = await client.read_deployment_by_name(deployment_name)
except ObjectNotFound:
exit_with_error(f"Deployment {deployment_name!r} not found!")
else:
async with get_client() as client:
try:
deployment = await client.read_deployment(deployment_id)
except ObjectNotFound:
exit_with_error(f"Deployment {deployment_id!r} not found!")
if not deployment.pull_steps:
exit_with_error("No pull steps found, exiting early.")
# TODO: allow for passing values between steps / stacking them
for step in deployment.pull_steps:
output = await run_step(step)
app.console.out(output["directory"])
|
init
async
Initialize a new project.
Source code in src/prefect/cli/project.py
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 | @project_app.command()
async def init(name: str = None, recipe: str = None):
"""
Initialize a new project.
"""
try:
files = [
f"[green]{fname}[/green]"
for fname in initialize_project(name=name, recipe=recipe)
]
except ValueError as exc:
if "Unknown recipe" in str(exc):
exit_with_error(
f"Unknown recipe {recipe!r} provided - run [yellow]`prefect project"
" recipe ls`[/yellow] to see all available recipes."
)
else:
raise
files = "\n".join(files)
empty_msg = (
f"Created project in [green]{Path('.').resolve()}[/green]; no new files"
" created."
)
file_msg = (
f"Created project in [green]{Path('.').resolve()}[/green] with the following"
f" new files:\n {files}"
)
app.console.print(file_msg if files else empty_msg)
|
ls
async
List available recipes.
Source code in src/prefect/cli/project.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 | @recipe_app.command()
async def ls():
"""
List available recipes.
"""
recipe_paths = prefect.__module_path__ / "projects" / "recipes"
recipes = {}
for recipe in recipe_paths.iterdir():
if recipe.is_dir() and (recipe / "prefect.yaml").exists():
with open(recipe / "prefect.yaml") as f:
recipes[recipe.name] = yaml.safe_load(f).get(
"description", "(no description available)"
)
table = Table(
title="Available project recipes",
caption=(
"Run `prefect project init --recipe <recipe>` to initialize a project with"
" a recipe."
),
caption_style="red",
)
table.add_column("Name", style="green", no_wrap=True)
table.add_column("Description", justify="left", style="white", no_wrap=False)
for name, description in sorted(recipes.items(), key=lambda x: x[0]):
table.add_row(name, description)
app.console.print(table)
|
register_flow
async
Register a flow with this project.
Source code in src/prefect/cli/project.py
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177 | @project_app.command()
async def register_flow(
entrypoint: str = typer.Argument(
...,
help=(
"The path to a flow entrypoint, in the form of"
" `./path/to/file.py:flow_func_name`"
),
),
force: bool = typer.Option(
False,
"--force",
"-f",
help=(
"An optional flag to force register this flow and overwrite any existing"
" entry"
),
),
):
"""
Register a flow with this project.
"""
try:
flow = await register(entrypoint, force=force)
except Exception as exc:
exit_with_error(exc)
app.console.print(
(
f"Registered flow {flow.name!r} in"
f" {(find_prefect_directory()/'flows.json').resolve()!s}"
),
style="green",
)
|