Skip to content

[Python] Add README #2693

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kanterov merged 1 commit into from
Apr 10, 2025
Merged

[Python] Add README #2693

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions experimental/python/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# databricks-bundles

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.
Copy link
Contributor

@shreyas-goenka shreyas-goenka Apr 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we expand on what we mean by metadata here?

- Modify jobs and pipelines defined in YAML or Python during bundle deployment.
Copy link
Contributor

@shreyas-goenka shreyas-goenka Apr 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Collaborator Author

@kanterov kanterov Apr 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.


Documentation is available at https://docs.databricks.com/dev-tools/cli/databricks-cli.html.

Reference documentation is available at https://databricks.github.io/cli/experimental/python/

## Getting started

To use `databricks-bundles`, you must first:

1. Install the [Databricks CLI](https://github.com/databricks/cli), version 0.247.1 or above
2. Authenticate to your Databricks workspace if you have not done so already:

```bash
databricks configure
```
3. To create a new project, initialize a bundle using the `experimental-jobs-as-code` template:

```bash
databricks bundle init experimental-jobs-as-code
```

## Privacy Notice
Databricks CLI use is subject to the [Databricks License](https://github.com/databricks/cli/blob/main/LICENSE) and [Databricks Privacy Notice](https://www.databricks.com/legal/privacynotice), including any Usage Data provisions.
Loading