How to specify dependencies in Python

Question

I came across a python library which has docs, which start like this:

Quickstart

Include foolib in your requirements.txt file.

AFAIK dependencies should be specified via install_requires in setup.py.

Should I talk the maintainer of the library and create a pull-request for the docs?

score 1 · Answer 1 · answered Dec 22 '16 at 14:52

1

Both are acceptable. The difference is that specifying something in your install_requires will auto-download / install that package when you install the package using setup.py. Having a requirements.txt makes it easier to see at a glance what the requirements are. I personally prefer seeing libraries with a requirements.txt, since I can install all those requirements with pip into my virtualenv and be able to update them quickly if needed.

answered Dec 22 '16 at 14:52

mprat

2,451
15
33

setup.py is more flexible, requirements.tx is easier to read and maintain. – Chikiro Dec 22 '16 at 14:55
Thank you for your answer. Somehow I hate docs containing "OR". – guettli Dec 23 '16 at 08:01

score 0 · Answer 2 · answered Jan 09 '17 at 12:48

Add your dependencies in a requirements file and then parse this file in the setup.py. This will help you to:

Easily install dependencies without installing the entire package through pip
Get only one source for your dependencies
Get all way to install your package available (pip, easy_install, command line, etc...)

How to specify dependencies in Python

2 Answers2