Skip to main content

Decorator-based framework for defining Databricks jobs and tasks as Python code.

Project description

databricks-bundle-decorators

Decorator-based framework for defining Databricks jobs and tasks as Python code. Define pipelines using @task, @job, and job_cluster() — they compile into Databricks Asset Bundle resources.

Why databricks-bundle-decorators?

Writing Databricks jobs in raw YAML is tedious and disconnects task logic from orchestration configuration. databricks-bundle-decorators lets you express both in Python:

  • Airflow TaskFlow-inspired pattern — define @task functions inside a @job body; dependencies are captured automatically from call arguments.
  • IoManager pattern — large data (DataFrames, datasets) flows between tasks through external storage automatically.
  • Explicit task values — small scalars (str, int, float, bool) can be passed between tasks via set_task_value / get_task_value, like Airflow XComs.
  • Pure Python — write your jobs and tasks as decorated functions, run databricks bundle deploy, and the framework generates all Databricks Job configurations for you.

Installation

uv add databricks-bundle-decorators

With cloud-specific extras for the built-in PolarsParquetIoManager:

uv add databricks-bundle-decorators[azure]  # or [aws], [gcp], [polars]

Quickstart

uv init my-pipeline && cd my-pipeline
uv add databricks-bundle-decorators[azure]
uv run dbxdec init

This scaffolds a complete pipeline project. Define your jobs in src/<package>/pipelines/:

import polars as pl

from databricks_bundle_decorators import job, job_cluster, params, task
from databricks_bundle_decorators.io_managers import PolarsParquetIoManager

io = PolarsParquetIoManager(
    base_path="abfss://lake@account.dfs.core.windows.net/staging",
)

cluster = job_cluster(
    name="small",
    spark_version="16.4.x-scala2.12",
    node_type_id="Standard_E8ds_v4",
    num_workers=1,
)

@job(
    params={"url": "https://api.github.com/events"},
    cluster=cluster,
)
def my_pipeline():
    @task(io_manager=io)
    def extract() -> pl.DataFrame:
        import requests
        return pl.DataFrame(requests.get(params["url"]).json())

    @task
    def transform(df: pl.DataFrame):
        print(df.head(10))

    data = extract()
    transform(data)

Deploy:

databricks bundle deploy --target dev

Documentation

Full documentation is available at boccileonardo.github.io/databricks-bundle-decorators:

Development

git clone https://github.com/<org>/databricks-bundle-decorators.git
cd databricks-bundle-decorators
uv sync
uv run pytest tests/ -v

Releasing

Automated (recommended)

Run the release automation action, pick patch/minor/major. The workflow bumps the version in pyproject.toml, commits, tags, builds, creates a GitHub Release, and publishes to PyPI.

Manual

uv version --bump patch  # or minor, major
git commit -am "release: v$(uv version)" && git push
# Create a GitHub Release with the new tag → publish.yaml pushes to PyPI

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

databricks_bundle_decorators-0.11.1.tar.gz (74.4 kB view details)

Uploaded Source

Built Distribution

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

databricks_bundle_decorators-0.11.1-py3-none-any.whl (100.9 kB view details)

Uploaded Python 3

File details

Details for the file databricks_bundle_decorators-0.11.1.tar.gz.

File metadata

File hashes

Hashes for databricks_bundle_decorators-0.11.1.tar.gz
Algorithm Hash digest
SHA256 6e416699087a26343a43d8bcfe435181ccba948a4c65fe8375c884be092cb74e
MD5 21010df92c6ee26dcca4f7bf9c9e6a09
BLAKE2b-256 63629b9dafe396203c1f28baf506dee7a585612813c7e8b5f9a5df51e2f186f4

See more details on using hashes here.

Provenance

The following attestation bundles were made for databricks_bundle_decorators-0.11.1.tar.gz:

Publisher: publish.yaml on boccileonardo/databricks-bundle-decorators

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file databricks_bundle_decorators-0.11.1-py3-none-any.whl.

File metadata

File hashes

Hashes for databricks_bundle_decorators-0.11.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a95d5057bc12b4ee982936e020f73d024894231f05e5cec6ca630e64b6d8f79e
MD5 e295af472ddb78412275697a2f2e3e20
BLAKE2b-256 765edf52b1198bc40901793d25d823901bc1c584e26c7585fcb55b0693bad874

See more details on using hashes here.

Provenance

The following attestation bundles were made for databricks_bundle_decorators-0.11.1-py3-none-any.whl:

Publisher: publish.yaml on boccileonardo/databricks-bundle-decorators

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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