Skip to content
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

CONTRIBUTE.md references deprecated 'poetry shell' #5509

Open
cobalt-e opened this issue Feb 8, 2025 · 1 comment · May be fixed by #5538
Open

CONTRIBUTE.md references deprecated 'poetry shell' #5509

cobalt-e opened this issue Feb 8, 2025 · 1 comment · May be fixed by #5538

Comments

@cobalt-e
Copy link

cobalt-e commented Feb 8, 2025

In CONTRIBUTE.md's Setup section, users are instructed to use poetry shell to activate the virtual environment.

Poetry released a major upgrade to 2.0.0 in early January. This introduced a breaking change where the poetry shell command was removed completely.

The official documentation now recommends either passing the command poetry env activate to the shell, or installing the poetry-plugin-shell to add this command back to Poetry.

Poetry itself is a bit vague on the issue when it mentions none of these directly in response to poetry shell.

~/s/textual (main)> poetry shell

The command "shell" does not exist.

Did you mean one of these?
    self show
    self sync
    show
    self add
    self install
    install
    self lock
    help

This will need to be added to the documentation rather than replacing the old command, as not all OS have added the new version of Poetry to their stable repos yet (Debian Bookworm naturally being one that I've found at least).

ETA: There's also a fix to an issue for bash/fish/zsh shells awaiting the 2.1.0 release as currently poetry env activate doesn't act like old poetry shell where it created a virtual environment for you if one did not already exist (have to poetry env use as described on official website first).

Copy link

github-actions bot commented Feb 8, 2025

We found the following entry in the FAQ which you may find helpful:

Feel free to close this issue if you found an answer in the FAQ. Otherwise, please give us a little time to review.

This is an automated reply, generated by FAQtory

dominikgehl added a commit to dominikgehl/textual that referenced this issue Feb 16, 2025
@dominikgehl dominikgehl linked a pull request Feb 16, 2025 that will close this issue
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant