Poetry の使い方 [Python]

Poetry

Python Dependency Management and Packaging Made Easy

公式サイト：

Poetry [Official]

使い方

プロジェクトを作成する。

$ poetry new my_project

既存のフォルダ内で Poetry を初期化する。

$ poetry init

パッケージを追加する。

$ poetry add pyinstaller

パッケージを削除する。

$ poetry remove pyinstaller

追加されているパッケージを確認する。

$ poetry show

パッケージをインストールする。

$ poetry install

ドキュメント：

Basic Usage | Poetry [Official]

参考：

Poetry の使い方／パッケージ管理 | セルフメソッドな生き方

基本的な使い方 | cocoatomo

使い方をまとめてみた | アントレプレナー

Poetry – 依存関係管理とパッケージングを支援するツール | org-技術

導入

参考：

Poetry をサクッと使い始めてみる – Qiita

Poetry をインストールして使ってみた | kichi

Pipenv / Poetry を触ってみた所感 | zaki

Poetry のインストールと仮想環境作成先の変更／Pipenv が怪しくなってきたので、Poetry を使ってみるよ (takkii) | Music and Technology

Poetry でパッケージの依存管理 | け日記

poetry | ゼロから学ぶ Python

Poetry を使って Python のパッケージを管理する方法 | TechAcademy マガジン

インストール

インストールスクリプトをダウンロードして実行する。

$ curl -sSL https://install.python-poetry.org | python -

PowerShell からインストールする場合は、次のコマンドを実行する。

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

リポジトリ：

python-poetry/install.python-poetry.org: The Official Poetry Installation Script – GitHub

ドキュメント：

Install with the Official Installer | Poetry [Official]

参考：

Poetry + pyenv-win 覚書 – Qiita

パスを通す (PATH)

ラッパー

Poetry を呼び出すラッパーが作成される。

• Linux：$HOME/.local/bin
• Windows：%APPDATA%\Python\Scripts

直接参照

あるいは、配置されるスクリプトに直接パスを通す。

• Linux：~/.local/share/pypoetry/venv/bin/poetry
• macOS：~/Library/Application Support/pypoetry/venv/bin/poetry
• Windows：%APPDATA%\pypoetry\venv\Scripts\poetry.exe

Windows

PowerShell から次のコマンドを実行して、%APPDATA%\Python\Scripts をパスに追加する。

> [System.Environment]::SetEnvironmentVariable('path', $env:APPDATA + "\Python\Scripts;" + $env:Path, "User")

ドキュメント：

Add Poetry to your PATH – Install with the Official Installer | Poetry [Official]

仮想環境

仮想環境を開始する。

$ poetry shell

仮想環境を終了する。

$ exit

仮想環境外からコマンドを実行する。

$ poetry run python hello.py

仮想環境を確認する。

$ poetry env info

仮想環境で使用するインタプリターを変更する。

$ poetry env use /path/to/python

参考：

使い方をまとめてみた | アントレプレナー

システムパッケージを使用する

参考：

Poetry で管理した PoC で重複しがちなパッケージ管理を改善する | インゲージ開発者ブログ

パッケージを作成する

参考：

Poetry を使って Python パッケージを作成する | shotakaha

比較

参考：

2020 年の Python パッケージ管理ベストプラクティス – Qiita

ドキュメント

Documentation | Poetry [Official]

リポジトリ

python-poetry/poetry: Python Dependency Management and Packaging Made Easy – GitHub

リンク

Poetry Documentation 日本語訳 | cocoatomo

まとめ

Pyenv と Poetryでディレクトリ毎に Python 環境を切り替える手順／ノウハウまとめ | DevelopersIO