Added `databricks apps run-local` command to run Databricks apps locally by andrewnester · Pull Request #2555 · databricks/cli

andrewnester · 2025-03-24T16:12:54Z

Changes

Added databricks apps run-local command to run Databricks apps locally.
This command allows to start the Databricks app locally. It starts app proxy which is used to proxy request to the app itself and injects necessary Databricks app related headers.

The command support the following options:

--prepare-environment: will setup Python virtual environment and install necessary libraries. It uses uv
--debug: starts a Python debugger (based on debugpy) which allows you to attach your IDE debugger to running app.
--port: allows to configure which port to start proxy on
--entry-point: allows to configure which YAML file to use for Databricks app configuration.

Tests

Added acceptance test

pietern · 2025-04-30T07:34:23Z

+ }
+ return errors.New("process killed after timeout")
+ }
+	}


For follow-up: some wrappers accept a double SIGINT to force kill the wrapped process. With the current approach, the user has to wait for 15 seconds if the wrapped process ignores SIGINT.

Co-authored-by: Pieter Noordhuis <pieter.noordhuis@databricks.com>

## Release v0.250.0 ### Notable Changes * Added inline script execution support to bundle run. You can now run scripts in the same authentication context as a DAB using the databricks bundle run command. ([#2413](#2413)) ### Dependency updates * Upgrade TF provider to 1.75.0 ([#2775](#2775)) * Upgrade Go SDK to 0.65.0 ([#2786](#2786)) ### CLI * Added `databricks apps run-local` command to run Databricks apps locally ([#2555](#2555)) ### Bundles * Raise an error when Unity Catalog volumes are used for paths other than artifacts ([#2754](#2754)) * Fixed issue with jobs and pipelines declared in Python not showing in "Bundle resource explorer" in VSCode ([#2764](#2764)) * Made `experimental/python/mutators` and `experimental/python/resources` fields optional in JSON schema ([#2761](#2761)) * Annotated deprecated fields in JSON schema ([#2770](#2770))

