Сценарій після інсталяції з Python setuptools

Чи можна вказати файл сценарію Python після інсталяції як частину файлу setup.py setuptools, щоб користувач міг запустити команду:

python setup.py install

у локальному архіві файлів проекту, або

pip install <name>

для проекту PyPI і сценарій буде запущений після завершення встановлення стандартної програми Я прагну виконати завдання після встановлення, які можна закодувати в одному файлі сценарію Python (наприклад, доставити користувачеві повідомлення після встановлення користувачеві, витягнути додаткові файли даних з іншого віддаленого сховища джерел).

Я натрапив на цю SO-відповідь декількох років тому, що стосується теми, і звучить так, ніби консенсус тоді був таким, що вам потрібно створити підкоманду встановлення. Якщо це все ще так, чи можна було б, щоб хтось навів приклад, як це зробити, щоб користувачеві не потрібно було вводити другу команду для запуску сценарію?

Примітка: Наведене нижче рішення працює лише під час встановлення ZIP-коду розповсюдження або tarball або встановлення в редагованому режимі з дерева джерел. Це не буде працювати під час встановлення з двійкового колеса ( .whl)

Це рішення є більш прозорим:

Ви внесете кілька доповнень, setup.pyі зайвий файл не потрібен.

Також вам потрібно розглянути дві різні інсталяції; один для режиму розробки / редагування, а інший - для режиму встановлення.

Додайте ці два класи, які включають ваш сценарій після встановлення, до 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директорії «S. 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. Ви можете просто створити свій atexit реєстр безпосередньо перед викликом setup (). Це робить те саме.

Крім того, якщо вам потрібно спочатку встановити залежності, це не працює з установкою pip, оскільки ваш обробник atexit буде викликаний до того, як pip перемістить пакети на місце.

Я не зміг вирішити проблему за допомогою будь-яких представлених рекомендацій, тому ось що мені допомогло.

Ви можете викликати функцію, що ви хочете запустити після установки відразу після setup()в setup.py, як це:

from setuptools import setup

def _post_install():
    <your code>

setup(...)

_post_install()