Когда использовать файл требований к pip вместо install_requires в setup.py?

Моя философия заключается в том, что install_requires должен указывать минимум того, что вам нужно. Он может включать требования к версии, если вы знаете, что некоторые версии не будут работать; но у него не должно быть требований к версии, в которых вы не уверены (например, вы не уверены, сломает ли будущая версия зависимости вашу библиотеку или нет).

С другой стороны, файлы требований должны указывать на то, что, как вы знаете, работает, и могут включать необязательные зависимости, которые вы рекомендуете. Например, вы можете использовать SQLAlchemy, но предложить MySQL, поэтому поместите MySQLdb в файл требований).

Итак, вкратце: install_requires - это удерживать людей от вещей, которые, как вы знаете, не работают, в то время как файлы требований приводят людей к тому, что, как вы знаете, работает. Одна из причин этого заключается в том, что install_requires требования всегда проверяются и не могут быть отключены без фактического изменения метаданных пакета. Таким образом, вам нелегко попробовать новую комбинацию. Файлы требований проверяются только во время установки.

вот что я вложил в свой setup.py:

# this grabs the requirements from requirements.txt
REQUIREMENTS = [i.strip() for i in open("requirements.txt").readlines()]

setup(
    .....
    install_requires=REQUIREMENTS
)

В Руководстве пользователя Python Packaging есть страница по этой теме, я настоятельно рекомендую вам ее прочитать:

• install_requires и файлы требований

Резюме:

install_requires здесь для перечисления зависимостей пакета, которые обязательно должны быть установлены для работы пакета. Он не предназначен для привязки зависимостей к конкретным версиям, но допустимы диапазоны, например install_requires=['django>=1.8']. install_requires наблюдается pip install name-on-pypi и другими инструментами.

requirements.txt - это просто текстовый файл, с которым вы можете запустить pip install -r requirements.txt. Он предназначен для закрепления версий всех зависимостей и подчиненных зависимостей, например: django==1.8.1. Вы можете создать его, используя pip freeze > requirements.txt. (Некоторые службы, такие как Heroku, автоматически запускают pip install -r requirements.txt для вас.) pip install name-on-pypi не смотрит на requirements.txt, только на install_requires.

Я использую только setup.py и install_requires, потому что есть только одно место, куда можно смотреть. Это так же эффективно, как и файл требований, и нет необходимости поддерживать дублирование.