dlthub-start 0.1.0__tar.gz

dlthub_start-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,104 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  # POSIX runners: Ubuntu + macOS. GNU make is available, so `make ci` runs
+  # the full chain (compile, lint, unit tests, e2e, check-ai, build).
+  posix:
+    name: ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
+        with:
+          python-version: "3.13"
+          enable-cache: true
+
+      - name: Install dependencies
+        run: uv sync --extra dev --frozen
+
+      - name: Lint + type-check
+        run: make lint-ci
+
+      - name: Compile
+        run: make compile
+
+      - name: Unit tests
+        run: make test
+
+      - name: Integration tests
+        run: make test-integration
+
+      - name: Build wheel
+        run: make build
+
+  # Windows runner: GNU make isn't standard on windows-latest. Invoke each
+  # check directly via uv so the workflow stays portable.
+  windows:
+    name: windows-latest
+    runs-on: windows-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
+        with:
+          python-version: "3.13"
+          enable-cache: true
+
+      - name: Install dependencies
+        run: uv sync --extra dev --frozen
+
+      - name: Lint + type-check
+        run: |
+          uv run ruff format --check src tests tests_integration scripts
+          uv run ruff check src tests tests_integration scripts
+          uv run mypy src tests tests_integration scripts
+
+      - name: Unit tests
+        run: uv run python -m unittest discover -s tests -t .
+
+      - name: Integration tests
+        run: uv run python -m unittest discover -s tests_integration -t .
+
+      - name: Build wheel
+        run: uv build
+
+  # Drift guard: regenerates the bundled AI workbench files from the pinned
+  # WORKBENCH_REF and fails if the result doesn't match what's committed.
+  # Runs on one platform only — the output is platform-independent and we
+  # don't need to triple the CI time.
+  check-ai:
+    name: AI workbench drift
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
+        with:
+          python-version: "3.13"
+          enable-cache: true
+
+      - name: Install dependencies
+        run: uv sync --extra dev --frozen
+
+      - name: Regenerate + diff
+        run: make check-ai

dlthub_start-0.1.0/.gitignore

@@ -0,0 +1,16 @@
+.venv/
+**/.venv/
+__pycache__/
+*.py[cod]
+.pytest_cache/
+.ruff_cache/
+dist/
+build/
+*.egg-info/
+**/.dlt/.var/
+**/.dlt/data/
+**/.dlt/state/
+**/_local/
+
+# Example workspaces created for testing
+examples/

dlthub_start-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,162 @@
+# Contributing
+
+Thanks for helping improve `dlthub-start`. This project uses a
+standard Python `src/` layout, `uv` for environment management, `ruff` for
+formatting/linting, and `mypy` for type checking.
+
+The package itself supports Python 3.10+. Generated dltHub workspaces currently
+target Python 3.12+ because their scaffold dependencies do.
+
+## Setup
+
+Install development dependencies into a local virtual environment:
+
+```bash
+make dev
+```
+
+Run the CLI from the checkout:
+
+```bash
+uv run dlthub-start --help
+```
+
+Create a workspace with the recommended non-interactive path:
+
+```bash
+uv run dlthub-start my-workspace --yes
+```
+
+Create a workspace without running the generated workspace dependency sync:
+
+```bash
+uv run dlthub-start my-workspace --yes --skip-uv-sync
+```
+
+Choose a scaffold or AI workbench explicitly:
+
+```bash
+uv run dlthub-start my-workspace --scaffold minimal_workspace
+uv run dlthub-start my-workspace --agent claude
+uv run dlthub-start my-workspace --agent claude --agent codex
+```
+
+Create a disposable test workspace under `examples/`:
+
+```bash
+make workspace
+```
+
+The `workspace` target recreates `examples/my-workspace` by default. It
+pre-deletes that directory before running the CLI, so only use it for
+throwaway local workspaces. To choose a different workspace name:
+
+```bash
+make workspace TEST_WORKSPACE_NAME=starter-demo
+```
+
+## Tests
+
+Run the fast unit test suite:
+
+```bash
+make test
+```
+
+Run the fast end-to-end coverage that avoids a real generated-workspace
+dependency sync:
+
+```bash
+uv run python -m unittest \
+  tests_integration.test_e2e_workspace.WorkspaceCreationFastTests \
+  tests_integration.test_e2e_workspace.InstalledEntryPointTests
+```
+
+Run all integration tests:
+
+```bash
+make test-integration
+```
+
+`make test-integration` includes a slow path that invokes the real CLI and runs
+`uv sync` in a generated workspace. It may require network access and can take
+noticeably longer than the unit suite.
+
+Run a quick bytecode compile check:
+
+```bash
+make compile
+```
+
+## Quality Checks
+
+Format code:
+
+```bash
+make format
+```
+
+Run linting and type checks:
+
+```bash
+make lint
+```
+
+Run the same format/lint/type-check sequence used by CI:
+
+```bash
+make lint-ci
+```
+
+Run the full local CI workflow:
+
+```bash
+make ci
+```
+
+`make ci` runs compile checks, linting, unit tests, integration tests, AI
+scaffold drift checks, and package build.
+
+## Build
+
+Build the package:
+
+```bash
+make build
+```
+
+The build artifacts are written to `dist/`.
+
+## AI Workbench Scaffolds
+
+The generated workspace includes vendored dltHub AI workbench files for Claude,
+Cursor, and Codex. These files are generated into each bundled scaffold, not
+downloaded during normal CLI execution.
+
+The source ref is pinned in `WORKBENCH_REF` in
+`src/create_dlthub_workspace/config.py`. To refresh the vendored AI files:
+
+1. Update `WORKBENCH_REF` to the desired `dlt-hub/dlthub-ai-workbench` commit.
+2. Run `make generate-ai`.
+3. Review the scaffold diff carefully.
+4. Run `make check-ai`.
+5. Commit the `WORKBENCH_REF` change and regenerated scaffold files together.
+
+`make check-ai` reruns generation and fails if the committed scaffolds drift
+from the pinned workbench ref.
+
+## Release Checklist
+
+Before publishing, verify:
+
+```bash
+uv run dlthub-start --help
+make ci
+```
+
+The package exposes a single console command:
+
+```text
+dlthub-start
+```
+

