ひかりの備忘録

Python のパッケージ管理ツールである Poetry を使ってみよう

Poetry のインストール

Poetry のインストールは pip で行う。 (pip のアップグレードもついでに行う。)

python -m pip install --upgrade pip
pip install poetry

Poetry で Python プロジェクトの作成

1. 新規で Python プロジェクトを作成する場合

新規に Python プロジェクトを作成する場合は、 poetry new を実行する。 Python プロジェクトのひな形が生成される。

poetry new xxxxxxxx

2. 既に Python プロジェクトがある場合

既に Python プロジェクトがある場合は、poetry init で Poetry の実行に必要な設定ファイルを追加する。

poetry init

Poetry の仮想環境に入る

poetry shell を実行で、 Poetry の仮想環境でシェルが起動する。 Poetry を利用して追加したパッケージが使用できる。

poetry shell

Poetry にパッケージを追加

poetry add で依存パッケージを追加できる。

poetry add xxxxxxxx

その他のよく使うコマンド

  • poetry list コマンド一覧を表示
  • poetry build パッケージの作成 (.tar.gz, .whl)
  • poetry install 依存パッケージのインストール
  • poetry publish pypi などに作成物を公開
  • poetry search パッケージの検索
  • poetry run Poetry 環境でコマンドを実行
  • poetry show 利用可能なパッケージを表示
  • poetry update 依存パッケージのアップデートを実行