最近の python ライブラリのパッケージング手法を調査

最近の python package の記述の仕方で、 pyproject.toml なる作法があるのでメモ。

元々、 setup.py や setup.cfg で記述していたのだけどこれに変わるものらしい。 setup.py はともかく setup.cfg が大変分かりにくいと思っていました。 というか、何か調べにくい。 setup.py を宣言的に書けるよ、詳しくは setup.py のリファンンスを見て。みたいになっているのだけど、 書き方がよくわからんことが多かった。

• (2016)Python パッケージ管理技術まとめ (pip, setuptools, easy_install, etc)

2013年に distribute は setuptools にマージされた

pyproject.toml

• (2019)pyproject.toml とは何か

pyproject.toml は Node.js の package.json などのように、そのプロジェクトに関する様々なことを定義できるファイルとして存在しています

なるほど。

• (2019)pip が 19.02 で pyproject.toml から pip install できるようになった

pyproject の build-system

• (2019)https://engineer.recruit-lifestyle.co.jp/techblog/2019-12-25-python-packaging-specs/

setuptools

[build-system]
requires = [
    "setuptools>=42",
    "wheel"
]
build-backend = "setuptools.build_meta"

• https://packaging.python.org/tutorials/packaging-projects/#creating-pyproject-toml

• (2021)PyPIパッケージのリリースもバージョニングもGitHub単独で完結させる

[build-system]
requires = ["setuptools>=45", "wheel", "setuptools_scm>=6.2"]

なるほど。 setup.cfg と pyproject.toml の役割が被っていると思うのだが両方要るのだろうか。

• (2021)PyPIにパッケージを公開する手順の整理

pyproject.toml には build-backend の指定だけを記述して、 setup.cfg と併用するということでよさそう。

• (2018)Python の setup.py の内容を setup.cfg で管理する

setup.py & setup.cfg

setup.py

from setuptools import setup
setup()

• https://packaging.python.org/guides/distributing-packages-using-setuptools/

• https://github.com/dephell/dephell/blob/master/setup.py

setup.cfg: metadata

• https://packaging.python.org/specifications/core-metadata/

setup.cfg: options

setup.cfg: options.entry_points

• https://setuptools.pypa.io/en/latest/userguide/entry_point.html

setup.cfg:

• Package Discovery and Namespace Package

poetry

[build-system]
requires = ["poetry>=0.12"]
build-backend = "poetry.masonry.api"

• (2019)https://rcmdnk.com/blog/2019/02/04/computer-python/

• (2018)Poetryを使ったPythonパッケージ開発からPyPI公開まで

練習

https://github.com/ousttrue/glglue に使ってみる。 結局、 setup.cfg を使っているのとあまり変わらず。 setuptools_scm による git tag を version 化する技を覚えた。 あと、github actions。 そのうち、 setup.cfg の内容を pyproject.toml に書けるようになりそうではある。