dlthub_start-0.1.0/LICENSE

@@ -0,0 +1,92 @@
+dltHub License
+
+Copyright 2026 ScaleVector, GmbH. All rights reserved.
+
+
+## Definitions
+
+"Agreement" means the agreement between ScaleVector, GmbH and its affiliates
+(collectively, "dltHub") and you governing the use of dltHub Services, including
+dltHub Platform, as those terms are defined in the applicable dltHub Terms of Use
+available at: https://dlthub.com/terms.
+
+"dltHub Services" means dltHub Platform and any other products or services offered
+by dltHub, as defined in the Agreement.
+
+"Derivative Works" means any work that is based on, incorporates, or is derived
+from the Licensed Materials, including but not limited to code generated with the
+assistance of the Licensed Materials, modified copies, adaptations, and projects
+into which the Licensed Materials is installed or integrated.
+
+"Licensed Materials" means the source code, object code, data, and/or other works,
+including educational materials, to which this license applies.
+
+## Scope of Use
+
+You may view, use, copy, modify, publish, and distribute the Licensed Materials
+solely in connection with dltHub Services under a governing Agreement. Any use of
+the Licensed Materials outside of dltHub Services is not permitted under this
+license.
+
+Without limiting the foregoing, the following are examples of permitted use:
+
+1. Using toolkits and skills provided by dltHub to develop, build, test,
+   and deploy data pipelines on dltHub Platform.
+2. Copying and modifying toolkit code for use exclusively with dltHub Services and on
+   dltHub Services.
+3. Using the Licensed Materials to generate code intended for deployment on dltHub
+   Platform.
+
+The following are examples of uses that are NOT permitted under this license:
+
+1. Using toolkits and skills provided by dltHub to generate code or pipelines for 
+   deployment on a third-party runtime platform or orchestration service that is not
+   part of dltHub Services.
+2. Modifying toolkits to replace, bypass, or substitute components that are part of
+   dltHub services in order to operate within a third-party development environment.
+3. Incorporating the Licensed Materials or Derivative Works into any product or
+   service that competes with the Licensed Materials, or any other dltHub Services.
+4. Providing the Licensed Materials to third parties as part of a hosted or managed
+   service that replicates the functionality of dltHub Services.
+
+Use beyond the scope of this license requires a separate license agreement
+negotiated with dltHub on a case-by-case basis.
+
+
+## Redistribution
+
+Redistribution of the Licensed Materials, with or without modification, is
+permitted provided that this license notice is included in all copies or substantial
+portions of the Licensed Materials. All recipients are bound by the same scope of
+use restrictions set forth in this license.
+
+## Intellectual Property
+
+dltHub retains all right, title, and interest in and to the Licensed Materials as
+originally published.
+
+dltHub waives all intellectual property claims over Derivative Works, provided that:
+
+1. The use of the Licensed Materials complies with the scope of use set forth in
+   this license, and
+2. This license notice is retained in all copies or substantial portions of the
+   Licensed Materials contained within the Derivative Works.
+
+This waiver extends to the Licensed Materials itself as incorporated into Derivative
+Works — you are free to use, modify, and distribute it within your Derivative Works
+without further restriction, subject only to the scope of use and redistribution
+terms above.
+
+
+## Disclaimer and Limitation of Liability
+
+THE LICENSED MATERIALS ARE PROVIDED "AS IS" WITH ALL FAULTS. DLTHUB AND ITS
+LICENSORS DISCLAIM ALL WARRANTIES, WHETHER EXPRESS, IMPLIED, STATUTORY, OR
+OTHERWISE, INCLUDING WITHOUT LIMITATION THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE, TITLE, AND NONINFRINGEMENT. DLTHUB AND ITS LICENSORS'
+TOTAL AGGREGATE LIABILITY RELATING TO OR ARISING OUT OF YOUR USE OF OR DLTHUB'S
+PROVISIONING OF THE LICENSED MATERIALS SHALL BE LIMITED TO ONE THOUSAND DOLLARS
+($1,000). IN NO EVENT SHALL DLTHUB OR ITS LICENSORS BE LIABLE FOR ANY LOST PROFITS,
+LOSS OF REVENUE, LOST BUSINESS, COSTS OF COVER OR ANY INCIDENTAL, SPECIAL,
+EXEMPLARY OR PUNITIVE DAMAGES OF ANY KIND OR NATURE IN CONNECTION WITH THIS LICENSE
+OR THE LICENSED MATERIALS.

