feat : Add SDK support for YAML-based deployments via deploy_from_yaml#21424
Open
harsh21234i wants to merge 1 commit intoPrefectHQ:mainfrom
Open
feat : Add SDK support for YAML-based deployments via deploy_from_yaml#21424harsh21234i wants to merge 1 commit intoPrefectHQ:mainfrom
harsh21234i wants to merge 1 commit intoPrefectHQ:mainfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
I was exploring this issue and noticed that YAML-based deployments are currently only available through the CLI. This PR adds a simple SDK function
deploy_from_yamlso the same thing can be done directly from Python.What I did
deploy_from_yaml(path: str)RunnerDeploymentand called.apply()prefect.deploymentsWhy this change
Right now, if someone wants to use
prefect.yamlinside a Python workflow, they either have to call the CLI or use internal/private methods. This felt like a gap since most of the logic already exists — it just isn’t exposed in the SDK.This PR basically bridges that gap in a simple way.
Example
from prefect.deployments import deploy_from_yaml
deploy_from_yaml("prefect.yaml")
Notes
_load_deploy_configs_and_actionsto avoid duplicating parsing logicDummyConsoleto avoid CLI-specific behaviorFuture improvements (optional)
Closes #19503