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



我有两个分支,开发和生产。每个都有依赖关系,其中有些是不同的。开发指向的是开发中的依赖关系。生产也是如此。我需要部署到Heroku,它希望每个分支的依赖项都在一个名为"requirements.txt"的文件中

最好的组织方式是什么?

我的想法:

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

您可以级联您的需求文件,并使用"-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

今天一个可行的选项是使用pipenv而不是pip来管理依赖关系,这在发布原始问答时并不存在。

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

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

pipenv install <package>

仅为开发环境安装软件包:

pipenv install <package> --dev

通过这些命令,pipenv将环境配置存储和管理在两个文件中(Pipfile和Pipfile.lock)。Heroku当前的Python构建包本机支持pipenv,如果它存在,将从Pipfile.lok而不是requirements.txt中配置自己。

有关该工具的完整文档,请参阅pipenv链接。

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

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. 

最新更新