Heavy Watal
setuptools — Pythonパッケージ作成
- https://docs.python.org/3/tutorial/modules.html
- https://docs.python.org/3/reference/import.html
- https://packaging.python.org/
- https://setuptools.readthedocs.io/
ファイル構成
GitHubやローカルの開発環境から pip で直接インストールできる形。
pywtl/
├── LICENSE
├── README.md
├── entry_points.cfg
├── setup.cfg
├── setup.py
└── wtl/
├── __init__.py
└── hello.pyリポジトリ名(pywtl)とパッケージ名(wtl)は必ずしも一致してなくてもよい。
ローカルからのインストールは -e,--editable
オプションを付けることで余計なコピーを減らせるっぽい。
% pip install -v -e ~/git/pywtl/
% pip install -v git+https://github.com/heavywatal/pywtl.git
% python -m wtl.hellosetup.py
新しいsetuptoolsでは setup.cfg の設定を読み込んでくれるので、
setup() の引数にいろいろ渡す必要は無くなった。
from setuptools import setup
setup()setup.cfg
https://setuptools.readthedocs.io/en/latest/setuptools.html#configuring-setup-using-setup-cfg-files
[metadata]
name = wtl
version = 0.1
url = https://github.com/heavywatal/pywtl
author = Watal M. Iwasaki
author_email = heavy.watalあgmail.com
license = MIT
description = wtl: Personal Python package
long_description = file: README.md
[options]
zip_safe = False
packages = find:
entry_points = file: entry_points.cfglicense = file: LICENSE のように外部ファイルを参照することも可能。
install_requires = flake8; psutil
のようにセミコロン区切りで依存パッケージを列挙できる。
それらは pip install で自動的にインストールされ、
その後アンインストールするとそれを使わないモジュールでさえ
distribution was not found and is required
などと言って動いてくれなくなるくらい強制力が強い。
requirements.txt はsetuptoolsではなくpipの機能で、
能動的に pip install -r requirements.txt
を打たなきゃインストールされないし、
そこに列挙されたパッケージが無くても動くモジュールは動かせる。
entry_points
- https://setuptools.readthedocs.io/en/latest/setuptools.html#automatic-script-creation
- https://packaging.python.org/distributing/#entry-points
用途はいろいろあるけど
${prefix}/bin/ に実行可能ファイルを配置するのによく使われる。
設定は下記のように別ファイル entry_points.cfg として
setup.cfg から読ませるのが楽チン。
[console_scripts]
hello.py = wtl.hello:main引数を取らない関数のみ利用可能。
コマンドライン引数を処理したい場合は標準の
argparse が有効。
ソースコード
wtl/__init__.py- このディレクトリがひとつのパッケージであることを示すファイル。
空でもいいし、初期化処理やオブジェクトを記述してもよい。
__version__変数を定義すべしという記述も見かけるが、setup.cfgとの兼ね合いも考えると、どうしたもんか悩ましい。
wtl/hello.py
#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""
Sample module
"""
def main():
import getpass
print('Hello, ' + getpass.getuser() + '!')
if __name__ == '__main__':
main()MANIFEST.in
Pythonモジュール以外で配布物に含めたいもの、除外したいものがあれば
include, recursive-include, exclude
で指定する。
setuptools
python setup.py --help
python setup.py --help-commands
python setup.py ^i # zsh completion
# 開発中に使う
python setup.py build
python setup.py clean
python setup.py check
# 配布できる形に固める
python setup.py sdist
python setup.py bdist_wheel