Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Quickstart

Install dex and scaffold your first project in under a minute.

1. Install

curl -sSf https://raw.githubusercontent.com/yarrib/dex/main/install.sh | sh

See Installation for platform-specific binaries and Windows instructions.

2. Scaffold a project

Databricks Asset Bundle:

dex init --template dabs-package --dir my_project

Prompts:

Project name [my_project]:
Python version (3.12, 3.11) [3.12]:
Include exploration notebook? [Y/n]:
Include job definition? [Y/n]:
Use serverless compute? [y/N]:

Plain Python package:

dex init --template default --dir my_package

Non-interactive (CI / scripts):

dex init --template dabs-package --no-prompt --dir my_project

3. Inspect what was generated

my_project/
├── src/my_project/
│   ├── __init__.py
│   └── main.py
├── resources/
│   └── my_project_job.yml
├── notebooks/
│   └── exploration.py
├── tests/
│   └── test_my_project.py
├── databricks.yml
├── pyproject.toml
├── dex.toml
├── README.md
└── .gitignore

4. Deploy to Databricks

cd my_project
databricks bundle deploy          # → dev target
databricks bundle deploy --target prod

Next steps