如何为多个环境自定义requirements.txt？

Question

我有两个分支,开发和生产.每个都有依赖关系,其中一些是不同的.开发指向本身正在开发的依赖项.同样适用于生产.我需要部署到Heroku,它希望每个分支的依赖关系都在一个名为'requirements.txt'的文件中.

组织的最佳方式是什么？

我想到的是:

• 维护单独的需求文件,每个分支一个(必须经常合并!)
• 告诉Heroku我想要使用哪个需求文件(环境变量？)
• 编写部署脚本(创建临时分支,修改需求文件,提交,部署,删除临时分支)

Answer 1

您可以级联您的需求文件并使用"-r"标志告诉pip将一个文件的内容包含在另一个文件中.您可以将需求分解为模块化文件夹层次结构,如下所示:

`-- django_project_root
|-- requirements
|   |-- common.txt
|   |-- dev.txt
|   `-- prod.txt
`-- requirements.txt

文件的内容如下所示:

common.txt:

# Contains requirements common to all environments
req1==1.0
req2==1.0
req3==1.0
...

dev.txt:

# Specifies only dev-specific requirements
# But imports the common ones too
-r common.txt
dev_req==1.0
...

prod.txt:

# Same for prod...
-r common.txt
prod_req==1.0
...

在Heroku之外,您现在可以设置如下环境:

pip install -r requirements/dev.txt

要么

pip install -r requirements/prod.txt

由于Heroku专门针对项目根目录中的"requirements.txt",它应该只是镜像prod,如下所示:

requirements.txt:

# Mirrors prod
-r requirements/prod.txt

Answer 2

如果您的要求是能够在同一台计算机上的环境之间切换，则可能需要为需要切换到的每个环境创建不同的 virtualenv 文件夹。

python3 -m venv venv_dev
source venv_dev/bin/activate
pip install -r pip/common.txt
pip install -r pip/dev.txt
exit
python3 -m venv venv_prod
source venv_prod/bin/activate
pip install -r pip/common.txt
exit
source venv_dev/bin/activate
# now we are in dev environment so your code editor and build systems will work.

# let's install a new dev package:
# pip install awesome
# pip freeze -r pip/temp.txt
# find that package, put it into pip/dev.txt
# rm pip/temp.txt

# pretty cumbersome, but it works. 

Answer 3

今天发布原始问题和答案时不存在的可行选择是使用pipenv而不是pip管理依赖项。

使用pipenv，不再需要像pip一样手动管理两个单独的需求文件，而是通过命令行上的交互来管理开发和生产包本身。

要安装用于生产和开发的软件包：

pipenv install <package>

要仅为开发环境安装软件包：

pipenv install <package> --dev

通过这些命令，pipenv在两个文件（Pipfile和Pipfile.lock）中存储和管理环境配置。Heroku当前的Python buildpack本机支持pipenv，如果存在Pipfile.lock而不是requirements.txt，它将从Pipfile.lock进行配置。

请参阅pipenv链接以获取该工具的完整文档。