From 0e9ad2670a55fdc55aa99102fcfa733471846d1c Mon Sep 17 00:00:00 2001 From: parnexcodes Date: Sun, 11 Oct 2026 12:32:33 +0530 Subject: [PATCH 1/2] docs: launch-ready README Refs usedock/dock#97 Co-Authored-By: Claude Opus 5.5 --- README.md | 25 ++++++++++++++++++++----- 1 file changed, 20 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index be5c11a..62bdd4a 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,33 @@ # Dock Python SDK -The Python client for [Dock](https://github.com/usedock/dock): isolated Linux machines for agents, on your laptop, your servers, or our cloud. +Isolated Linux machines for agents. On your laptop, your servers, or our cloud. -> **Status:** not published to PyPI yet. +The Python client for [Dock](https://github.com/usedock/dock). Create docks, run commands in them, stop, resume and branch them from Python. ## Install -Not published to PyPI yet. Install from a checkout: +```sh +pip install git+https://github.com/usedock/dock-python +``` + +Python 3.9 or newer. The only runtime dependency is `httpx`. From a checkout, use `pip install -e .`. + +## Quickstart + +You need a control plane (self-hosted, or Dock Cloud when it opens) and an API key. To try docks without either, install the [`dock` CLI](https://github.com/usedock/docklet#install-the-cli), which runs docks locally with no account. ```sh -pip install -e . +export DOCK_API_URL=https://dock.example.com +export DOCK_API_KEY=dock_... ``` -Python 3.9 or newer. The only runtime dependency is `httpx`. +Then run the example below with your workspace ID. + + + +Docs: [SDKs](https://docs.usedock.io/sdks), [quickstart](https://docs.usedock.io/quickstart), [API](https://docs.usedock.io/api), [self-hosting](https://docs.usedock.io/self-hosting). + +> **Status:** early, and not published to PyPI yet; install from the git URL above. The `dock` CLI ships in signed releases (latest v0.2.0). ## Example From 76db61c4a5704a014d55ce43da2087d2e4787971 Mon Sep 17 00:00:00 2001 From: parnexcodes Date: Sun, 11 Oct 2026 12:39:59 +0530 Subject: [PATCH 2/2] docs: point questions at Discussions, drop the pinned CLI version Co-Authored-By: Claude Opus 5.5 --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 62bdd4a..1e0c317 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,9 @@ Then run the example below with your workspace ID. Docs: [SDKs](https://docs.usedock.io/sdks), [quickstart](https://docs.usedock.io/quickstart), [API](https://docs.usedock.io/api), [self-hosting](https://docs.usedock.io/self-hosting). -> **Status:** early, and not published to PyPI yet; install from the git URL above. The `dock` CLI ships in signed releases (latest v0.2.0). +Questions and ideas: [GitHub Discussions](https://github.com/usedock/dock/discussions). + +> **Status:** early, and not published to PyPI yet; install from the git URL above. The `dock` CLI ships in signed releases. ## Example