Dagit

A compatibility package that provides the web UI for Dagster. Dagit serves as a transitional wrapper around the dagster-webserver package, maintaining backward compatibility for existing installations while encouraging migration to the newer dagster-webserver package.

Package Information

• Package Name: dagit
• Language: Python
• Installation: pip install dagit
• Python Compatibility: 3.9, 3.10, 3.11, 3.12, 3.13
• License: Apache-2.0

Core Imports

import dagit

For version information:

from dagit import __version__

Basic Usage

CLI Usage

The primary way to use dagit is through its command-line interface:

# Start the Dagster web UI server
dagit

# Start the debug server
dagit-debug

# Check version
dagit --version

Python API Usage

from dagit import __version__

# Access package version
print(f"Dagit version: {__version__}")

Capabilities

Version Information

Access to the package version identifier.

__version__: str

The version string for the dagit package (e.g., "1.11.8").

Command Line Interface

Two console commands are provided for running the Dagster web UI.

Main Web UI Server

dagit [options]

Starts the Dagster web UI server. This command is a direct delegate to dagster-webserver.cli:main - it passes through all arguments and options while showing deprecation warnings directing users to migrate to dagster-webserver.

Common Options:

• -f, --python-file: Python file to load Dagster definitions from
• -m, --module-name: Python module to load Dagster definitions from
• -a, --attribute: Attribute in the module to use as the repository
• -w, --working-directory: Working directory for the command
• -h, --host: Host to run the web server on
• -p, --port: Port to run the web server on
• --version: Show version information

Debug Server

dagit-debug [options]

Starts the Dagster web UI in debug mode. This command is a direct delegate to dagster_webserver.debug:main - it passes through all arguments and options.

Types

__version__: str

String constant containing the package version.

Package Dependencies

Dagit has minimal direct functionality and primarily depends on:

• dagster-webserver==1.11.8: Core web server implementation
• dagster_shared.libraries: For library registration

Migration Notes

This package is a compatibility shim. Users are encouraged to migrate to using dagster-webserver directly:

• Replace dagit command with dagster-webserver
• Replace dagit-debug command with dagster-webserver --debug
• All functionality remains the same

Error Handling

The CLI commands may raise:

• ImportError: When dagster-webserver dependencies are not available
• SystemExit: On invalid command-line arguments or server startup failures

Version command returns "dagster-webserver, version X.X.X" format and accepts standard dagster arguments for loading definitions.