…lly (#2555) ## Changes Added `databricks apps run-local` command to run Databricks apps locally. This command allows to start the Databricks app locally. It starts app proxy which is used to proxy request to the app itself and injects necessary Databricks app related headers. The command support the following options: * `--prepare-environment`: will setup Python virtual environment and install necessary libraries. It uses `uv` * `--debug`: starts a Python debugger (based on debugpy) which allows you to attach your IDE debugger to running app. * `--port`: allows to configure which port to start proxy on * `--entry-point`: allows to configure which YAML file to use for Databricks app configuration. ## Tests Added acceptance test  --------- Co-authored-by: shreyas-goenka <88374338+shreyas-goenka@users.noreply.github.com> Co-authored-by: Pieter Noordhuis <pieter.noordhuis@databricks.com>

## Release v0.250.0 ### Notable Changes * Added inline script execution support to bundle run. You can now run scripts in the same authentication context as a DAB using the databricks bundle run command. ([#2413](#2413)) ### Dependency updates * Upgrade TF provider to 1.75.0 ([#2775](#2775)) * Upgrade Go SDK to 0.65.0 ([#2786](#2786)) ### CLI * Added `databricks apps run-local` command to run Databricks apps locally ([#2555](#2555)) ### Bundles * Raise an error when Unity Catalog volumes are used for paths other than artifacts ([#2754](#2754)) * Fixed issue with jobs and pipelines declared in Python not showing in "Bundle resource explorer" in VSCode ([#2764](#2764)) * Made `experimental/python/mutators` and `experimental/python/resources` fields optional in JSON schema ([#2761](#2761)) * Annotated deprecated fields in JSON schema ([#2770](#2770))

andrewnester requested review from anton-107, denik, pietern and shreyas-goenka as code owners March 24, 2025 16:12

andrewnester temporarily deployed to test-trigger-is March 24, 2025 16:12 — with GitHub Actions Inactive

andrewnester changed the title ~~Feature/local app run~~Added databricks apps run-local command to run Databricks apps locallyMar 24, 2025

andrewnester temporarily deployed to test-trigger-is March 24, 2025 16:14 — with GitHub Actions Inactive

andrewnester temporarily deployed to test-trigger-is March 25, 2025 14:57 — with GitHub Actions Inactive

andrewnester temporarily deployed to test-trigger-is March 25, 2025 15:02 — with GitHub Actions Inactive

andrewnester temporarily deployed to test-trigger-is March 25, 2025 15:28 — with GitHub Actions Inactive

andrewnester temporarily deployed to test-trigger-is March 25, 2025 16:35 — with GitHub Actions Inactive

andrewnester temporarily deployed to test-trigger-is March 25, 2025 17:07 — with GitHub Actions Inactive

andrewnester temporarily deployed to test-trigger-is March 26, 2025 10:42 — with GitHub Actions Inactive

andrewnester temporarily deployed to test-trigger-is March 26, 2025 10:54 — with GitHub Actions Inactive

andrewnester temporarily deployed to test-trigger-is March 26, 2025 12:16 — with GitHub Actions Inactive

andrewnester force-pushed the feature/local-app-run branch from b0d93ba to 38a9da0Compare March 26, 2025 12:25

andrewnester temporarily deployed to test-trigger-is March 26, 2025 12:25 — with GitHub Actions Inactive

andrewnester temporarily deployed to test-trigger-is March 26, 2025 12:39 — with GitHub Actions Inactive

andrewnester temporarily deployed to test-trigger-is March 26, 2025 12:59 — with GitHub Actions Inactive

andrewnester temporarily deployed to test-trigger-is March 26, 2025 13:27 — with GitHub Actions Inactive

denik reviewed Apr 1, 2025
View reviewed changes

Comment threadacceptance/cmd/workspace/apps/run-local/script Outdated
Comment threadlibs/apps/python.go Outdated

andrewnester temporarily deployed to test-trigger-is April 1, 2025 15:04 — with GitHub Actions Inactive

andrewnester temporarily deployed to test-trigger-is April 1, 2025 15:30 — with GitHub Actions Inactive

andrewnester temporarily deployed to test-trigger-is April 1, 2025 15:38 — with GitHub Actions Inactive

andrewnester temporarily deployed to test-trigger-is April 1, 2025 15:42 — with GitHub Actions Inactive

andrewnester force-pushed the feature/local-app-run branch from d8c46e8 to 49cec06Compare April 2, 2025 11:45

andrewnester added 4 commits April 2, 2025 13:45

Added httpproxy.Proxy library
8d7d2f3

update error message assertion for windows
2d2ec25

Added databricks apps run-local command to run Databricks apps locally
5ba6803

-
2550e2b

andrewnester temporarily deployed to test-trigger-is April 29, 2025 10:39 — with GitHub Actions Inactive

Merge branch 'main' into feature/local-app-run
1448e31

andrewnester temporarily deployed to test-trigger-is April 29, 2025 10:40 — with GitHub Actions Inactive

added changelog
24d38bb

andrewnester temporarily deployed to test-trigger-is April 29, 2025 10:41 — with GitHub Actions Inactive

fix
63af0bd

andrewnester temporarily deployed to test-trigger-is April 29, 2025 11:51 — with GitHub Actions Inactive

andrewnester requested review from pietern and shreyas-goenka April 29, 2025 11:52

pietern reviewed Apr 29, 2025
View reviewed changes

Comment threadlibs/apps/headers.go
Comment threadlibs/apps/python.go Outdated
Comment threadlibs/apps/python.go
Comment threadlibs/apps/python.go
Comment threadlibs/apps/spec.go

-
586d9d3

andrewnester temporarily deployed to test-trigger-is April 29, 2025 15:01 — with GitHub Actions Inactive

fix lint
b54677f

andrewnester temporarily deployed to test-trigger-is April 29, 2025 15:06 — with GitHub Actions Inactive

add spec test
10beed0

andrewnester temporarily deployed to test-trigger-is April 29, 2025 15:17 — with GitHub Actions Inactive

andrewnester requested a review from pietern April 29, 2025 15:17

pietern approved these changes Apr 30, 2025
View reviewed changes

Update NEXT_CHANGELOG.md
fb3d640
Co-authored-by: Pieter Noordhuis <pieter.noordhuis@databricks.com>

andrewnester temporarily deployed to test-trigger-is April 30, 2025 08:51 — with GitHub Actions Inactive

-
19e7fcc

andrewnester temporarily deployed to test-trigger-is April 30, 2025 09:07 — with GitHub Actions Inactive

andrewnester enabled auto-merge April 30, 2025 09:08

andrewnester disabled auto-merge April 30, 2025 12:12

andrewnester merged commit e210a27 into mainApr 30, 2025

andrewnester deleted the feature/local-app-run branch April 30, 2025 12:12

denik reviewed Apr 30, 2025
View reviewed changes

Comment threadacceptance/cmd/workspace/apps/run-local/script

Navigation Menu

Uh oh!

Added `databricks apps run-local` command to run Databricks apps locally - #2555

Added `databricks apps run-local` command to run Databricks apps locally#2555
andrewnester merged 20 commits into
mainfrom
feature/local-app-run

andrewnester commented Mar 24, 2025•
edited
Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pieternApr 30, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

andrewnester commented Mar 24, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Tests

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pieternApr 30, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

andrewnester commented Mar 24, 2025•
edited
Loading