chore: remove orphan requirements.txt#29
Open
MackDing wants to merge 1 commit into
Open
Conversation
requirements.txt is not referenced anywhere in the repo (README, 'setup', pyproject.toml, or any docs) and is out of sync with pyproject.toml in both directions: - lists 'pyyaml' (zero imports in needle/) - missing 'tqdm' (imported in 5 places in needle/) - missing 'scipy' (declared in pyproject.toml) The documented install path is 'source ./setup', which calls 'pip install -e .' and only ever consults pyproject.toml. Anyone trying 'pip install -r requirements.txt' as a guess gets a broken environment (no tqdm). Deleting it removes a footgun and leaves pyproject.toml as the single source of truth for deps. Signed-off-by: Blossom <svip87@iCloud.com>
MackDing
force-pushed
the
chore/remove-orphan-requirements-txt
branch
from
e87dfe6 to
4d7bde9
Compare
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
1 participant
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
Delete
requirements.txt. It's not referenced anywhere and is out of sync withpyproject.toml.Why
The documented install path in the README is:
./setupcallspip install -e ., which reads onlypyproject.toml.requirements.txtis consulted by nothing in the repo (no README, nosetup, no CI, no docs).It's also out of sync with
pyproject.tomlin both directions:requirements.txtpyproject.tomlneedle/pyyamltqdmscipyNet effect: anyone who guesses
pip install -r requirements.txtends up with a broken env (notqdm, ImportError as soon as they run training/data scripts) and an unneeded dep.How
- requirements.txt (deleted)That's the whole change.
pyproject.tomlstays the single source of truth.Alternatives considered
requirements.txtto matchpyproject.toml— keeps two files in lockstep forever; nothing referencesrequirements.txttoday, so the second file would still drift. Happy to do this instead if you'd rather keep a generated requirements file (e.g. for Docker / non-pip install -e .consumers).