Optional dependencies in distutils / pip

python distutils pip
Mike Cooper picture Mike Cooper · Jun 4, 2011 · Viewed 13.5k times · Source

When installing my python package, I want to be able to tell the user about various optional dependencies. Ideally I would also like to print out a message about these optional requirements and what each of them do.

I haven't seen anything yet in the docs of either pip or docutils. Do tools these support optional dependencies?

Answer

Tobu picture Tobu · Dec 3, 2012

These are called extras, here is how to use them in your setup.py.

The base support is in pkg_resources. You need to enable distribute in your setup.py. pip will also understand them:

pip install 'package[extras]'

Related questions

pip cannot uninstall <package>: "It is a distutils installed project"

I tried to install the Twilio module: sudo -H pip install twilio And I got this error: Installing collected packages: pyOpenSSL Found existing installation: pyOpenSSL 0.13.1 Cannot uninstall 'pyOpenSSL'. It is a distutils installed project and thus we cannot accurately determine …

Read More
How to use MinGW's gcc compiler when installing Python package using Pip?

I configured MinGW and distutils so now I can compile extensions using this command: setup.py install MinGW's gcc compiler will be used and package will be installed. For that I installed MinGW and created distutils.cfg file with following …

Read More
pip 10 and apt: how to avoid "Cannot uninstall X" errors for distutils packages

I am dealing with a legacy Dockerfile. Here is a very simplified version of what I am dealing with: FROM ubuntu:14.04 RUN apt-get -y update && apt-get -y install \ python-pip \ python-numpy # ...and many other packages RUN pip install -U …

Read More