Specifying optional dependencies in pypi python setup.py

Question

How do I specify optional dependencies in python's setup.py ?

Here's my stab at specifying an optional dependency for an open source library of mine but it doesn't seem to do much.

https://github.com/od-eon/django-cherrypy/blob/master/setup.py

Specifically extra_requires in this snippet:

setup(
    name='django-cherrypy',
    version='0.1',
    packages=packages,
    license='LICENSE',
    description='cherrypy, running under django',
    long_description=open('README.md').read(),
    author='Calvin Cheng',
    author_email='[email protected]',
    install_requires=['cherrypy-wsgiserver'],
    extra_requires=['newrelic'],
    url='https://github.com/od-eon/django-cherrypy',
)

Suggestions?

Any one else find the term "optional dependencies" funny? I do. — Rob Truxal
– Rob Truxal, Commented Sep 7, 2017 at 22:30
Funny it may be, but it sure makes a lot of sense. You may design optional features that will be disabled if the lib is not there (eg., an optimization) without breaking anything in the program. More commonly, it's actually very handy to be able to declare dev dependencies, like npm does. — Arnaud P
– Arnaud P, Commented Sep 20, 2017 at 16:27

scrutari · Accepted Answer · 2018-10-10 05:54:20Z

62

You've got an incorrect keyword. It's extras_require, and it's supposed to be a dict.

setup(
    name="django-cherrypy",
    ...
    extras_require = {
        'mysterious_feature_x':  ["newrelic"]
    }
)

edited Oct 10, 2018 at 5:54

scrutari

1,7082 gold badges23 silver badges38 bronze badges

answered May 13, 2012 at 15:11

voithos

70.9k12 gold badges107 silver badges120 bronze badges

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

2 Comments

Calvin Cheng Over a year ago

Thanks @voithos. I should have rtfm. Your recommended link above (peak.telecommunity.com/DevCenter/…) helps a lot!

braulio Over a year ago

current setup tools docs on optional dependencies: setuptools.pypa.io/en/latest/userguide/…

Collectives™ on Stack Overflow

Specifying optional dependencies in pypi python setup.py

1 Answer 1

2 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related