dlthub_start-0.1.0/Makefile

@@ -0,0 +1,78 @@
+.DEFAULT_GOAL := help
+
+.PHONY: help dev test test-integration compile build ci workspace lint lint-fix format format-check fl lint-ci generate-ai check-ai
+
+PYTHONPYCACHEPREFIX ?= /tmp/create-dlthub-pyc
+PACKAGE_MODULES := $(wildcard src/create_dlthub_workspace/*.py)
+PYTHON_SOURCES := src tests tests_integration scripts
+
+help: ## Show this help message
+	@echo "Available targets:"
+	@grep -E '^[a-zA-Z0-9_.-]+:.*?## .*$$' $(MAKEFILE_LIST) \
+		| awk 'BEGIN {FS = ":.*?## "}; {printf "  \033[36m%-20s\033[0m %s\n", $$1, $$2}'
+
+#
+# Dev setup
+#
+
+dev: ## Install dev dependencies
+	uv sync --extra dev
+
+#
+# Linting and formatting
+#
+
+lint: ## Lint with ruff and type-check with mypy
+	uv run ruff check $(PYTHON_SOURCES)
+	uv run mypy $(PYTHON_SOURCES)
+
+lint-fix: ## Lint and autofix with ruff, type-check with mypy
+	uv run ruff check --fix $(PYTHON_SOURCES)
+	uv run mypy $(PYTHON_SOURCES)
+
+format: ## Format with ruff
+	uv run ruff format $(PYTHON_SOURCES)
+
+format-check: ## Check formatting with ruff (no writes)
+	uv run ruff format --check $(PYTHON_SOURCES)
+
+fl: format lint-fix ## Format and lint-fix in one shot
+
+lint-ci: format-check lint ## CI lint workflow (format-check then lint)
+
+#
+# Testing and build
+#
+
+test: ## Run unit tests (fast)
+	uv run python -m unittest discover -s tests -t .
+
+test-integration: ## Run e2e integration tests (slow; invokes real CLI + uv sync)
+	uv run python -m unittest discover -s tests_integration -t .
+
+compile: ## Byte-compile package and tests
+	PYTHONPYCACHEPREFIX=$(PYTHONPYCACHEPREFIX) uv run python -m compileall $(PACKAGE_MODULES) tests
+
+build: ## Build the package wheel
+	uv build
+
+TEST_WORKSPACE_NAME ?= my-workspace
+
+workspace: ## Create a test workspace under examples/ (pre-deletes existing)
+	@case "$(TEST_WORKSPACE_NAME)" in */*|*..*|"") echo "invalid TEST_WORKSPACE_NAME: $(TEST_WORKSPACE_NAME)"; exit 1;; esac
+	@echo "Recreating examples/$(TEST_WORKSPACE_NAME)"
+	rm -rf -- "examples/$(TEST_WORKSPACE_NAME)"
+	uv run dlthub-start "examples/$(TEST_WORKSPACE_NAME)"
+
+ci: compile lint-ci test test-integration check-ai build ## Run all CI checks locally
+
+#
+# Bundled AI workbench refresh
+#
+
+generate-ai: ## Refresh bundled AI workbench files in scaffolds (run after bumping WORKBENCH_REF)
+	uv run python scripts/generate_ai.py
+
+check-ai: ## CI guard: fail if generate-ai would produce a diff
+	$(MAKE) generate-ai
+	git diff --exit-code -- src/create_dlthub_workspace/scaffolds