-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Clarify poetry usage in Readme #258
Comments
Would it help to elevate ucc/docs/source/contributing.rst Lines 25 to 26 in 1c1b6f1
Note that |
We want to invite contribution as a major tenant of UCC so I think it's important to elevate how folks can do this. Also, when I run Looks like you're trying to use a Poetry command that is not available.
Since Poetry (2.0.0), the shell command is not installed by default. You can use,
- the new env activate command (recommended); or
- the shell plugin to install the shell command
Documentation: https://python-poetry.org/docs/managing-environments/#activating-the-environment
Note that the env activate command is not a direct replacement for shell command. On the other hand, if we did switch to uv (#209) this particular issue would become moot. |
Oh good catch. I didn't realize that shell was deprecated. I can take this issue to address for now and can keep in mind on a transition to uv |
In our README we advise users to install using poetry, but do not follow up by noting that you must either activate the newly created poetry environment or prepend
poetry run
in front of all commands you want to run in it.Why call this out?
In my experience, most people in this field are far more used to
pip install
and the basic setuptools workflow, which installs in whatever environment you happen to be in and relies on the user to create the appropriate virtual environment. With pip, no additional steps are required between install and running a program using the newly installed library; however with poetry, the additional step is required.The text was updated successfully, but these errors were encountered: