PyPI入門2018 5分サイズ

PyPI 入門 2018 5分サイズ 2018/10/08 Yukino Ikegami PyLadies Tokyo 4th Anniversary party

PyPI (パイピーアイ) とは • • • • https://pypi.org/ Python Package Indexの略 Pythonパッケージを管理するためのサイト/リポジトリ pip install *** の *** を置いてるところ

• https://pypi.org/

Pythonパッケージ公開までの手順 1. PyPIのアカウント作成 – https://pypi.org/account/register/ 2. setup.pyを書く 3. 開発 4. PyPIに登録/アップロード

• https://pypi.org/account/register/

setup.pyを書く

setup.pyに書くこと 1. まずsetuptoolsをimport – distutilsはオワコン 2. setuptools.setupメソッドにPyPIに登録する情報 を渡す • 有名パッケージのsetup.pyを参考にするといい

最低限setup.pyに書くこと • • • • • • • • name…………………パッケージの名前 version………………パッケージのバージョン description…………パッケージの短い説明 long_description….パッケージの長い説明 author………………作者 packages……………パッケージのパス license………………パッケージのライセンス install_requires…...依存パッケージのリスト

Setup.pyのlong_descriptionに 書いたほうがいいこと • パッケージの使い方 • バージョンごとの変更点 • reStructuredText フォーマットで書く – setup.pyに long_description_content_type=”text/markdown”, と追加すればMarkdown形式が可能に！

PyPIに登録/アップロード 1. Twineのインストール – pip install twine 2. パッケージのビルド 3. パッケージのアップロード

パッケージのビルド • ソースコードのビルド – python setup.py sdist • Wheelのビルド – pip install wheel – python setup.py bdist_wheel • 成果物はdistディレクトリにできる

パッケージのアップロード • twine upload dist/* • これだけ！

まとめ • Pythonパッケージの公開は簡単にできる！ – 細かい罠があるけど… (今回は触れない)

参考 • PyPIデビュー2015 • Python: Twine を使って PyPI にパッケージを アップロードする - CUBE SUGAR CONTAINER • 新しいPyPIでMarkdownのドキュメントを使う – Aki Ariga – Medium

• http://tell-k.github.io/pyconjp2015/
• https://blog.amedama.jp/entry/2017/12/31/175036
• https://medium.com/@chezou/1行修正で新しいpypiでmarkdownのドキュメントが使えた-14e40d90ff3f