Skip to content
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.

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

Update dependencies.rst #46

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
11 changes: 10 additions & 1 deletion dependencies.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,17 @@ When we publish this to PyPI, calling ``pip install funniest`` or similar will a

Packages Not On PyPI
~~~~~~~~~~~~~~~~~~~~
Sometimes you'll want to use packages that are properly arranged with setuptools, but aren't published to PyPI. In those cases, if you have pip version>=18.1, you can specify url of package in install_requires in PEP 508 format.

Sometimes you'll want to use packages that are properly arranged with setuptools, but aren't published to PyPI. In those cases, you can specify a list of one or more ``dependency_links`` URLs where the package can be downloaded, along with some additional hints, and setuptools will find and install the package correctly.
For example, if a library is published on GitHub, you can specify it like::

setup(
...
install_requires=['package @ git+https://github.com/user/repo.git@branch']
...
)

For older pip versions, which doesnot support PEP 508 format, you can specify a list of one or more ``dependency_links`` URLs where the package can be downloaded, along with some additional hints, and setuptools will find and install the package correctly. This method is deprecated in newer pip versions.

For example, if a library is published on GitHub, you can specify it like::

Expand Down