Poetryへの挑戦。使い方や利点等を調べる

2021-11-20
2021-11-20

Poetry がどうやら良いらしいと言うのを聞いて使い方等を調べてみました。

下記サイトを主に参照しています。

Poetry とは

簡単に言うと Python のパッケージマネージャー(依存関係管理ツール)です。 Pip と似たようなことができます。

Poetry の使い方

ここでは Poetry の基本的な使い方を説明します。 まずはpoetryコマンドを使用しプロジェクトが作成するところから始めます。

ちなみにここで紹介する内容も公式サイトを参考にしています。

Poetry のインストールとプロジェクトの作成

Poetry のインストールは osx や linux の場合は以下コマンドで可能です。

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

または、Pip コマンドでもできます。

pip install --user poetry

shell を再起動するとpoetryコマンドが使えるはずです。

次は実際に Poetry を使ったパッケージ管理を行っていきます。 始めるには既存のフォルダから始める場合と新しくプロジェクトフォルダを作るところから始める場合があります。

既存のフォルダ(※予め作業フォルダを自分で作成)では、以下のコマンドでPoetryを使用する設定が行えます。

poetry init

上記コマンドではフォルダ内に shell で対話形式でpyporoject.tomlの設定が行えます。

新しくプロジェクトごとpoetryコマンドで作成するには以下コマンドを使用します。

poetry new p <任意のプロジェクト>

そうするとプロジェクト名のフォルダが作成され、以下のようなファイルが生成されます。

.
├── README.rst
├── poetry_demo
│   └── __init__.py
├── pyproject.toml
└── tests
    ├── __init__.py
    └── test_poetry_demo.py

テストファイルまで作ってくれるのは意外でした。 新しくプロジェクトを作成するならpoetry newのコマンドを使ったほうが良さそうです。

Poetry でパッケージインストールと仮想環境の起動する方法

パッケージをインストールは以下のコマンドでできます。

poetry add <パッケージ>

試しにnumpyをインストールしてみます。

Pip とどう違う?