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

No correct way to install Poetry? #4248

Closed
1 task done
remram44 opened this issue Jul 3, 2021 · 5 comments
Closed
1 task done

No correct way to install Poetry? #4248

remram44 opened this issue Jul 3, 2021 · 5 comments
Labels
area/docs Documentation issues/improvements

Comments

@remram44
Copy link
Contributor

remram44 commented Jul 3, 2021

Issue

The README recommends install-poetry.py. The docs recommend get-poetry.py. In either case, there is a warning message letting the user know that using that installer will not support upgrading to later versions. The get-poetry.py script, although the website claims "This is the recommended way of installing poetry.", literally states on use "This installer is deprecated."

I don't think installers should be both recommended and deprecated, and I think enough information should be given to users to determine whether they have done the wrong thing.

website screenshot

terminal screenshot

Proposed actions:

  • If there is no way to update from 1.2 using either installer, I think that's fine, but the warning in the installation script should make it clear that it is for technical reasons and not because they grabbed the wrong script.
  • The README here should match the website, and either both recommend get-poetry.py (mentioning that the recommended way will change for 1.2 is fine) or both install-poetry.py (with whatever caveats)
  • If the get-poetry.py is still the recommended way to install current Poetry (even if that will change), as per website, don't claim it is "deprecated". A tool is only "deprecated" once its replacement is generally available.
@remram44 remram44 added area/docs Documentation issues/improvements status/triage This issue needs to be triaged labels Jul 3, 2021
@rlam3
Copy link

rlam3 commented Jul 4, 2021

@remram44 I agree with your discussion here. This is happening similar to Docker installation approach to installing this poetry

#1879 (comment)

@13steinj
Copy link

13steinj commented Jul 5, 2021

I think the major issue here is that the master branch is out of sync with the website, whereas the website assumes the master branch is the (most current) release branch.

Perhaps the git-flow (pun intended) of things here is just wrong. Perhaps have a release branch that always points to the most current release. The website can reference it as necessary. The website is generated off of this branch.

And master (rename or not to develop) is used as the development branch.

All that said and done, if get_poetry.py should only be available when 1.2 is out as a release. Whereas currently, it is out as an alpha, with install_poetry meant to only install the alpha.

The "recommended" installer should never install alpha software.

@PaluMacil
Copy link

PaluMacil commented Jul 8, 2021

This caused me a good deal of time and frustration. The install instructions pointing to the website and then getting a warning that I was using a bad installer sent me in circles with install/uninstall and tweaking of Python and env vars. Finally I noticed that the script names were different, and a short time later I think I figured out which installer I was supposed to use. Still, it is unclear because it felt like I was doing something wrong either way: either a warning that I used a deprecated installer and wouldn't be able to upgrade or installing an alpha version instead of something marked as stable.

@finswimmer
Copy link
Member

With #4257 and #4249 I hopefully could fix the irritations.

@abn abn removed the status/triage This issue needs to be triaged label Mar 3, 2022
Copy link

github-actions bot commented Mar 2, 2024

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 2, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area/docs Documentation issues/improvements
Projects
None yet
Development

No branches or pull requests

6 participants