From d9e29ca0ee12fea492ded64a22586f419b9ecc55 Mon Sep 17 00:00:00 2001 From: FZ2000 Date: Thu, 30 Jul 2026 22:56:48 -0700 Subject: [PATCH] docs: real install instructions, now that 0.1.0 is on PyPI MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The README carried a warning that the name was unregistered and told people not to install it. That was correct when written and is wrong now: `da-sync` 0.1.0 is published, so the warning was itself the stale claim. Replaced with the actual `pipx install da-sync`, plus why pipx over pip for something that puts a command on your PATH. The note about neighbouring names stays, and now explains itself: `dacli` is an unrelated data-engineering tool, and `da-cli` is unregistered precisely because PyPI rejects it as too similar to `dacli` — which is the reason this ships as `da-sync`. Someone who finds the repo (named `da-cli`) and guesses the PyPI name will guess wrong, so the README should answer that before they install something else. --- CHANGELOG.md | 5 +++++ README.md | 22 +++++++++++++--------- 2 files changed, 18 insertions(+), 9 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 063e209..845c9ff 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,6 +11,11 @@ that disagrees with it, and PyPI therefore always matches the tag. ## Unreleased +### Changed + +- README documents the real `pipx install da-sync` path now that 0.1.0 is + published, replacing the placeholder that said it was unavailable. + ## 0.1.0 — 2026-07-30 First public release. diff --git a/README.md b/README.md index e1e9494..3bc49ba 100644 --- a/README.md +++ b/README.md @@ -105,19 +105,23 @@ cd ~/Documents/da-cli ./install.sh # copies da + the dacli package to ~/.local/share/da-cli/ and symlinks ~/.local/bin/da → that copy ``` -**Option B — pip install.** Not published yet. Use Option A for now. - -When it is published the distribution will be named **`da-sync`**, not -`da-cli`: +**Option B — pip install.** The distribution is named **`da-sync`**; the +command it installs is `da`. ```bash -pipx install da-sync # the command is still `da` +pipx install da-sync # isolated venv, recommended +da --version ``` -Two names on PyPI are close to this project and are **not** it: `dacli` -(an unrelated data-engineering tool) and `da-cli` (unregistered). Since -this package installs a `da` command onto your `PATH` and handles -DeviantArt OAuth tokens, check the name before installing anything. +`pip install da-sync` works too, but `pipx` gives the tool its own +environment, which is what you want for something that puts a command on +your `PATH`. + +Two neighbouring PyPI names are **not** this project: `dacli` (an +unrelated data-engineering tool) and `da-cli` (unregistered — PyPI +rejects it as too similar to `dacli`, which is why this ships as +`da-sync`). Since this package installs a `da` command and handles +DeviantArt OAuth tokens, check the name. Python 3.10+ required (uses `argparse.BooleanOptionalAction` and `X | None` syntax). No third-party runtime dependencies.