【注意】 本記事は古いです
本記事の情報は古くなっており現在では利用できないコマンドがいくつかあります。(2018年2月4日現在)
以下の記事を参考にしていただくことを推奨します。
はじめに
初めてPyPIにライブラリを登録した。
ので
やったこと、勉強したことをまとめます。
参考にしたサイト
公式のsetuptoolsの使い方サンプルレポジトリ
settools使い方基本
setup.pyにパッケージ情報を書く
$ python setup.py sdist->ソースパッケージ作成
$ python setup.py install->パッケージインストール
一般的な配布するまでのコマンド
PyPIアカウントを作成→PyPy User profile
$ python setup.py test
$ python setup.py register
$ python setup.py sdist bdist_egg upload
$ python setup.py upload_docs
必要最小？？？
PyPIアカウントを作成→PyPy User profile
$ python setup.py register
$ python setup.py sdist upload
更新するとき
setup.pyのversionを変更して
$ python setup.py sdist upload
setup()関数の引数の意味
-
name
- PyPI上で示されるプロジェクト名
-
version
- バージョン
- description
- プロジェクトの簡単な概要。PyPIにて示される
- url
- プロジェクトのホームページ
- authorとauthor_email
- 製作者について
- license
- ライセンスのタイプ
- classifiers
- プロジェクトのカテゴライズのリスト
- keywords
- プロジェクトのキーワード
-
pakages
- 本プロジェクトで必要なパッケージのリスト。パッケージとはディレクトリ
-
simpleapiというディレクトリ以下にものをつくったならば、 -
packages=['simpleapi']となる - また、
from setuptools import setup, find_packagesとして packages=find_packages(excluede['contrib', 'docs', tests*])- とできる
- ※ excludeは対象以下のディレクトリは除くということ
-
install_requires
- 依存するパッケージ(事前にpipしておく必要があるもの)
- package_data
- 追加としてプロジェクトに必要となるパッケージ
- 詳細はまた後日調べて書きたい
- data_files
- さらに追加で必要となるファイル
- script
- インストール時に実行するスクリプト
- entry_points
- よくわからない。後日調べて書きたい
- console_scripts
- よくわからない。後日調べて書きたい