python-poetry / python-poetry/install.python-poetry.org

[Doc] Add PowerShell snippet in the installation instructions (web & scripts) to allow Windows users to modify `%PATH%` easier

オープン
#66 コメント 3 件 リアクション 3 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
Python
スター
255
フォーク
65
平均マージ
2時間 48分
マージ済み PR(30日)
1

説明

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

Issue

https://python-poetry.org/docs/master/#installing-with-the-official-installer

Add Poetry to your PATH

The installer creates a poetry wrapper in a well-known, platform-specific directory:

  • $HOME/.local/bin on Unix.
  • %APPDATA%\Python\Scripts on Windows.

If this directory is not present in your $PATH, you can add it in order to invoke Poetry as poetry.

Alternatively, the full path to the poetry binary can always be used:

  • $POETRY_HOME/bin/poetry if $POETRY_HOME is set.
  • ~/Library/Application Support/pypoetry/bin/poetry on MacOS.
  • ~/.local/share/pypoetry/bin/poetry on Linux/Unix.
  • %APPDATA%\pypoetry\Scripts\poetry on Windows.

The following snippet is helpful and should be appended in the document for Windows users:

if (-not (Get-Command poetry -ErrorAction Ignore)) { [Environment]::SetEnvironmentVariable("Path", [Environment]::GetEnvironmentVariable("Path", "User") + ";$env:APPDATA\Python\Scripts", "User") }

or (for PowerShell 6+)

if (-not (Get-Command poetry -ErrorAction Ignore)) { echo 'if (-not (Get-Command poetry -ErrorAction Ignore)) { $env:Path += ";$env:APPDATA\Python\Scripts" }' | Out-File -Append $PROFILE }

P.S. The script provided by https://install.python-poetry.org also needs this fix.

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

リンク先の official-installer ドキュメントのセクションにあるインストール手順から始め、install.python-poetry.org が提供するインストールスクリプトを調べてください。標準の PowerShell と PowerShell 6+ における Windows PATH の案内を比較し、その後、ドキュメントとスクリプトの両方が報告された Windows セットアップのケースに対応していることを確認してください。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
powershell, python
領域
cli, documentation
issue の種類
ドキュメント
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
45/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。