poetryとは
PoetryはPythonでの依存関係管理とパッケージングのためのツールです。 Poetryを使うとプロジェクトが依存しているライブラリを宣言でき、それらを管理 (インストールおよびアップデート) してくれます。
poetryのインストール方法(Windows)
PowerShellで以下のコマンドを実行。
(Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | python -
このコマンドで公式のインストールスクリプトをダウンロードし、デフォルトのPythonインタープリタを使用して実行します。以下のような内容が出力されたらパスをコピーして環境変数のpathに追加してください。
To get started you need Poetry's bin directory
(C:\Users\*******\AppData\Roaming\Python\Scripts)
environment variable.
PowerShellを再起動し以下のコマンドでpoetryを使用できるか確認します。
poetry --version
出力としてPoetry (version *.*.*)が返ってきたらインストール成功です。検出できない等のエラーが出た場合は環境変数のpathが間違っている可能性が高いです。
Poetryでよく使うコマンド一覧表
以下に、poetryでよく使用されるコマンドの一覧を表形式で整理しました。
| コマンド | 説明 |
|---|---|
poetry new <package-name> |
新しいプロジェクトを作成します。 |
poetry init |
既存のディレクトリに新しいプロジェクトを初期化し、pyproject.tomlファイルを作成します。 |
poetry add <package> |
プロジェクトに新しい依存関係を追加します。開発用依存関係は--devフラグを使用。 |
poetry remove <package> |
プロジェクトから依存関係を削除します。 |
poetry update |
pyproject.tomlで指定された依存関係を最新の互換バージョンに更新します。 |
poetry lock |
依存関係をロックし、poetry.lockファイルを生成します。これにより依存関係のバージョンが他の環境で一致するようになります。 |
poetry install |
pyproject.toml や poetry.lock に基づいて依存パッケージをインストールします。 |
poetry shell |
プロジェクトの仮想環境に入ります。環境が存在しない場合は自動的に作成されます。 |
poetry run <command> |
仮想環境内でコマンドを実行します。例えば、アプリケーションやスクリプトを実行する場合に使用します。 |
poetry show |
インストールされたパッケージのリストを表示します。依存関係のツリーも表示可能です。 |
poetry check |
pyproject.tomlファイルの設定が正しいかどうかを検証します。 |
poetry self update |
poetry自体を最新バージョンにアップデートします。特定のバージョンにアップデートしたい場合は、バージョン番号を引数として指定します。 |
poetry config --list |
現在の設定値を一覧表示します。 |
poetry config <key> <value> |
グローバル設定を追加または更新します。例えば、デフォルトのリポジトリを設定する場合などです。 |
poetry config --unset <key> |
指定した設定キーを削除します。 |
ここで紹介したコマンドと表は、poetryを使用する際の基礎となりますが、プロジェクトの特定の要件に応じて、さらに多くのコマンドやオプションがpoetryには用意されています。最新の情報や詳細なドキュメントは、poetryの公式サイトやコマンドラインツールのヘルプ出力を参照してください。これらのリソースを利用することで、poetryの全機能を最大限に活用し、Pythonプロジェクトの管理をより効果的に行うことができるようになります。
poetry公式サイト
https://python-poetry.org/docs/