Quickstart (Dagster+ Serverless)

TK - intro copy.

Prerequisites

To follow the steps in this guide, you will need to:

• Sign up for a Dagster+ Serverless account.
• Choose a template repository, and clone the repository to your local machine.
• Ensure Python 3.9+ is installed on your local machine.

Step 1: Install uv (Recommended)

note

If you will be using pip, skip to step 2.

If you will be using uv as your package manager, follow the steps below to install the Python package manager uv:

Mac

brew install uv

Windows

powershell -ExecutionPolicy ByPass -c 'irm https://astral.sh/uv/install.ps1 | iex'

Linux

curl -LsSf https://astral.sh/uv/install.sh | sh

Step 2: Configure your project

uv

1. Change to the directory of your cloned project:

   cd <project-directory>

2. Activate the virtual environment:

   MacOS/Unix

   source .venv/bin/activate

   Windows

   .venv\Scripts\activate

3. Install any required dependencies in the virtual environment:

   uv add <package-name>

pip

1. Change to the directory of your cloned project:

   cd <project-directory>

2. Create and activate a virtual environment:

   MacOS/Unix

   python -m venv .venv

   source .venv/bin/activate

   Windows

   python -m venv .venv

   .venv\Scripts\activate

3. Install the required dependencies:

   pip install pandas

4. Install your project as an editable package:

   pip install --editable .

Step 3: Develop and test locally

TK - development:

• Create assets
• Automate your pipeline
• Add integrations

TK - testing:

• Run dg check defs
• Run dg dev to start the webserver and run your pipeline in the UI
• Add asset checks
• Debug with pdb

Step 4: Deploy to staging with branch deployments

TK - see branch deployments docs

Step 5: Deploy to production

TK - any config changes to make before deploying? or is this just a matter of merging branch to main and CI/CD takes care of it?