Python setuptoolsを使用したインストール後のスクリプト

ユーザーがコマンドを実行できるように、setuptools setup.pyファイルの一部としてインストール後のPythonスクリプトファイルを指定することは可能ですか？

python setup.py install

ローカルプロジェクトファイルアーカイブ上、または

pip install <name>

PyPIプロジェクトの場合、スクリプトは標準のsetuptoolsインストールの完了時に実行されますか？単一のPythonスクリプトファイルでコーディングできるポストインストールタスクを実行したいと考えています（たとえば、カスタムのポストインストールメッセージをユーザーに配信し、別のリモートソースリポジトリから追加のデータファイルをプルします）。

数年前からこのSOの回答に出くわしましたが、そのトピックに対応しており、その時点での合意は、インストールサブコマンドを作成する必要があるということのようです。それでもそうである場合、ユーザーがスクリプトを実行するために2番目のコマンドを入力する必要がないように、これを行う方法の例を誰かが提供することは可能ですか？

注：以下のソリューションは、ソース配布のzipまたはtarballをインストールする場合、またはソースツリーから編集可能なモードでインストールする場合にのみ機能します。バイナリホイールからインストールする場合は機能しません（.whl）

このソリューションはより透過的です。

にいくつか追加します setup.py行い、追加のファイルは必要ありません。

また、2つの異なるポストインストールを検討する必要があります。1つは開発/編集可能モード用で、もう1つはインストールモード用です。

インストール後のスクリプトを含むこれらの2つのクラスをに追加しますsetup.py。

from setuptools import setup
from setuptools.command.develop import develop
from setuptools.command.install import install


class PostDevelopCommand(develop):
    """Post-installation for development mode."""
    def run(self):
        develop.run(self)
        # PUT YOUR POST-INSTALL SCRIPT HERE or CALL A FUNCTION

class PostInstallCommand(install):
    """Post-installation for installation mode."""
    def run(self):
        install.run(self)
        # PUT YOUR POST-INSTALL SCRIPT HERE or CALL A FUNCTION

関数にcmdclass引数を挿入します：setup()setup.py

setup(
    ...

    cmdclass={
        'develop': PostDevelopCommand,
        'install': PostInstallCommand,
    },

    ...
)

インストール前の準備を行う次の例のように、インストール中にシェルコマンドを呼び出すこともできます。

from setuptools import setup
from setuptools.command.develop import develop
from setuptools.command.install import install
from subprocess import check_call


class PreDevelopCommand(develop):
    """Pre-installation for development mode."""
    def run(self):
        check_call("apt-get install this-package".split())
        develop.run(self)

class PreInstallCommand(install):
    """Pre-installation for installation mode."""
    def run(self):
        check_call("apt-get install this-package".split())
        install.run(self)


setup(
    ...

PS setuptoolsで利用可能なインストール前のエントリポイントはありません。なぜ何もないのか疑問に思っているなら、この議論を読んでください。

注：以下のソリューションは、ソース配布のzipまたはtarballをインストールする場合、またはソースツリーから編集可能なモードでインストールする場合にのみ機能します。バイナリホイールからインストールする場合は機能しません（.whl）

これは、インストール後のスクリプトでパッケージの依存関係が既にインストールされている必要がある場合に機能する唯一の方法です。

import atexit
from setuptools.command.install import install


def _post_install():
    print('POST INSTALL')


class new_install(install):
    def __init__(self, *args, **kwargs):
        super(new_install, self).__init__(*args, **kwargs)
        atexit.register(_post_install)


setuptools.setup(
    cmdclass={'install': new_install},

注：以下のソリューションは、ソース配布のzipまたはtarballをインストールする場合、またはソースツリーから編集可能なモードでインストールする場合にのみ機能します。バイナリホイールからインストールする場合は機能しません（.whl）

解決策は、することができpost_setup.py中setup.pyのディレクトリ。post_setup.pyポストインストールを行う関数を含み、setup.py、適切な時にそれをインポートして起動するだけです。

でsetup.py：

from distutils.core import setup
from distutils.command.install_data import install_data

try:
    from post_setup import main as post_install
except ImportError:
    post_install = lambda: None

class my_install(install_data):
    def run(self):
        install_data.run(self)
        post_install()

if __name__ == '__main__':
    setup(
        ...
        cmdclass={'install_data': my_install},
        ...
    )

でpost_setup.py：

def main():
    """Do here your post-install"""
    pass

if __name__ == '__main__':
    main()

setup.pyそのディレクトリから起動するという一般的な考えでは、インポートすることができますpost_setup.py、空の関数を起動します。

ではpost_setup.py、このif __name__ == '__main__':ステートメントにより、コマンドラインからポストインストールを手動で起動できます。

@ Apalala、@ Zulu、@ mertyildiranの回答を組み合わせる。これはPython 3.5環境で私のために働きました：

import atexit
import os
import sys
from setuptools import setup
from setuptools.command.install import install

class CustomInstall(install):
    def run(self):
        def _post_install():
            def find_module_path():
                for p in sys.path:
                    if os.path.isdir(p) and my_name in os.listdir(p):
                        return os.path.join(p, my_name)
            install_path = find_module_path()

            # Add your post install code here

        atexit.register(_post_install)
        install.run(self)

setup(
    cmdclass={'install': CustomInstall},
...

これにより、でパッケージのインストールパスにアクセスして、install_pathシェル作業を行うこともできます。

ポストインストールを実行し、要件を維持する最も簡単な方法は、次の呼び出しを装飾することだと思いますsetup(...)。

from setup tools import setup


def _post_install(setup):
    def _post_actions():
        do_things()
    _post_actions()
    return setup

setup = _post_install(
    setup(
        name='NAME',
        install_requires=['...
    )
)

これはsetup()宣言時に実行されsetupます。要件のインストールが完了すると、_post_install()関数が実行され、内部関数が実行されます_post_actions()。

atexitを使用する場合、新しいcmdclassを作成する必要はありません。setup（）呼び出しの直前にatexitレジスタを作成するだけです。同じことをします。

また、最初に依存関係をインストールする必要がある場合、pipがパッケージを移動する前にatexitハンドラーが呼び出されるため、これはpip install では機能しません。

提示された推奨事項で問題を解決できなかったので、ここで私を助けました。

次のようsetup()にsetup.py、インストール直後に実行したい関数を呼び出すことができます：

from setuptools import setup

def _post_install():
    <your code>

setup(...)

_post_install()