Repository navigation
docs: install from the repository, not a nonexistent PyPI package - #2
Merged
Merged
Conversation
pycube-lut is not published on PyPI (pypi.org/pypi/pycube-lut/json returns 404), so the README's pip install pycube-lut and pycube-lut[hald] extras commands cannot work. Replace both with the git+https install form, matching what the headlessmode site already publishes for this tool. Verified the hald extra exists in pyproject.toml and both install forms succeed in throwaway venvs.
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.
Summary
The README told readers to run
pip install pycube-lutandpip install "pycube-lut[hald]". Neither can work —https://pypi.org/pypi/pycube-lut/jsonreturns 404, so the package has never been published to that index. Replaced both with git+ forms, matching what the headlessmode site already publishes for this tool.The
haldextra is real (pyproject.toml:30,hald = ["pillow>=9.0"]), so the extras variant is preserved using PEP 508 direct-reference syntax rather than dropped. The prose reference in the Limitations section repeated the same bad command and is fixed too. The Development section's editable install from a clone is correct and untouched.Test plan
curl -s -o /dev/null -w "%{http_code}" https://pypi.org/pypi/pycube-lut/json→404(the finding, re-verified before editing).pip install "git+https://github.com/Back-Road-Creative/pycube-lut"→ installedpycube-lut-0.1.0,numpy-2.5.1;import pycube_lutworks.pip install "pycube-lut[hald] @ git+https://github.com/Back-Road-Creative/pycube-lut"→ additionally installedpillow-12.3.0;import pycube_lut, PILworks.pypi,badge,shields.io,pip install— no other occurrence implies a PyPI release.