create-dagster 1.12.16__py2.py3-none-any.whl

create_dagster/__init__.py

@@ -0,0 +1,5 @@
+from dagster_shared.libraries import DagsterLibraryRegistry
+
+from create_dagster.version import __version__ as __version__
+
+DagsterLibraryRegistry.register("create-dagster", __version__)

create_dagster/cli/__init__.py

@@ -0,0 +1,33 @@
+import click
+
+from create_dagster.cli.scaffold import scaffold_project_command, scaffold_workspace_command
+from create_dagster.version import __version__
+
+CREATE_DAGSTER_CLI_MAX_OUTPUT_WIDTH = 120
+
+
+def get_create_dagster_cli():
+    @click.group(
+        name="create-dagster",
+        commands={
+            "project": scaffold_project_command,
+            "workspace": scaffold_workspace_command,
+        },
+        context_settings={
+            "max_content_width": CREATE_DAGSTER_CLI_MAX_OUTPUT_WIDTH,
+            "help_option_names": ["-h", "--help"],
+        },
+    )
+    @click.version_option(__version__, "--version", "-v")
+    def group():
+        """CLI for creating a new Dagster project or workspace."""
+
+    return group
+
+
+ENV_PREFIX = "CREATE_DAGSTER"
+cli = get_create_dagster_cli()
+
+
+def main():
+    cli(auto_envvar_prefix=ENV_PREFIX)

create_dagster/cli/scaffold.py

