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

Основной скрипт настройки

Поскольку у вас установлен 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 должен искать tarball:

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

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

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

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

$ python setup.py install

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

$ python setup.py develop

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