[Python] Add README #2693
Merged
[Python] Add README #2693
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
kanterov
requested review from
andrewnester,
anton-107,
denik,
pietern and
shreyas-goenka
as code owners
shreyas-goenka
approved these changes
Apr 9, 2025
|
|
||
| Python for Databricks Asset Bundles extends [Databricks Asset Bundles](https://docs.databricks.com/aws/en/dev-tools/bundles/) so that you can: | ||
| - Define jobs and pipelines as Python code. These jobs can coexist with jobs defined in YAML. | ||
| - Dynamically create jobs and pipelines using metadata. |
Contributor
There was a problem hiding this comment.
Could we expand on what we mean by metadata here?
| Python for Databricks Asset Bundles extends [Databricks Asset Bundles](https://docs.databricks.com/aws/en/dev-tools/bundles/) so that you can: | ||
| - Define jobs and pipelines as Python code. These jobs can coexist with jobs defined in YAML. | ||
| - Dynamically create jobs and pipelines using metadata. | ||
| - Modify jobs and pipelines defined in YAML or Python during bundle deployment. |
Contributor
There was a problem hiding this comment.
WDYT?
Suggested change
| - Modify jobs and pipelines defined in YAML or Python during bundle deployment. | |
| - Modify jobs and pipelines defined in YAML or Python during bundle deployment at runtime. |
Collaborator
Author
There was a problem hiding this comment.
We don't want to say runtime, because it can be confused with job runtime that is not true. It was a common source of confusion until we made it very straightforward.
lennartkats-db
approved these changes
Apr 10, 2025
Contributor
lennartkats-db
left a comment
lennartkats-db
left a comment
There was a problem hiding this comment.
Thank you! The main thing here is so maintainers and others exploring the code know what this is about. And this README provides even more info beyond that.
kanterov
added a commit
that referenced
this pull request
Apr 10, 2025
## Changes Add a minimal README that will be used for the PyPi package. ## Why We need to give the PyPi package README in case it gets discovered before CLI.
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.
Changes
Add a minimal README that will be used for the PyPi package.
Why
We need to give the PyPi package README in case it gets discovered before CLI.