@@ -0,0 +1,301 @@
+import subprocess
+from pathlib import Path
+
+import click
+from dagster_dg_core.config import discover_workspace_root, normalize_cli_config
+from dagster_dg_core.context import DgContext
+from dagster_dg_core.shared_options import dg_editable_dagster_options, dg_global_options
+from dagster_dg_core.utils import (
+    DgClickCommand,
+    exit_with_error,
+    format_multiline_str,
+    get_shortest_path_repr,
+    get_venv_activation_cmd,
+    is_uv_installed,
+    pushd,
+)
+from dagster_dg_core.utils.telemetry import cli_telemetry_wrapper
+
+from create_dagster.scaffold import scaffold_project, scaffold_workspace
+from create_dagster.version_check import check_create_dagster_up_to_date
+
+
+def _project_package_install_warning_message() -> str:
+    pip_install_cmd = "pip install --editable ."
+    uv_install_cmd = "uv sync"
+    return format_multiline_str(
+        f"""
+            The environment used for your project must include an installation of your project
+            package. Please run `{uv_install_cmd}` (for uv) or `{pip_install_cmd}` (for pip) before
+            running `dg` commands against your project.
+        """
+    )
+
+
+def _print_package_install_warning_message(install_msg_warning) -> None:
+    click.secho(
+        install_msg_warning,
+        fg="yellow",
+    )
+
+
+def _workspace_environment_install_warning_message() -> str:
+    pip_install_cmd = "pip install --editable ./deployments/local"
+    uv_install_cmd = "uv sync --directory ./deployments/local"
+    return format_multiline_str(
+        f"""
+        The Python environment used for your workspace must include an installation of the `dg`
+        CLI. Please run `{uv_install_cmd}` (for uv) or `{pip_install_cmd}` (for pip) before
+        running `dg` commands locally against your workspace.
+        """
+    )
+
+
+def _get_project_uv_sync_prompt_msg() -> str:
+    return format_multiline_str("""
+    A `uv` installation was detected. Run `uv sync`? This will create a uv.lock file and
+    the virtual environment you need to activate in order to work on this project.
+    If you wish to use a non-uv package manager, choose "n". (y/n)
+    """)
+
+
+def _get_workspace_environment_uv_sync_prompt_msg(local_environment_path: Path) -> str:
+    return format_multiline_str(f"""
+    A `uv` installation was detected. Run `uv sync --directory {local_environment_path}`?
+    This will create a uv.lock file and the virtual environment you need to activate in order to
+    use `dg` locally with this workspace. If you wish to use a non-uv package manager,
+    choose "n". (y/n)
+    """)
+
+
+def _should_run_uv_sync(
+    venv_path: Path,
+    uv_sync_flag: bool | None,
+    uv_sync_prompt_msg: str,
+    install_warning_msg: str,
+) -> bool:
+    if uv_sync_flag is not None:
+        return uv_sync_flag
+    elif venv_path.exists():
+        _print_package_install_warning_message(install_warning_msg)
+        return False
+    elif is_uv_installed():  # uv_sync_flag is unset (None)
+        response = click.prompt(
+            uv_sync_prompt_msg,
+            default="y",
+        ).lower()
+        if response not in ("y", "n"):
+            exit_with_error(f"Invalid response '{response}'. Please enter 'y' or 'n'.")
+        if response == "n":
+            _print_package_install_warning_message(install_warning_msg)
+        return response == "y"
+    else:
+        return False
+
+
+# ########################
+# ##### PROJECT
+# ########################
+
+
+@click.command(
+    name="project",
+    cls=DgClickCommand,
+    context_settings={"help_option_names": ["-h", "--help"]},
+)
+@click.argument("path", type=Path)
+@click.option(
+    "--uv-sync/--no-uv-sync",
+    is_flag=True,
+    default=None,
+    help="""
+        Preemptively answer the "Run uv sync?" prompt presented after project initialization.
+    """.strip(),
+)
+@dg_editable_dagster_options
+@dg_global_options
+@cli_telemetry_wrapper
+def scaffold_project_command(
+    path: Path,
+    use_editable_dagster: bool,
+    uv_sync: bool | None,
+    **global_options: object,
+) -> None:
+    """Scaffold a new Dagster project at PATH. The name of the project will be the final component of PATH.
+
+    This command can be run inside or outside of a workspace directory. If run inside a workspace,
+    the project will be added to the workspace's list of project specs.
+
+    "." may be passed as PATH to create the new project inside the existing working directory.
+
+    Created projects will have the following structure::
+
+        ├── src
+        │   └── PROJECT_NAME
+        │       ├── __init__.py
+        │       ├── definitions.py
+        │       ├── defs
+        │       │   └── __init__.py
+        │       └── components
+        │           └── __init__.py
+        ├── tests
+        │   └── __init__.py
+        └── pyproject.toml
+
+    The `src.PROJECT_NAME.defs` directory holds Python objects that can be targeted by the
+    `dg scaffold` command or have dg-inspectable metadata. Custom component types in the project
+    live in `src.PROJECT_NAME.components`. These types can be created with `dg scaffold component`.
+
+    Examples::
+
+        create-dagster project PROJECT_NAME
+            Scaffold a new project in new directory PROJECT_NAME. Automatically creates directory
+            and parent directories.
+        create-dagster project .
+            Scaffold a new project in the CWD. The project name is taken from the last component of the CWD.
+    """
+    cli_config = normalize_cli_config(global_options, click.get_current_context())
+    dg_context = DgContext.from_file_discovery_and_command_line_config(Path.cwd(), cli_config)
+    check_create_dagster_up_to_date(dg_context)
+
+    if uv_sync is True and not is_uv_installed():
+        exit_with_error("""
+            uv is not installed. Please install uv to use the `--uv-sync` option.
+            See https://docs.astral.sh/uv/getting-started/installation/.
+        """)
+
+    abs_path = path.resolve()
+    if dg_context.is_in_workspace and dg_context.has_project(
+        abs_path.relative_to(dg_context.workspace_root_path)
+    ):
+        exit_with_error(f"The current workspace already specifies a project at {abs_path}.")
+    elif str(path) != "." and abs_path.exists():
+        exit_with_error(f"A file or directory already exists at {abs_path}.")
+
+    scaffold_project(
+        abs_path,
+        dg_context,
+        use_editable_dagster=use_editable_dagster,
+    )
+
+    venv_path = path / ".venv"
+
+    if _should_run_uv_sync(
+        venv_path,
+        uv_sync,
+        uv_sync_prompt_msg=_get_project_uv_sync_prompt_msg(),
+        install_warning_msg=_project_package_install_warning_message(),
+    ):
+        click.echo("Running `uv sync --group dev`...")
+        with pushd(path):
+            subprocess.run(["uv", "sync", "--group", "dev"], check=True)
+
+        click.echo("\nuv.lock and virtual environment created.")
+        display_venv_path = get_shortest_path_repr(venv_path)
+        click.echo(
+            f"""
+            Run `{get_venv_activation_cmd(display_venv_path)}` to activate your project's virtual environment.
+            """.strip()
+        )
+
+
+# ########################
+# ##### WORKSPACE
+# ########################
+
+
+@click.command(
+    name="workspace",
+    cls=DgClickCommand,
+    context_settings={"help_option_names": ["-h", "--help"]},
+)
+@click.argument("path", type=Path)
+@click.option(
+    "--uv-sync/--no-uv-sync",
+    is_flag=True,
+    default=None,
+    help="""
+        Preemptively answer the "Run uv sync?" prompt presented after project initialization.
+    """.strip(),
+)
+@dg_editable_dagster_options
+@dg_global_options
+@cli_telemetry_wrapper
+def scaffold_workspace_command(
+    path: Path,
+    use_editable_dagster: bool,
+    uv_sync: bool | None,
+    **global_options: object,
+):
+    """Initialize a new Dagster workspace.
+
+    The scaffolded workspace folder has the following structure::
+
+        ├── projects
+        │   └── Dagster projects go here
+        ├── deployments
+        │   └── local
+        │       ├── pyproject.toml
+        │       └── uv.lock
+        └── dg.toml
+
+    Examples::
+
+        create-dagster workspace WORKSPACE_NAME
+            Scaffold a new workspace in new directory WORKSPACE_NAME. Automatically creates directory
+            and parent directories.
+        create-dagster workspace .
+            Scaffold a new workspace in the CWD. The workspace name is the last component of the CWD.
+
+    """
+    cli_config = normalize_cli_config(global_options, click.get_current_context())
+    dg_context = DgContext.from_file_discovery_and_command_line_config(Path.cwd(), cli_config)
+    check_create_dagster_up_to_date(dg_context)
+
+    abs_path = path.resolve()
+
+    existing_workspace_path = discover_workspace_root(path)
+    if existing_workspace_path:
+        exit_with_error(
+            f"Workspace already exists at {existing_workspace_path}.  Run `create-dagster project` to add a new project to that workspace."
+        )
+    elif str(path) != "." and path.exists():
+        exit_with_error(f"Folder already exists at {path}.")
+
+    scaffold_workspace(
+        abs_path,
+        use_editable_dagster=use_editable_dagster,
+    )
+
+    local_environment_path = abs_path / "deployments" / "local"
+    local_venv_path = local_environment_path / ".venv"
+
+    click.echo(
+        f"Scaffolded files for Dagster workspace at {abs_path}.\nA local environment to run `dg` commands against this workspace was created at {local_environment_path}."
+    )
+
+    shortest_local_environment_path = get_shortest_path_repr(local_environment_path)
+
+    if _should_run_uv_sync(
+        local_venv_path,
+        uv_sync,
+        uv_sync_prompt_msg=_get_workspace_environment_uv_sync_prompt_msg(
+            shortest_local_environment_path
+        ),
+        install_warning_msg=_workspace_environment_install_warning_message(),
+    ):
+        click.echo(f"Running `uv sync --directory {shortest_local_environment_path}`...")
+        with pushd(path):
+            subprocess.run(
+                ["uv", "sync"],
+                check=True,
+                cwd=local_environment_path,
+            )
+
+        click.echo("\nuv.lock and virtual environment created.")
+        display_venv_path = get_shortest_path_repr(local_venv_path)
+        click.echo(
+            f"""
+            Run `{get_venv_activation_cmd(display_venv_path)}` to activate your workspace's local virtual environment.
+            """.strip()
+        )

