Skip to main content

Run databricks operations across multiple workspaces from a single terse CLI.

Project description

sleepybricks

sleepybricks is a succinct Typer-based CLI that wraps the databricks SDK to run operations across multiple workspaces at once.

It authenticates by reading profiles from ~/.databrickscfg (the same file the databricks CLI uses) and gives a graceful error when that file or a requested profile is missing.

Authentication

Every command takes a comma-separated profile_list (e.g. dev,stg,us) naming profiles defined in ~/.databrickscfg. Create that file with the databricks CLI if you don't have one:

databricks configure --token   # repeat once per workspace/profile

Install

Install the CLI globally with uv:

uv tool install sleepybricks

Commands

Command Description
dash-links <dashboard_name> <profiles> Print the published link for a dashboard in each workspace.
sql -s "<sql>" <profiles> / sql -f <file.sql> <profiles> Execute raw sql or a file on the serverless warehouse set in sleepyconfig.
write-secret <scope> <key> <value> <profiles> Write a secret into an existing scope in each workspace.
write-secret <scope>.<key> <value> <profiles> Same, using the dotted shorthand.
create-scope <scope_name> <profiles> Create a secret scope in each workspace (skips existing).
pull-repo <repo_name> <profiles> Pull the latest commit for a git repo in each workspace.
run-job <job_name> <profiles> Trigger a job by exact name in each workspace (skips if the name is not unique).
create-workspace-folder <folder_name> <profiles> Create a workspace folder in each workspace (skips existing).
sleepybricks dash-links "Scheduled Triage Device Metrics" "dev,eu"
sleepybricks sql -s "select * from my_tbl" "dev,stg,us"
sleepybricks sql -f "./query.sql" "dev,stg"
sleepybricks write-secret my_scope.api_key "s3cret" "dev,stg"
sleepybricks pull-repo databricks_templates "dev,stg,us"
sleepybricks run-job "Nightly ETL" "dev,stg"
sleepybricks create-workspace-folder databricks_templates "dev,stg,us"
sleepybricks --help

Dashboard names are matched case-sensitively and are not unique in databricks; the first match per workspace is used and a warning is shown when duplicates exist. run-job also matches job names case-sensitively, but because job names are not unique it will not run anything in a workspace where more than one job shares the exact name — it reports the count instead. The sql command needs a serverless SQL warehouse in each workspace — see Configuration below.

Configuration

sleepybricks is a sleepy util and reads its settings from the shared ~/sleepyconfig/params.yml. Each sleepy util owns only its own <tool>_<name> keys; sleepybricks uses the bricks_ prefix. If the file is absent, sleepybricks writes only its own section below and prints a note. If a value it needs is missing, it prints this snippet and asks you to verify your config. Keys:

  • bricks_table_styletabulate table style used for all output (e.g. simple, rounded_grid, github).
  • bricks_serverless_warehouse_name — name of the serverless SQL warehouse used for compute. The <env> token is replaced with the active profile name, so the default <env>_serverless_warehouse resolves to dev_serverless_warehouse for the dev profile. Use a static value (no token) if your warehouse name is the same everywhere.
  • bricks_env_emojis — per-profile emoji used to decorate output labels.
  • bricks_display_names — per-profile friendly name used in output labels.
# sleepybricks
bricks_table_style: simple
bricks_serverless_warehouse_name: <env>_serverless_warehouse
bricks_env_emojis:
  dev: "👩‍💻"
  stg: "🔧"
  us: "🇺🇸"
bricks_display_names:
  dev: "Development"
  stg: "Staging"
  us: "United States"

Development

Create the environment and install in editable mode with uv:

uv venv
uv pip install -e ".[dev]"

Then run uv run pytest, or ./tools/test.sh. Tests use fakes for the databricks client and never touch a real workspace. Tear down with rm -rf .venv.

Documentation

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sleepybricks-1.2.0.tar.gz (38.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sleepybricks-1.2.0-py3-none-any.whl (46.3 kB view details)

Uploaded Python 3

File details

Details for the file sleepybricks-1.2.0.tar.gz.

File metadata

  • Download URL: sleepybricks-1.2.0.tar.gz
  • Upload date:
  • Size: 38.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.4.1 CPython/3.13.5 Darwin/25.5.0

File hashes

Hashes for sleepybricks-1.2.0.tar.gz
Algorithm Hash digest
SHA256 eafbd02be801f6d09bbe2ef5a02b91982ca6ddfa8d844fc28c8e168ebf8f3828
MD5 63e93b4ed0cc26028b90b4cb3727a6b2
BLAKE2b-256 9cfc4fc672d92816654db1750a10d0a8fb2a84a2802fd580b911126ceda310fe

See more details on using hashes here.

File details

Details for the file sleepybricks-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: sleepybricks-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 46.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.4.1 CPython/3.13.5 Darwin/25.5.0

File hashes

Hashes for sleepybricks-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ef22b0c908e1cc4569aa06972c63eef4f2a8e495f3d8c2256670c554470e256b
MD5 d789859fb906e91c1919fe67128f84bf
BLAKE2b-256 ad5d1e5ac95dbc99f5d79cccb79f3006bef8336407550184db9b292ece4b9dd3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page