Skip to content

Commit

Permalink
Adding documentation about the extras_require option for selecting …
Browse files Browse the repository at this point in the history
…additional dependencies. See: Issue pypa#7
  • Loading branch information
poswald committed Jan 4, 2012
1 parent 8c34efc commit 22fd67e
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -98,9 +98,20 @@ installed. For example::
MyPackage==3.0
tells pip to install the 3.0 version of MyPackage.
tells pip to install the 3.0 version of MyPackage.
You can also install a package in an "editable" form. This puts the
Some packages my specify optionally installable components. For example,
a python library may provide additional functionality that requires you
to you have Reportlab installed but may not want to have it installed by
default for everyone. These options are specifed by a ``extras_require`` setting
in the project's ``setup.py`` file. You may select for it by specifying::

MyPackage==3.0 [PDF]

This will install any additional requirements specified by the package as
needed to support PDF generation.

Packages may also be installed in an "editable" form. This puts the
source code into ``src/distname`` (making the name lower case) and
runs ``python setup.py develop`` on the package. To indicate
editable, use ``-e``, like::
Expand Down

0 comments on commit 22fd67e

Please sign in to comment.