Poetry入門 インストールから実行、バージョン管理まで

はじめに

備忘録としてPoetryの使い方を残します。

インストール

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

コマンド一覧

個人的に使いそうなコマンドを載せます。

Poetryのアップデート

poetry self update

プロジェクトの作成

poetry new <project-name>

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

poetry add <package-name>

パッケージのアンインストール

poetry remove <package-name>

パッケージ一覧を表示

poetry show

仮想環境内でのコマンドの実行

poetry run <commands...>

pythonでファイルを実行

poetry run python <file-name>

仮想環境内でシェルを立ち上げる

poetry shell

$SHELLに従ってシェルを立ち上げます

インストール後の始め方

インストール直後の場合、パスを通すためにsourceするか、シェルを再起動します

プロジェクト内に、仮想環境が作られるようにします

poetry config virtualenvs.in-project true

このコマンドはインストール後に、1回すればOK

サンプルプロジェクトを作成します

poetry new poetry-sample

プロジェクトディレクトリに移動

cd poetry-sample

追加したいパッケージをインストール
ここでは、numpyをインストール

poetry add numpy

poetry-sampleディレクトリで、sample.pyを作成

sample.py

import numpy as np

x = np.array([1, 2, 3])
print(x)

仮想環境内でシェルを立ち上げます

poetry shell

スクリプトを実行

python sample.py

または仮想環境でシェルを立ち上げずに、直接コマンドを実行して実行できます

poetry run python sample.py

以上のような流れで、プロジェクトの作成、パッケージの追加、プログラムの実行を行えます

スクリプトはpoetry-sample内になくても実行はできます

Pythonのバージョンの管理

pyenvを併用して行う方法です

Python3.7.0を例とします

まずpyenvで3.7.0がインストールされていなければインストールします

pyenv install 3.7.0

プロジェクト内のローカルのバージョンを変更します

pyenv local 3.7.0

コマンドで仮想環境を構築します

poetry env use 3.7.0

これでプロジェクト内のPythonのバージョンは3.7.0になります

最後に

とても便利なのでこれから使っていきたいです。