Развёртывание с помощью Setuptools

Setuptools, это расширяющаяся библиотека, которая обычно используется для распространения библиотек и расширений Python. Она расширяет distutils, базовый модуль системы установки, поставляемый с Python, чтобы также поддерживать различные более сложные конструкции, которые облегчают распространение больших приложений:

• поддержка зависимостей: библиотека или приложение может объявить список других библиотек, от которых она зависит, которые будут установлены автоматически.
• реестр пакетов: setuptools регистрирует ваш пакет в вашей установке Python. Это позволяет запрашивать информацию, предоставляемую одним пакетом, из другого пакета. Наиболее известной функцией этой системы является поддержка точек входа, которая позволяет одному пакету объявлять «точку входа», в которую другой пакет может подключиться, чтобы расширить другой пакет.
• менеджер установки: pip может устанавливать другие библиотеки за вас.

Сам Flask и все библиотеки, которые вы можете найти на PyPI, распространяются с помощью setuptools или distutils.

В этом случае мы предполагаем, что ваше приложение называется yourapplication.py и вы не используете модуль, а пакет. Если вы ещё не преобразовали своё приложение в пакет, перейдите к Большие приложения как пакеты, чтобы узнать, как это сделать.

Рабочее развёртывание с помощью setuptools — это первый шаг к более сложным и автоматизированным сценариям развёртывания. Если вы хотите полностью автоматизировать процесс, также прочтите главу Развёртывание с помощью Fabric.

Базовый скрипт настройки

Поскольку у вас установлен Flask, setuptools доступен в вашей системе. Flask уже зависит от setuptools.

Применимо стандартное замечание: используйте virtualenv.

Ваш код настройки всегда находится в файле с именем setup.py рядом с вашим приложением. Имя файла — только соглашение, но поскольку все будут искать файл с таким именем, лучше его не менять.

Базовый файл setup.py для приложения Flask выглядит так:

from setuptools import setup

setup(
    name='Your Application',
    version='1.0',
    long_description=__doc__,
    packages=['yourapplication'],
    include_package_data=True,
    zip_safe=False,
    install_requires=['Flask']
)

Пожалуйста, имейте в виду, что вам необходимо явно перечислить подпакеты. Если вы хотите, чтобы setuptools автоматически искал пакеты, вы можете использовать функцию find_packages.

from setuptools import setup, find_packages

setup(
    ...
    packages=find_packages()
)

Большинство параметров функции setup должны быть понятны сами по себе, include_package_data и zip_safe могут быть неясны. include_package_data говорит setuptools искать файл MANIFEST.in и установить все совпадающие записи как данные пакета. Мы будем использовать это для распространения статических файлов и шаблонов вместе с модулем Python (см. Распространение ресурсов). Флаг zip_safe может использоваться для принудительного создания или предотвращения создания архива zip. В целом, вы, вероятно, не захотите устанавливать пакеты в виде zip-файлов, потому что некоторые инструменты их не поддерживают, и это затрудняет отладку.

Разметка сборок

Полезно различать релизные и тестовые сборки. Добавьте файл setup.cfg для настройки этих параметров.

[egg_info]
tag_build = .dev
tag_date = 1

[aliases]
release = egg_info -Db ''

Запуск python setup.py sdist создаст пакет разработки с добавленными «.dev» и текущей датой: flaskr-1.0.dev20160314.tar.gz. Запуск python setup.py release sdist создаст релизный пакет только с версией: flaskr-1.0.tar.gz.

Распространение ресурсов

Если вы попытаетесь установить только что созданный пакет, вы заметите, что папки, такие как static или templates, не будут установлены для вас. Причина в том, что setuptools не знает, какие файлы добавлять. Что вам следует сделать, так это создать файл MANIFEST.in рядом с файлом setup.py. Этот файл перечисляет все файлы, которые должны быть добавлены в ваш архив tarball:

recursive-include yourapplication/templates *
recursive-include yourapplication/static *

Не забудьте, что даже если вы внесли их в свой файл MANIFEST.in, они не будут установлены, пока вы не установите параметр include_package_data функции setup в значение True!

Объявление зависимостей

Зависимости объявляются в параметре install_requires в виде списка. Каждый элемент в этом списке — имя пакета, который должен быть загружен с PyPI при установке. По умолчанию всегда используется последняя версия, но вы также можете указать минимальные и максимальные требования к версии. Вот некоторые примеры:

install_requires=[
    'Flask>=0.2',
    'SQLAlchemy>=0.6',
    'BrokenPackage>=0.7,<=1.0'
]

Как упоминалось ранее, зависимости извлекаются из PyPI. А что если вы хотите зависеть от пакета, который невозможно найти на PyPI, и он не будет там, потому что это внутренний пакет, которым вы не хотите делиться с кем-либо? Просто сделайте это так, как если бы существовала запись PyPI, и предоставьте список альтернативных расположений, где setuptools должен искать tarballs:

dependency_links=['http://example.com/yourfiles']

Убедитесь, что на странице есть список каталогов, и ссылки на странице указывают на фактические tarballs с правильными именами файлов, так как именно таким образом setuptools будет находить файлы. Если у вас есть внутренний сервер компании, содержащий пакеты, укажите URL-адрес этого сервера.

Установка/разработка

Чтобы установить ваше приложение (желательно в virtualenv), просто запустите скрипт setup.py с параметром install. Он установит ваше приложение в папку site-packages virtualenv, а также загрузит и установит все зависимости:

$ python setup.py install

Если вы разрабатываете пакет и также хотите установить зависимости, вы можете использовать команду develop вместо этого:

$ python setup.py develop

Это имеет преимущество в том, что устанавливается только ссылка на папку site-packages, а не копируются данные. Вы можете продолжить работу над кодом, не выполняя install снова после каждого изменения.