create_dagster/py.typed

@@ -0,0 +1 @@
+partial

create_dagster/scaffold.py

@@ -0,0 +1,254 @@
+import os
+import uuid
+from collections.abc import Sequence
+from pathlib import Path
+
+import click
+from dagster_dg_core.config import DgWorkspaceScaffoldProjectOptions, modify_dg_toml_config
+from dagster_dg_core.context import DgContext
+from dagster_dg_core.utils import exit_with_error, get_toml_node, has_toml_node, set_toml_node
+from dagster_shared.libraries import parse_package_version
+from dagster_shared.scaffold import scaffold_subtree
+
+
+def scaffold_workspace(
+    path: Path,
+    use_editable_dagster: bool,
+) -> None:
+    scaffold_subtree(
+        path=path,
+        name_placeholder="WORKSPACE_NAME_PLACEHOLDER",
+        project_template_path=Path(
+            os.path.join(os.path.dirname(__file__), "templates", "WORKSPACE_NAME_PLACEHOLDER")
+        ),
+        excludes=None,
+        **get_dependencies_template_params(
+            use_editable_dagster,
+            scaffold_project_options=None,
+            pypi_deps=_get_pypi_local_workspace_environment_deps(),
+            # add create-dagster to editable installs so you can scaffold projects in the
+            # workspace editable venv, since if you are installing editably you probably have
+            # create-dagster installed in your current venv editably
+            editable_deps=(
+                EDITABLE_DAGSTER_DEPENDENCIES
+                + EDITABLE_DAGSTER_DEV_DEPENDENCIES
+                + ["create-dagster"]
+            ),
+            pypi_dev_deps=[],  # no dev extra
+            editable_dev_deps=[],
+        ),
+    )
+
+    if use_editable_dagster:
+        with modify_dg_toml_config(path / "dg.toml") as toml:
+            set_toml_node(toml, ("workspace", "scaffold_project_options"), {})
+            set_toml_node(
+                toml,
+                ("workspace", "scaffold_project_options", "use_editable_dagster"),
+                True if use_editable_dagster == "TRUE" else use_editable_dagster,
+            )
+
+
+def get_dependencies_template_params(
+    use_editable_dagster: bool,
+    scaffold_project_options: DgWorkspaceScaffoldProjectOptions | None,
+    *,
+    editable_deps: list[str],
+    editable_dev_deps: list[str],
+    pypi_deps: list[str],
+    pypi_dev_deps: list[str],
+) -> dict[str, str]:
+    cli_options = DgWorkspaceScaffoldProjectOptions.get_raw_from_cli(use_editable_dagster)
+
+    final_use_editable_dagster = cli_options.get(
+        "use_editable_dagster",
+        scaffold_project_options.use_editable_dagster if scaffold_project_options else None,
+    )
+    if final_use_editable_dagster:
+        deps = editable_deps
+        dev_deps = editable_dev_deps
+        sources = _gather_dagster_packages(Path(_get_editable_dagster_from_env()))
+    else:
+        dev_deps = pypi_dev_deps
+        deps = pypi_deps
+        sources = []
+
+    dependencies_str = _get_pyproject_toml_dependencies(deps)
+    dev_dependencies_str = _get_pyproject_toml_dev_dependencies(dev_deps)
+    uv_sources_str = _get_pyproject_toml_uv_sources(sources) if sources else ""
+
+    return {
+        "dependencies": dependencies_str,
+        "dev_dependencies": dev_dependencies_str,
+        "uv_sources": uv_sources_str,
+    }
+
+
+def _get_pypi_project_deps() -> list[str]:
+    from create_dagster.version import __version__
+
+    create_dagster_version = parse_package_version(__version__)
+    if create_dagster_version.release[0] >= 1:
+        # Pin scaffolded libraries to match create-dagster version
+        return [f"dagster=={__version__}"]
+    else:
+        return ["dagster"]
+
+
+def _get_pypi_local_workspace_environment_deps() -> list[str]:
+    return _get_pypi_project_deps() + PYPI_DAGSTER_DEV_DEPENDENCIES
+
+
+def scaffold_project(
+    path: Path,
+    dg_context: DgContext,
+    use_editable_dagster: bool,
+) -> None:
+    import tomlkit
+    import tomlkit.items
+
+    click.echo(f"Creating a Dagster project at {path}.")
+
+    scaffold_project_options = (
+        dg_context.config.workspace.scaffold_project_options
+        if dg_context.config.workspace
+        else None
+    )
+
+    project_excludes = None
+    if dg_context.is_in_workspace:
+        project_excludes = [
+            ".gitignore",
+            "README.md.jinja",
+        ]
+
+    scaffold_subtree(
+        path=path,
+        name_placeholder="PROJECT_NAME_PLACEHOLDER",
+        project_template_path=Path(
+            os.path.join(os.path.dirname(__file__), "templates", "PROJECT_NAME_PLACEHOLDER")
+        ),
+        excludes=project_excludes,
+        project_id=str(uuid.uuid4()),
+        **get_dependencies_template_params(
+            use_editable_dagster,
+            scaffold_project_options,
+            pypi_deps=_get_pypi_project_deps(),
+            pypi_dev_deps=PYPI_DAGSTER_DEV_DEPENDENCIES,
+            editable_deps=EDITABLE_DAGSTER_DEPENDENCIES,
+            editable_dev_deps=EDITABLE_DAGSTER_DEV_DEPENDENCIES,
+        ),
+    )
+    click.echo(f"Scaffolded files for Dagster project at {path}.")
+
+    # Build the venv
+    cl_dg_context = dg_context.with_root_path(path)
+
+    # Update pyproject.toml
+    if cl_dg_context.is_in_workspace:
+        entry = {
+            "path": str(cl_dg_context.root_path.relative_to(cl_dg_context.workspace_root_path)),
+        }
+
+        with modify_dg_toml_config(dg_context.config_file_path) as toml:
+            if not has_toml_node(toml, ("workspace", "projects")):
+                projects = tomlkit.aot()
+                set_toml_node(toml, ("workspace", "projects"), projects)
+                item = tomlkit.table()
+            else:
+                projects = get_toml_node(
+                    toml,
+                    ("workspace", "projects"),
+                    (tomlkit.items.AoT, tomlkit.items.Array),
+                )
+                if isinstance(projects, tomlkit.items.Array):
+                    item = tomlkit.inline_table()
+                else:
+                    item = tomlkit.table()
+
+            # item.trivia.indent is the preceding whitespace-- this ensures there is always a blank
+            # line before the new entry
+            item.trivia.indent = item.trivia.indent + "\n"
+            for key, value in entry.items():
+                item[key] = value
+            projects.append(item)
+
+
+# Despite the fact that editable dependencies are resolved through tool.uv.sources, we need to set
+# the dependencies themselves differently depending on whether we are using editable dagster or
+# not. This is because `tool.uv.sources` only seems to apply to direct dependencies of the package,
+# so any 2+-order Dagster dependency of our package needs to be listed as a direct dependency in the
+# editable case. See: https://github.com/astral-sh/uv/issues/9446
+EDITABLE_DAGSTER_DEPENDENCIES = [
+    "dagster",
+    "dagster-pipes",
+    "dagster-shared",
+    "dagster-test",  # we include dagster-test for testing purposes
+]
+EDITABLE_DAGSTER_DEV_DEPENDENCIES = [
+    "dagster-webserver",
+    "dagster-graphql",
+    "dagster-dg-core",
+    "dagster-dg-cli",
+    "dagster-cloud-cli",
+]
+
+
+PYPI_DAGSTER_DEV_DEPENDENCIES = [
+    "dagster-webserver",
+    "dagster-dg-cli",
+]
+
+
+def _get_editable_dagster_from_env() -> str:
+    if not os.environ.get("DAGSTER_GIT_REPO_DIR"):
+        exit_with_error(
+            "The `--use-editable-dagster` option "
+            "requires the `DAGSTER_GIT_REPO_DIR` environment variable to be set."
+        )
+    return os.environ["DAGSTER_GIT_REPO_DIR"]
+
+
+def _get_pyproject_toml_dependencies(deps: Sequence[str]) -> str:
+    return "\n".join(
+        [
+            "dependencies = [",
+            *[f'    "{dep}",' for dep in deps],
+            "]",
+        ]
+    )
+
+
+def _get_pyproject_toml_dev_dependencies(deps: Sequence[str]) -> str:
+    return "\n".join(
+        [
+            "dev = [",
+            *[f'    "{dep}",' for dep in deps],
+            "]",
+        ]
+    )
+
+
+def _get_pyproject_toml_uv_sources(lib_paths: list[Path]) -> str:
+    lib_lines = [f"{path.name} = {{ path = '{path}', editable = true }}" for path in lib_paths]
+    return "\n".join(
+        [
+            "[tool.uv.sources]",
+            *lib_lines,
+        ]
+    )
+
+
+def _gather_dagster_packages(editable_dagster_root: Path) -> list[Path]:
+    package_dirs = set()
+    for pattern in [
+        "python_modules/dagster*/setup.py",
+        "python_modules/dagster*/pyproject.toml",
+        "python_modules/libraries/dagster*/setup.py",
+        "python_modules/libraries/dagster*/pyproject.toml",
+        "python_modules/libraries/create-dagster/setup.py",
+        "python_modules/libraries/create-dagster/pyproject.toml",
+    ]:
+        for p in editable_dagster_root.glob(pattern):
+            package_dirs.add(p.parent)
+    return sorted(package_dirs)

