【Poetry】Poetryのチートシート

Installation #

• Linux, macOS, Windows (WSL)

  curl -sSL <https://install.python-poetry.org> | python3 -
  

• Windows (Powershell)

  (Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | py -
  

Commands

• プロジェクトの新規作成 #

  • poetry new [project-name]

• 既存プロジェクトの初期化

  • poetry init

• パッケージのインストール #

  • poetry install

• パッケージのアップデート #

  • poetry update

• パッケージの追加 #

  • poetry add [package-name]
  • オプション
    • --group -G: 依存関係を追加するグループを指定
    • --dev -D: (非推奨 代わりに -G dev を推奨) 開発環境の依存関係としてパッケージを追加
    • --look: poetry.lockファイルを更新 (インストールは行わない)

• パッケージの削除 #

  • poetry remove [package-name]

• 実行 #

  • poetry run [command]

• poetryのアップデート #

  • poetry self update

Configuration

• 設定の一覧表示 #

  • poetry config --list

• 設定値を初期化する #

  • poetry config [setting-key] --unset

• 仮想環境を構築しない #

  • poetry config virtualenvs.create false

• 仮想環境をプロジェクトと同一フォルダに構成する #

  • poetry config virtualenvs.in-project true

Managing environments

• 仮想環境に関する基本情報を表示
  • poetry env info

参考文献

• Poetry 公式