Skip to content

Commit a27caec

Browse files
committed
📝 Fix stale requirements.txt install command in the completion container guide
The migration to uv (#1472) deleted the root requirements.txt, but two references to it were left behind: the install step in docs/contributing.md and the build step in scripts/docker/Dockerfile. Since scripts/docker/compose.yaml builds from that Dockerfile, \docker compose run typer bash\ currently fails at image build time with the file not found, so the documented workflow for testing shell completion cannot be followed at all. The deleted requirements.txt started with \-e .\ plus the tests/docs requirement files. For this container only the project itself is needed, so \uv pip install -e .\ keeps the exact previous behaviour of installing Typer into the system Python, where ENV UV_SYSTEM_PYTHON=1 makes it land on PATH for \ yper --install-completion\.
1 parent a5882de commit a27caec

2 files changed

Lines changed: 2 additions & 2 deletions

File tree

‎docs/contributing.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ root@79c4b9b70cbe:/code#
3737
Then inside the container, you can install `typer` with:
3838

3939
```console
40-
$ uv pip install -r requirements.txt
40+
$ uv pip install -e .
4141
```
4242

4343
Then, you can start the shell you want to use, the one where you want to try out completion:

‎scripts/docker/Dockerfile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,4 @@ COPY . /code
2525

2626
WORKDIR /code
2727

28-
RUN uv pip install -r requirements.txt
28+
RUN uv pip install -e .

0 commit comments

Comments
 (0)