create_dagster/templates/PROJECT_NAME_PLACEHOLDER/.dg/telemetry.yaml.jinja

@@ -0,0 +1 @@
+project_id: {{ project_id }}

create_dagster/templates/PROJECT_NAME_PLACEHOLDER/.gitignore

@@ -0,0 +1,203 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

create_dagster/templates/PROJECT_NAME_PLACEHOLDER/README.md.jinja

@@ -0,0 +1,61 @@
+# {{ project_name }}
+
+## Getting started
+
+### Installing dependencies
+
+**Option 1: uv**
+
+Ensure [`uv`](https://docs.astral.sh/uv/) is installed following their [official documentation](https://docs.astral.sh/uv/getting-started/installation/).
+
+Create a virtual environment, and install the required dependencies using _sync_:
+
+```bash
+uv sync
+```
+
+Then, activate the virtual environment:
+
+| OS | Command |
+| --- | --- |
+| MacOS | ```source .venv/bin/activate``` |
+| Windows | ```.venv\Scripts\activate``` |
+
+**Option 2: pip**
+
+Install the python dependencies with [pip](https://pypi.org/project/pip/):
+
+```bash
+python3 -m venv .venv
+```
+
+Then activate the virtual environment:
+
+| OS | Command |
+| --- | --- |
+| MacOS | ```source .venv/bin/activate``` |
+| Windows | ```.venv\Scripts\activate``` |
+
+Install the required dependencies:
+
+```bash
+pip install -e ".[dev]"
+```
+
+### Running Dagster
+
+Start the Dagster UI web server:
+
+```bash
+dg dev
+```
+
+Open http://localhost:3000 in your browser to see the project.
+
+## Learn more
+
+To learn more about this template and Dagster in general:
+
+- [Dagster Documentation](https://docs.dagster.io/)
+- [Dagster University](https://courses.dagster.io/)
+- [Dagster Slack Community](https://dagster.io/slack)

create_dagster/templates/PROJECT_NAME_PLACEHOLDER/pyproject.toml.jinja

@@ -0,0 +1,26 @@
+[project]
+name = "{{ project_name }}"
+requires-python = ">=3.10,<3.15"
+version = "0.1.0"
+{{ dependencies }}
+
+[dependency-groups]
+{{ dev_dependencies }}
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+force-include = { "pyproject.toml" = "pyproject.toml" }
+
+[tool.dg]
+directory_type = "project"
+
+[tool.dg.project]
+root_module = "{{ project_name }}"
+registry_modules = [
+    "{{ project_name }}.components.*",
+]
+
+{{ uv_sources }}

create_dagster/templates/PROJECT_NAME_PLACEHOLDER/src/PROJECT_NAME_PLACEHOLDER/definitions.py.jinja

@@ -0,0 +1,8 @@
+from pathlib import Path
+
+from dagster import definitions, load_from_defs_folder
+
+
+@definitions
+def defs():
+    return load_from_defs_folder(path_within_project=Path(__file__).parent)

create_dagster/templates/WORKSPACE_NAME_PLACEHOLDER/deployments/local/pyproject.toml.jinja

@@ -0,0 +1,10 @@
+[project]
+name = "{{ project_name }}_local"
+requires-python = ">=3.10,<3.15"
+version = "0.1.0"
+{{ dependencies }}
+
+[tool.dg]
+directory_type = "deployment"
+
+{{ uv_sources }}

create_dagster/templates/WORKSPACE_NAME_PLACEHOLDER/dg.toml.jinja

@@ -0,0 +1,3 @@
+directory_type = "workspace"
+
+[workspace]

create_dagster/version.py

@@ -0,0 +1 @@
+__version__ = "1.12.16"

create_dagster/version_check.py

@@ -0,0 +1,88 @@
+import datetime
+import os
+from functools import cached_property
+
+from dagster_dg_core.context import DgContext
+from dagster_dg_core.utils.warnings import emit_warning
+from dagster_shared.libraries import DagsterPyPiAccessError, get_published_pypi_versions
+from dagster_shared.record import record
+from packaging.version import Version
+
+from create_dagster.version import __version__
+
+CREATE_DAGSTER_UPDATE_CHECK_ENABLED_ENV_VAR = "DAGSTER_DG_UPDATE_CHECK_ENABLED"
+
+
+@record
+class _PyPiVersionInfo:
+    timestamp: float
+    raw_versions: list[str]
+
+    @property
+    def datetime(self) -> datetime.datetime:
+        return datetime.datetime.fromtimestamp(self.timestamp)
+
+    @cached_property
+    def versions(self) -> list[Version]:
+        return sorted(Version(v) for v in self.raw_versions)
+
+
+def check_create_dagster_up_to_date(context: DgContext) -> None:
+    if not _create_dagster_update_check_enabled(context):
+        return
+
+    version_info = _get_create_dagster_pypi_version_info(context)
+    if version_info is None:  # Nothing cached and network error occurred
+        return None
+
+    current_version = Version(__version__)
+    latest_version = version_info.versions[-1]
+    if current_version < latest_version:
+        emit_warning(
+            "create_dagster_outdated",
+            f"""
+                There is a new version of `create-dagster` available:
+
+                    Latest version: {latest_version}
+                    Current version: {current_version}
+
+                Update your create-dagster installation to keep up to date:
+
+                    [uv tool run]      $ uvx -U create-dagster
+                    [uv tool install]  $ uv tool upgrade create-dagster
+                    [uv local]         $ uv sync --upgrade create-dagster
+                    [pip]              $ pip install --upgrade create-dagster
+            """,
+            suppress_warnings=[],
+        )
+
+
+def _create_dagster_update_check_enabled(context: DgContext) -> bool:
+    return (
+        bool(int(os.getenv(CREATE_DAGSTER_UPDATE_CHECK_ENABLED_ENV_VAR, "1")))
+        and "create_dagster_outdated" not in context.config.cli.suppress_warnings
+    )
+
+
+def _get_create_dagster_pypi_version_info(context: DgContext) -> _PyPiVersionInfo | None:
+    if context.config.cli.verbose:
+        context.log.info("Checking for the latest version of `create-dagster` on PyPI.")
+    try:
+        published_versions = get_published_pypi_versions("create-dagster")
+        version_info = _PyPiVersionInfo(
+            raw_versions=[str(v) for v in published_versions],
+            timestamp=datetime.datetime.now().timestamp(),
+        )
+    except DagsterPyPiAccessError as e:
+        emit_warning(
+            "create_dagster_outdated",
+            f"""
+                There was an error checking for the latest version of `create-dagster` on PyPI. Please check your
+                internet connection and try again.
+
+                Error: {e}
+                """,
+            suppress_warnings=[],
+        )
+        version_info = None
+    return version_info

create_dagster-1.12.16.dist-info/METADATA

@@ -0,0 +1,19 @@
+Metadata-Version: 2.4
+Name: create-dagster
+Version: 1.12.16
+Summary: CLI for creating a new dg project or workspace.
+Project-URL: Homepage, https://github.com/dagster-io/dagster/tree/master/python_modules/libraries/create-dagster
+Author-email: Dagster Labs <hello@dagsterlabs.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: dagster-dg-core==1.12.16
+Provides-Extra: test
+Requires-Dist: flaky; extra == 'test'
+Requires-Dist: psutil; extra == 'test'
+Requires-Dist: pytest; extra == 'test'

create_dagster-1.12.16.dist-info/RECORD

@@ -0,0 +1,24 @@
+create_dagster/__init__.py,sha256=KNn9tdZHJR5WooJM4qGlsCsXb06zWVP_bJilfsfngjM,187
+create_dagster/py.typed,sha256=mDShSrm8qg9qjacQc2F-rI8ATllqP6EdgHuEYxuCXZ0,7
+create_dagster/scaffold.py,sha256=26z5ZBT9QNya8oiAqQ0tx4b9C6CdgdqMWuvDuHHWOZk,8584
+create_dagster/version.py,sha256=fFgL2l_aO8HuiIYIT4ROy3I4MuBkR-FzMsPtNDtQisU,24
+create_dagster/version_check.py,sha256=kEXXI5IudCmM4xGsHS8OQf1yFczVZJRTlKO1iAn4FtU,3063
+create_dagster/cli/__init__.py,sha256=uhenH_pf5mkC6wIcbZZvhJdOxt-kUmnyJl7FpzcR1xw,851
+create_dagster/cli/scaffold.py,sha256=9m7IQapvpm-G2CQYTgTH4BH-kc55aoRkoWm7riREivk,10490
+create_dagster/templates/PROJECT_NAME_PLACEHOLDER/.gitignore,sha256=a16PgPDtZU51UDiRgETFY8T9bIWmEB2YjouecJvi0Tw,4439
+create_dagster/templates/PROJECT_NAME_PLACEHOLDER/README.md.jinja,sha256=AzruT8J4OYsBHEzwTS2KtmOc3xpgrKisDS4SQII62Ig,1241
+create_dagster/templates/PROJECT_NAME_PLACEHOLDER/pyproject.toml.jinja,sha256=O3WOBq208rMgOPcrRIiKkPZdFszaLb0XgbjA9U8Otok,489
+create_dagster/templates/PROJECT_NAME_PLACEHOLDER/.dg/telemetry.yaml.jinja,sha256=fEYE0pB3Yu-xZ2JwyueQ0Y1C4CmbZZWmyY0ATZrjFCA,29
+create_dagster/templates/PROJECT_NAME_PLACEHOLDER/src/PROJECT_NAME_PLACEHOLDER/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+create_dagster/templates/PROJECT_NAME_PLACEHOLDER/src/PROJECT_NAME_PLACEHOLDER/definitions.py.jinja,sha256=NyggUpOD0lkJS1E1pjgXFGaDCzQc335ZfU-eo6CAQF8,184
+create_dagster/templates/PROJECT_NAME_PLACEHOLDER/src/PROJECT_NAME_PLACEHOLDER/defs/.gitkeep,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+create_dagster/templates/PROJECT_NAME_PLACEHOLDER/src/PROJECT_NAME_PLACEHOLDER/defs/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+create_dagster/templates/PROJECT_NAME_PLACEHOLDER/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+create_dagster/templates/WORKSPACE_NAME_PLACEHOLDER/dg.toml.jinja,sha256=P9vtkxp0XUYKhsa6UhPMzHkAADKJejQ0mxi2ciGnK0w,42
+create_dagster/templates/WORKSPACE_NAME_PLACEHOLDER/deployments/local/pyproject.toml.jinja,sha256=d6uDPmDssBX9nDiQt_BnwRXqkKqFOMMpBVEYsUsDip8,173
+create_dagster/templates/WORKSPACE_NAME_PLACEHOLDER/projects/.gitkeep,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+create_dagster-1.12.16.dist-info/METADATA,sha256=Em5D6JO6bRlkrrCGcedv9QkQxBHGw2hNuBjcbUqLJGQ,813
+create_dagster-1.12.16.dist-info/WHEEL,sha256=e22IIVjxDyt0lABi4WpktFIGsmO_ebSDXLnPUbPK0E0,105
+create_dagster-1.12.16.dist-info/entry_points.txt,sha256=Z63NCOZRLoCLiDynvq0VU7mjblrZAlFgYmBVbvFcOCc,59
+create_dagster-1.12.16.dist-info/licenses/LICENSE,sha256=lY5yc1KHX4HoXjlWnIPGcCAsnNney2rb8M8ccT6NzRQ,11347
+create_dagster-1.12.16.dist-info/RECORD,,

create_dagster-1.12.16.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py2-none-any
+Tag: py3-none-any

create_dagster-1.12.16.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+create-dagster = create_dagster.cli:main

create_dagster-1.12.16.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2023 Dagster Labs, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.