Como personalizar um requirements.txt para vários ambientes?

Tenho duas filiais, Desenvolvimento e Produção. Cada um possui dependências, algumas das quais são diferentes. O desenvolvimento aponta para dependências que estão em desenvolvimento. Da mesma forma para a produção. Eu preciso implantar no Heroku, que espera as dependências de cada branch em um único arquivo chamado 'requirements.txt'.

Qual a melhor forma de se organizar?

O que eu pensei:

• Manter arquivos de requisitos separados, um em cada ramo (deve sobreviver a fusões frequentes!)
• Diga ao Heroku qual arquivo de requisitos eu desejo usar (variável de ambiente?)
• Escrever scripts de implantação (criar ramificação temporária, modificar arquivo de requisitos, confirmar, implementar, excluir ramificação temporária)

Você pode colocar seus arquivos de requisitos em cascata e usar o sinalizador "-r" para dizer ao pip para incluir o conteúdo de um arquivo dentro de outro. Você pode dividir seus requisitos em uma hierarquia de pastas modular como esta:

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

O conteúdo dos arquivos ficaria assim:

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
...

Fora do Heroku, agora você pode configurar ambientes como este:

pip install -r requirements/dev.txt

ou

pip install -r requirements/prod.txt

Como o Heroku procura especificamente por "requirements.txt" na raiz do projeto, ele deve apenas espelhar o produto, assim:

requisitos.txt:

# Mirrors prod
-r requirements/prod.txt

Uma opção viável hoje, que não existia quando a pergunta e resposta original foram postadas, é usar pipenv em vez de pip para gerenciar dependências.

Com o pipenv, o gerenciamento manual de dois arquivos de requisitos separados como com o pip não é mais necessário e, em vez disso, o pipenv gerencia os pacotes de desenvolvimento e produção por meio de interações na linha de comando.

Para instalar um pacote para uso em produção e desenvolvimento:

pipenv install <package>

Para instalar um pacote apenas para o ambiente de desenvolvimento:

pipenv install <package> --dev

Por meio desses comandos, o pipenv armazena e gerencia a configuração do ambiente em dois arquivos (Pipfile e Pipfile.lock). O buildpack atual do Python do Heroku suporta nativamente pipenv e irá se configurar a partir de Pipfile.lock se ele existir em vez de requirements.txt.

Consulte o link pipenv para obter a documentação completa da ferramenta.

Se o seu requisito é ser capaz de alternar entre ambientes na mesma máquina, pode ser necessário criar diferentes pastas virtualenv para cada ambiente para o qual você precisa alternar.

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.