LoginSignup
28
22

More than 5 years have passed since last update.

setuptools コマンド覚書

Last updated at Posted at 2015-11-21
setup.py --help-commands

で表示される英文の和訳です。間違ってるところがあったら教えてください。

usage:

setup.py [global_opts] cmd1 [cmd1_opts] [cmd2 [cmd2_opts] ...]
setup.py --help [cmd1 cmd2 ...]
setup.py --help-commands
setup.py cmd --help

Standard commands:

setup.py build

インストールに必要なものを全てビルドする。

setup.py build_py

Python モジュールをビルドする。(build ディレクトリへコピーする)

setup.py build_ext

C/C++ 拡張をビルドする。(buld ディレクトリへの compile/link を実行する)

setup.py build_clib

Python 拡張として使用する C/C++ ライブラリをビルドする。

setup.py build_scripts

スクリプトをビルドする。(#! が含まれる行をコピーし、補正する)

setup.py clean

setup.py build コマンドによって作成された一時ファイルを削除する。

setup.py install

build ディレクトリから全てをインストールする。

setup.py install_lib

全 Python モジュール(C/C++ 等による拡張モジュールと Python モジュール)をインストールする。

setup.py install_headers

C/C++ のヘッダーファイルをインストールする。

setup.py install_scripts

スクリプトをインストールする。(Python か否かは問わない)

setup.py install_data

データファイルをインストールする。

setup.py sdist

ソース配布物(tarball, zip file, etc.)を作成する。

setup.py register

Python package index へ配布物を登録する。

setup.py bdist

ビルド済み(バイナリ)の配布物を作成する。

setup.py bdist_dumb

dump 形式でビルドした配布物を作成する。

setup.py bdist_rpm

RPM 形式の配布物を作成する。

setup.py bdist_wininst

MS Windows 用のインストーラを作成する。

setup.py upload

PyPI へバイナリパッケージをアップロードする。

setup.py check

パッケージのチェックを実行する。

Extra commands:

setup.py saveopts

指定されたオプションを setup.cfg や他の設定ファイルへ保存する。

setup.py develop

パッケージを開発モードでインストールする。

setup.py upload_docs

PyPI へドキュメントをアップロードする。

setup.py test

ビルド実行後に unittest を実行する。

setup.py setopt

setup.cfg や他の設定ファイルのオプションを設定する。

setup.py install_egg_info

パッケージの .egg-info ディレクトリをインストールする。

setup.py rotate

N 番目の新しいファイルを残して、古い配布物を削除する。

setup.py bdist_wheel

wheel 形式の配布物を作成する。

setup.py egg_info

配布物の .egg-info ディレクトリを作成する。

setup.py alias

コマンド単体または複合コマンドを実行するショートカットを定義する。

setup.py easy_install

Python パッケージを検索/取得/インストールする。

setup.py bdist_egg

egg 形式の配布物を作成する。

setup.py build_sphinx

Sphinx ドキュメントをビルドする。

Global options:

--verbose (-v)

コマンド実行時に結果を表示する。(既定の動作)

--quiet (-q)

結果を表示せずにコマンドを実行する。(結果表示をオフにする)

--dry-run (-n)

コマンドを実行せずに、何が行われるのかを表示する。

--help (-h)

ヘルプメッセージの詳細を表示する。

--no-user-cfg

ホームディレクトリ内の pydistutils.cfg を無視する。

--command-packages

distutils コマンドを提供するパッケージを一覧表示する。

情報を表示するオプション:

Note:
情報の表示のみを実行し、他のコマンドは無視される。

--help-commands

使用可能なコマンドを表示する。

--name

パッケージ名を表示する。

--version (-V)

パッケージのバージョンを表示する。

--fullname

下記の形式でパッケージのフルネームを表示する。

<package name>-<version>

--author

パッケージ作成者の名前を表示する。

--author-email

パッケージ作成者の email アドレスを表示する。

--maintainer

メンテナーの名前を表示する。

--maintainer-email

メンテナーの email アドレスを表示する。

--contact

判ればメンテナー名を表示し、判らない場合はパッケージ作成者の名前を表示する。

--contact-email

判ればメンテナーの email アドレスを表示し、
判らない場合はパッケージ作成者の email アドレスを表示する。

--url

パッケージの URL を表示する。

--license

パッケージのライセンスを表示する。

--description

パッケージの説明を表示する。

--long-description

パッケージの詳細説明を表示する。

--platforms

プラットフォームの一覧を表示する。

--classifiers

分類の一覧を表示する。

--keywords

キーワードの一覧を表示する。

--provides

提供されるパッケージ/モジュールの一覧を表示する。

--requires

必要とするパッケージ/モジュールの一覧を表示する。

--obsoletes

廃止されたパッケージ/モジュールの一覧を表示する。

28
22
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
28
22