Repository navigation
📝 Fix stale requirements.txt install command in the completion container guide - #1981
Open
HyperionBurn wants to merge 1 commit into
Open
HyperionBurn wants to merge 1 commit into
HyperionBurn wants to merge 1 commit into
Conversation
Contributor
📝 Docs previewLast commit 7963544 at: https://66557a93.typertiangolo.pages.dev Modified Pages |
…ner guide The migration to uv (fastapi#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 `typer --install-completion`.
HyperionBurn
force-pushed
the
docs/fix-stale-requirements-install
branch
from
October 18, 2026 12:26
a27caec to
7963544
Compare
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
The migration to
uvin #1472 removed the rootrequirements.txt, but two references to it were left behind:docs/contributing.md— the "install typer inside the container" stepscripts/docker/Dockerfile— the finalRUNstepBecause
scripts/docker/compose.yamlbuilds directly from that Dockerfile:docker compose run typer bashcurrently fails while building the image, because the file theRUNstep reads no longer exists. That is the documented entry point for testing shell completion, so the whole workflow is blocked at the first command.This replaces both with
uv pip install -e ..Why
uv pip install -e .and notuv syncThe deleted
requirements.txtwas:So the previous behaviour was an editable install of the project itself into the container's Python, plus the test/docs/prek extras. The Dockerfile sets
ENV UV_SYSTEM_PYTHON=1, which is what makesuv pip installtarget the system interpreter — that is howtyperended up onPATH, which the rest of the guide depends on fortyper --install-completionandtyper demo.py <TAB>.uv pip install -e .preserves that exactly. I deliberately did not useuv sync, because it creates a project virtualenv at/code/.venvand would leavetyperoffPATHfor the steps that follow in the guide. The test/docs/prek extras are not needed here — this container is only used to exercise shell completion.How this was verified
requirements.txtis absent frommasterand from the working tree.39353af("⬆️ Migrate to uv", ⬆️ Migrate to uv #1472) showsrequirements.txt [removed]along withrequirements-tests.txt,requirements-docs.txtandrequirements-docs-tests.txt. That same commit already updated the other install section indocs/contributing.mdtouv sync, but did not touch the container guide or the Dockerfile.a6a2a37to confirm it started with-e ..requirements.txtreference; only the historical entry indocs/release-notes.mdremains, which is correct as a changelog record.Only two lines change.