Skip to main content

Scaffold a dltHub workspace into a new or existing directory.

Project description

dlthub-init (beta)

Scaffold a dltHub workspace into a new or existing directory.

dlthub-init lays down the files of a minimal dltHub workspace — pyproject.toml, a locked uv.lock, and the .dlt/ configuration — and optionally creates the virtual environment. That is all it does: it does not log in, run a pipeline, or install agent toolkits.

Unlike dlthub-start, it is safe to run inside an existing repository. It is non-destructive by default: it never overwrites your files, and it stops before writing anything if a generated path would collide with something already there.

Usage

uvx dlthub-init             # initialize the current directory
uvx dlthub-init my-workspace  # initialize ./my-workspace

After scaffolding, dlthub-init offers to create a virtual environment and install dependencies with uv.

Options

Flag Effect
--no-sync Scaffold files only; do not create a venv or install dependencies.
--force Overwrite existing generated files (never secrets).
--merge Append missing entries to an existing .gitignore instead of skipping it.
--no-pyproject Skip pyproject.toml.
--no-gitignore Skip .gitignore.
--verbose, -v Stream output from uv.

Collision behavior

dlthub-init is safe to run in an existing directory:

  • Missing files are created.
  • The run stops only if .dlt/.workspace already exists — the directory is already a dltHub workspace (override with --force).
  • Otherwise existing files are left alone and reported as skipped: your pyproject.toml, .dlt/config.toml, and .dlt/secrets.toml are never overwritten, and .gitignore is skipped (or merged with --merge).
  • uv.lock is written only when pyproject.toml is created, so the lockfile always matches the workspace's dependencies.
  • --force overwrites the generated files (never secrets).

Development

make dev      # install dev dependencies
make lint     # ruff + mypy
make test     # unit tests
make ci       # full local CI

The bundled workspace lives in src/dlthub_init/scaffolds/minimal_workspace. After editing its pyproject.toml, run make scaffold-lock-upgrade to refresh the committed uv.lock.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dlthub_init-0.1.2.tar.gz (232.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dlthub_init-0.1.2-py3-none-any.whl (200.9 kB view details)

Uploaded Python 3

File details

Details for the file dlthub_init-0.1.2.tar.gz.

File metadata

  • Download URL: dlthub_init-0.1.2.tar.gz
  • Upload date:
  • Size: 232.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.9 {"installer":{"name":"uv","version":"0.11.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for dlthub_init-0.1.2.tar.gz
Algorithm Hash digest
SHA256 68935ce0328178202f438ca4fd07e34539bed0597e9722a7651dd991e02d5aa9
MD5 b894d55a70c7a57aa2a4ec1a8cc6056d
BLAKE2b-256 4b6d9a9ec274710ad9774ab3a185b6b991cc27a119c140144ac9aa35c4ac4d31

See more details on using hashes here.

File details

Details for the file dlthub_init-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: dlthub_init-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 200.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.9 {"installer":{"name":"uv","version":"0.11.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for dlthub_init-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 efc74c4c28b5ed7c2186e9834d46b80689b913c04e42596c141aea5b9428ff8c
MD5 2ee7ed1cbe6adbe05748e22c2f1fa873
BLAKE2b-256 2af36c7f2768918edd010fc75ca08144f99449d34bbb7f969d98fe6dceb17132

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page