poetry 超入門

• 概要
• 環境
• インストール
• .zshrc の編集
• プロジェクトの作成
• ライブラリの追加
• 実行する
• 最後に
• 参考サイト

概要

pipenv でも十分ですが poetry を使えば pypi で公開する場合に便利です

環境

• macOS 11.6.8
• Python 3.10.2
• poetry 1.1.14

インストール

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

.zshrc の編集

以下を追記します

export PATH="/Users/username/.local/bin:$PATH"

一旦ログアウトして

• poetry --version

でバージョンが表示されるか確認します

プロジェクトの作成

• poetry new test

既存プロジェクトに対して適用する場合は poetry init になります

ライブラリの追加

• cd test
• poetry add requests

git clone などで持ってきたプロジェクトに対して poetry.lock を元にインストールする場合は poetry install します

実行する

• vim test/test.py

import requests

res = requests.get('https://kaka-request-dumper.herokuapp.com/')
print(res)

• poetry run python test/test.py

ちゃんと追加したライブラリが使えてることが確認できると思います

最後に

pyproject.toml と poetry.lock は git に含めるようにしましょう

あとは Pypi で公開する方法や poetry shell なども使えます

参考サイト

• https://python-poetry.org/docs/master/basic-usage/