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

get/install-poetry.py - confusing installation instructions #4598

Closed
1 task done
vlcinsky opened this issue Oct 5, 2021 · 7 comments
Closed
1 task done

get/install-poetry.py - confusing installation instructions #4598

vlcinsky opened this issue Oct 5, 2021 · 7 comments
Labels
area/docs Documentation issues/improvements

Comments

@vlcinsky
Copy link
Contributor

vlcinsky commented Oct 5, 2021

  • I have searched the issues of this repo and believe that this is not a duplicate.

Issue

User trying to install poetry using current documentation might have following experience:

Installation contains infobox:

The get-poetry.py script described here will be replaced in Poetry 1.2 by install-poetry.py. From Poetry 1.1.7 onwards, you can already use this script as described here.

Following osx / linux / bashonwindows install instructions show only url to download an run get-poetry.py

Running get-poetry.py prints "this installation script is obsolete".

Beside that, with poetry 1.1.1 I had an issue with "ModuleCannotBeFound" for cleo module.

Proposal - add or change the link to install-poetry.py

Taking into account, that even obsolete get-poetry.py script installs the version higher than 1.1.7, it would be better to change the instruction to use install-poetry.py instead.

Change it to:

curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/install-poetry.py | python -

It saves the "obsolete" message and to me it worked better.

@vlcinsky vlcinsky added area/docs Documentation issues/improvements status/triage This issue needs to be triaged labels Oct 5, 2021
@vlcinsky
Copy link
Contributor Author

vlcinsky commented Oct 5, 2021

I see, that the "master" version of documentation already contains proposed change.

However, for version 1.1 it shows the older instruction.

It would be great to have it changed for 1.1 too.

@finswimmer
Copy link
Member

Hello @vlcinsky,

the infobox you are citing includes the link to the description of install-poetry.py. So I'm not sure what you are missing here.

fin swimmer

@vlcinsky
Copy link
Contributor Author

vlcinsky commented Oct 8, 2021

@finswimmer go to https://python-poetry.org/docs/ which shows doc for poetry version 1.1 (not for "master").

There is "install-poetry.py" mention in the infobox, but there is no url on this text and the curl instruction reads:

curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python -

On "master" version the instruction is correct but taking into account that default page goes to version "1.1", things are confusing.

@finswimmer
Copy link
Member

The word "here" is linking to the documentation of install-poetry.py, isn't it?

@DanielJamesEvans
Copy link

I couldn't get get-poetry.py to work with Python 3.10, but I solved my issue by switching to install-poetry.py. Perhaps I was making an error, but I don't think so: here also suggests that switching to install-poetry.py fixes issues. Users are still erroneously using get-poetry.py, as seen here.

While it's good practice to use the most current software version, nothing in the current docs suggests that using the old version (get-poetry.py) is incorrect. To me, the issue is that users can follow an allegedly correct procedure and get an error message..

@finswimmer
Copy link
Member

While it's good practice to use the most current software version, nothing in the current docs suggests that using the old version (get-poetry.py) is incorrect.

In general there's nothing wrong with using get-poetry.py. It's just deprecated, which means "be aware that this will be replaced by another way of doing it soon". The problems with python 3.10 in windows are due to the missing _vendor folder in the release (see #4846 (comment)). This was not intended and will be fixed by a new release.

@Secrus Secrus closed this as completed May 23, 2022
@mkniewallner mkniewallner removed the status/triage This issue needs to be triaged label Jun 11, 2022
Copy link

github-actions bot commented Mar 1, 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 1, 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

5 participants