จะปรับแต่ง 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 ดังนี้:

Requirement.txt:

# Mirrors prod
-r requirements/prod.txt

ตัวเลือกที่ทำงานได้ในวันนี้ซึ่งไม่มีอยู่เมื่อมีการโพสต์คำถามและคำตอบเดิมคือการใช้pipenvแทน pip เพื่อจัดการการอ้างอิง

ด้วย pipenv การจัดการไฟล์ข้อกำหนดสองไฟล์ที่แยกกันด้วยตนเองเช่นกับ pip ไม่จำเป็นอีกต่อไปและ pipenv จะจัดการแพ็กเกจการพัฒนาและการผลิตด้วยตัวเองผ่านการโต้ตอบบนบรรทัดคำสั่งแทน

ในการติดตั้งแพ็คเกจสำหรับใช้ทั้งในการผลิตและการพัฒนา:

pipenv install <package>

ในการติดตั้งแพ็คเกจสำหรับสภาพแวดล้อมการพัฒนาเท่านั้น:

pipenv install <package> --dev

ผ่านคำสั่งเหล่านั้น pipenv จะจัดเก็บและจัดการการกำหนดค่าสภาพแวดล้อมในสองไฟล์ (Pipfile และ Pipfile.lock) Python buildpack ปัจจุบันของ Heroku รองรับ pipenv โดยกำเนิดและจะกำหนดค่าเองจาก Pipfile.lock หากมีอยู่แทนที่จะเป็น requirements.txt

ดูลิงค์ pipenv สำหรับเอกสารประกอบเครื่องมือฉบับเต็ม

หากความต้องการของคุณคือสามารถสลับไปมาระหว่างสภาพแวดล้อมในเครื่องเดียวกันได้อาจจำเป็นต้องสร้างโฟลเดอร์ 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.