Operating-system specific requirements with pip

Question

Is it possible to have OS specific requirements in pip's requirements.txt file?

For example: I have a dependency on readline, therefore, if installing on windows (or OSX), then pyreadline is a requirement. If it's linux, then I don't want to force an install.

Nope. I don't think so. This should be dealt with some deployment. Also, if this were a project you want to distribute to people to use, never distribute requiremnts.txt. — CppLearner
– CppLearner, Commented Apr 15, 2013 at 9:07
@CppLearner never distribute requirements.txt ? isn't it its purpose ? — 0x90
– 0x90, Commented Apr 15, 2013 at 9:32
Well that's what I said "if this were a project". If you are writing a project, use setup.py. — CppLearner
– CppLearner, Commented Apr 15, 2013 at 16:53

John Carter · Accepted Answer · 2019-04-11 07:07:08Z

35

You can do this with "Environment Markers" as specified in PEP-508:

Here's an example of using such a marker inside a requirements.txt:

pyreadline==2.1; platform_system == "Windows"

Similarly, in a setup.py:

setup(
    ...
    install_requires=['pyreadline; platform_system == "Windows"'],
)

edited Apr 11, 2019 at 7:07

answered Jan 20, 2019 at 21:52

John Carter

55.7k28 gold badges116 silver badges144 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

electromechanick Over a year ago

With Python 3.7, I had to use a semi-colon in the setup.py file install_requires, like this: install_requires=["pywin32 > 1.0 ; sys.platform == 'win32'"],

wim Over a year ago

PEP 496 is Status: Rejected. I have updated your post with the appropriate replacement, which is PEP 508. This also accounts for the confusion @electromechanick mentioned.

s2t2 Over a year ago

FYI Mac system_platform is "Darwin"

Alex · Accepted Answer · 2013-04-17 09:59:16Z

3

In the end, adding the OS check in the setup.py is what I've found other people using. Ex:

install_requires = [
        "parsedatetime >= 1.1.2",
        "colorama >= 0.2.5",
        "pycrypto >= 2.6"
        ] + ["pyreadline >= 2.0"] if "win" in sys.platform else [],

link to full setup.py with example code

answered Apr 17, 2013 at 9:59

Alex

9682 gold badges12 silver badges26 bronze badges

2 Comments

Almar Over a year ago

Don't use this. This used to be fine when posted (back in the days when the setup.py was executed during installation), but the modern way this works is that a wheel is build that contains everything to install the package.

Alex Over a year ago

wow, this is old....I'll just go ahead and make the other answer the accepted one......

Collectives™ on Stack Overflow

Operating-system specific requirements with pip

2 Answers 2

3 Comments

2 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

3 Comments

2 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related