Correct installation instructions #21
Conversation
There was a problem hiding this comment.
While I support the addition of the uv install instructions, I would greatly appreciate keeping the pip instructions around as well, since I personally haven't made the switch to uv yet. So maybe keep a section that is "Install with pip", and "Install with uv".
For the pip command, can it be updated to be:
pip3 install --extra-index-url https://pypi.anaconda.org/OpenEye/simple "rcsb.workflow>=0.47"
If we can avoid using the --use-deprecated=legacy-resolver, that would be preferable I think.
There was a problem hiding this comment.
Also, can you please keep the git commands around at the top of the file?
git clone --recurse-submodules https://github.com/rcsb/py-rcsb_workflow.git
# or to make sure the submodules are updated --
git submodule update --recursive --init
git submodule update --recursive --remote
There was a problem hiding this comment.
@piehld I had planned to close this PR per our discussion. I'll go ahead and do that now, but feel free to re-open or copy any parts you like.
Because we confirmed that --use-deprecated=legacy-resolver is not required, I no longer see an urgent need to change the README.
There was a problem hiding this comment.
Also, can you please keep the
gitcommands around at the top of the file?git clone --recurse-submodules https://github.com/rcsb/py-rcsb_workflow.git # or to make sure the submodules are updated -- git submodule update --recursive --init git submodule update --recursive --remote
Up to you, but I recommend separating (A) wanting to develop or run tests (so cloning); and (B) just wanting to run commands (just pip/uv).
Also, the git submodule commands are unnecessary with --recurse-submodules. I always avoid listing too many options because it makes instructions longer and tends to be distracting.
That's also why I didn't show both uv and pip. Pip doesn't automatically make a venv, so python -m venv should probably be shown alongside.
This tells everyone to use
--use-deprecated=legacy-resolverand--extra-index-url https://pypi.anaconda.org/OpenEye/simple.Dennis, I wasn't quite sure about MySQL. I think it's always required, but maybe it's only needed when it falls back to compiling some packages. It doesn't appear documented elsewhere.