Skip to content

Adding documentation about the extras_require option #424

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 4, 2012
Merged

Adding documentation about the extras_require option #424

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions docs/requirements.txt
View file
Open in desktop
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