PoetryでPythonのパッケージ管理を始める方法

環境

Poetryは、仮想環境の生成・Pythonのパッケージ管理が可能なツールです。また、pipenvより処理が早いです。

基本的には、公式Docに従って進めれば OKです。

pipでインストールすることも可能ですが、非推奨なので今回はcurlでインストーラをダウンロードして、実行します

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

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

※get-poetry.pyやinstall-poetry.pyなどを使用している技術記事が多いですが、これらは旧インストーラーのため、エラーになるので注意ください

インストーラーを実行すると、OSごとに以下のディレクトリにPoetryがインストールされます。

※インストーラをcurlでダウンロードする際にPOETRY_HOMEでパスを指定することで変更は可能です

export PATH=$HOME/your pypoetry path:$PATH

パスが通っているか以下で確認して完了。

※windowsの場合は、環境変数を編集の項目から、ユーザー定義変数に%APPDATA%\pypoetry\venv\ScriptsをPATHに追加する

poetry --version

完全に新規でプロジェクトを作成する

poetry new project_name

すでにプロジェクトが存在する場合はこちら

poetry init

対話式で色々と聞かれるので、全て選択していく。

プロジェクト直下に、pyproject.tomlとpoetry.lockが生成される

lockファイルから環境を再現

poetry.lockがあるディレクトリで下記のコマンドを実行する。実行するとlockファイルからライブラリがインストールされるとともに、仮想環境が作成される

poetry install --no-root

デフォルトだと仮想環境は`~/Library/Caches/pypoetry/virtualenvs/` に作られるため、管理がしずらい。プロジェクト直下に作成するには、

poetryの設定一覧を表示

poetry config --list

デフォルトだと、virtualenvs.in-projectという設定値がnullないしfalseになっているので、これをtrueにしてからインストールコマンドを実行すると、プロジェクト直下に.venv等名称でディレクトリが生成される

poetry config virtualenvs.in-project true

poetry install --no-root

なお、上記を行う前に仮想環境をすでに作ってしまっていた場合、先に削除しておく必要がある

仮想環境の一覧を表示して、removeコマンドで対象の仮想環境を削除する

poetry env list

poetry env remove poetry-xx-py

poetry add library_name

poetry add mypy -D // dev-dependenciesの場合

poetry update

poetry remove pandas

poetry lock

いかがでしたでしょうか。本記事では、仮想環境の生成・Pythonのパッケージ管理が可能なツールであるPoetryについて紹介しました。このPoetryの導入手順と使用方法について具体的な例を挙げながらわかりやすく説明していますので、是非参考にしてみてください。