You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: refresh README for pip-install path additions
- Recommend Docker when available; document the [d/p] auto-detect prompt
and the failed-prereq fallback path
- Mention --no-demo, --api-port, tg start, and the auto-browser-open
- Drop the TG_STANDALONE_MODE=yes uv tool run … references
- Bump pip-install time estimate to 4-8 minutes (matching the intro_text)
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: README.md
+18-29Lines changed: 18 additions & 29 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -49,15 +49,17 @@ And it allows you to <b>make fast, safe development changes</b>.
49
49
50
50
TestGen can be installed two ways:
51
51
52
-
-**pip** (default, recommended for evaluation) — no Docker required. The installer downloads `uv`, installs Python 3.13 if needed, and installs TestGen with an embedded Postgres database.
53
-
-**Docker** — deploys TestGen as a Docker Compose application. Use for team eval on a shared VM, or if you already standardize on Docker.
52
+
-**Docker** (recommended when Docker is available) — deploys TestGen as a Docker Compose application. The most stable experience for persistent use; suited for team eval on a shared VM.
53
+
-**pip** — no Docker required. The installer downloads `uv`, installs Python 3.13 if needed, and installs TestGen in an isolated environment with an embedded Postgres database. Recommended for evaluation on machines where Docker isn't available.
54
+
55
+
`tg install` with no flag prompts you to pick. If Docker isn't fully available it lists which prerequisites failed and recommends pip instead. Pass `--docker` or `--pip` to skip the prompt.
54
56
55
57
Observability is always installed via Docker Compose.
56
58
57
-
| Install path| Required software |
59
+
| Install mode| Required software |
58
60
|---|---|
59
-
| TestGen (pip, default) |[Python](https://www.python.org/downloads/) 3.9+ (only needed to run the installer itself — TestGen will use Python 3.13 via `uv`). |
Check versions with `python3 --version`, `docker -v`, `docker compose version`.
63
65
@@ -82,27 +84,20 @@ The [Data Observability quickstart](https://docs.datakitchen.io/tutorials/quicks
82
84
83
85
Before going through the quickstart, complete the prequisites above and then the following steps to install the two products and setup the demo data. For any of the commands, you can view additional options by appending `--help` at the end.
84
86
85
-
### Install the TestGen application (pip, default)
86
-
87
-
`tg install` defaults to a pip-based install with an embedded Postgres database and no Docker requirement. The installer downloads `uv` (if it isn't already on your PATH), uses it to install Python 3.13 (if needed) and TestGen in an isolated environment, then prints credentials plus the command to start the app.
87
+
### Install the TestGen application
88
88
89
89
```shell
90
90
python3 dk-installer.py tg install
91
91
```
92
92
93
-
The process typically takes 2-5 minutes. On completion the installer writes credentials to `dk-tg-credentials.txt` and prints the `testgen run-app` command to start the UI in a separate terminal.
94
-
95
-
#### Install the TestGen application (Docker)
93
+
With no flag, the installer probes Docker, shows which prerequisites are met, and prompts you to pick Docker or pip. Pass `--docker` or `--pip` to skip the prompt.
96
94
97
-
If you prefer the Docker Compose install — for team evaluations on a shared VM, or if you already standardize on Docker — use the `--docker` flag:
95
+
***pip mode** — downloads `uv` (if not already on your PATH), uses it to install Python 3.13 (if needed) and TestGen in an isolated environment. Typically takes 4-8 minutes.
96
+
***Docker mode** — deploys TestGen as a Docker Compose application. Typically takes 5-10 minutes.
98
97
99
-
```shell
100
-
python3 dk-installer.py tg install --docker
101
-
```
98
+
On completion, the installer writes credentials to `dk-tg-credentials.txt`, generates demo data, and opens the TestGen UI in your default browser. Use `--no-demo` to skip demo generation. `--port` sets the UI port (default 8501); `--api-port` sets the API/MCP port (default 8530); `--ssl-cert-file` / `--ssl-key-file` enable HTTPS.
102
99
103
-
The Docker install takes 5-10 minutes. `--port` sets a custom localhost port (default 8501). `--ssl-cert-file` / `--ssl-key-file` enable HTTPS.
104
-
105
-
Either install path can later be upgraded with `python3 dk-installer.py tg upgrade` — the installer detects which flavor is present and upgrades accordingly.
100
+
Either install mode can later be upgraded with `python3 dk-installer.py tg upgrade` and restarted with `python3 dk-installer.py tg start` — the installer detects which flavor is present and routes accordingly.
106
101
107
102
### Install the Observability application
108
103
@@ -152,25 +147,19 @@ Leave this process running, and continue with the [quickstart guide](https://doc
152
147
153
148
## Useful Commands
154
149
155
-
### DataOps TestGen (pip install, default)
156
-
157
-
Start the app: `TG_STANDALONE_MODE=yes uv tool run testgen run-app` (reachable at `http://localhost:8501`)
150
+
### DataOps TestGen (pip install)
158
151
159
-
Stop the app: `Ctrl+C` in the terminal running `testgen run-app`
152
+
Start the app: `python3 dk-installer.py tg start` (reachable at `http://localhost:8501`, blocks until Ctrl+C)
160
153
161
-
Access the `testgen` CLI: `TG_STANDALONE_MODE=yes uv tool run testgen <command>`
154
+
Stop the app: `Ctrl+C` in the terminal running `tg start`
162
155
163
156
Upgrade the app to latest version: `python3 dk-installer.py tg upgrade`
164
157
165
158
### DataOps TestGen (Docker install)
166
159
167
-
The [docker compose CLI](https://docs.docker.com/compose/reference/) can be used to operate the installed TestGen application. All commands must be run in the same folder that contains the `docker-compose.yaml` file generated by the installation.
168
-
169
-
Access the _testgen_ CLI: `docker compose exec engine bash` (use `exit` to return to the regular terminal)
170
-
171
-
Stop the app: `docker compose down`
160
+
Start the app: `python3 dk-installer.py tg start` (or `docker compose up` from the install folder)
172
161
173
-
Restart the app: `docker compose up`
162
+
Stop the app: `docker compose down` from the install folder containing `docker-compose.yaml`
174
163
175
164
Upgrade the app to latest version: `python3 dk-installer.py tg upgrade`
0 commit comments