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

voithos voithos · Accepted Answer · 2012-05-13T15:11:27

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"]
    }
)

Specifying optional dependencies in pypi python setup.py

1 Answers