Document the Python 3.12 requirement in the dev setup - #1
Merged
Conversation
pyproject declares requires-python >=3.12, but the setup instructions did not, so the first documented command fails on a machine whose default python3 is older: ERROR: Package 'noplag-engine' requires a different Python: 3.11.3 not in '>=3.12' Python 3.11 is still the system default on plenty of setups, so this is the first thing a new contributor hits. States the requirement and creates the virtualenv with an explicit interpreter.
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.
pyproject.tomldeclaresrequires-python = ">=3.12", but neither the README nor CONTRIBUTING mentioned it — so the first documented command fails on any machine whose defaultpython3is older:Python 3.11 is still the system default on plenty of setups, so this is the first thing a new contributor hits, and the error doesn't say what to do about it.
States the requirement in both files and creates the virtualenv with an explicit interpreter.
Found while verifying the repo end to end before making it public. Everything else checked out:
docker compose upserves in ~70s with the 899-doc sample corpus loaded, the documented API flow works, a verbatim passage is detected at 100% with the correct source, the demo page renders the match as a clickable Wikipedia link,ruffis clean, and 170 tests pass.