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.

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

Jump to bottom

Add examples on how to install package extras and sdists to docs #8592

Merged
merged 4 commits into from
Jul 19, 2020
Merged

Add examples on how to install package extras and sdists to docs #8592

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
eb6cc7f
Add examples on how to install package extras and sdists to docs
shireenrao Jul 16, 2020
6ea1575
update based on review
shireenrao Jul 17, 2020
319e69f
update news fragment
shireenrao Jul 18, 2020
168460a
fix url example
shireenrao Jul 18, 2020
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
14 changes: 11 additions & 3 deletions docs/html/reference/pip_install.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -880,6 +880,13 @@ Examples
$ pip install -e path/to/project # project in another directory


#. Install a project from VCS

::

$ pip install SomeProject@git+https://git.repo/some_pkg.git@1.3.1


#. Install a project from VCS in "editable" mode. See the sections on :ref:`VCS Support <VCS Support>` and :ref:`Editable Installs <editable-installs>`.

::
Expand All @@ -895,7 +902,7 @@ Examples
::

$ pip install SomePackage[PDF]
$ pip install git+https://git.repo/some_pkg.git#egg=SomePackage[PDF]
$ pip install "SomePackage[PDF] @ git+https://git.repo/SomePackage@master#subdirectory=subdir_path"
$ pip install .[PDF] # project in current directory
$ pip install SomePackage[PDF]==3.0
$ pip install SomePackage[PDF,EPUB] # multiple extras
Expand All @@ -913,8 +920,9 @@ Examples

::

$ pip install SomeProject==1.0.4@http://my.package.repo//SomeProject-1.2.3-py33-none-any.whl
$ pip install "SomeProject==1.0.4 @ http://my.package.repo//SomeProject-1.2.3-py33-none-any.whl"
$ pip install SomeProject@http://my.package.repo/SomeProject-1.2.3-py33-none-any.whl
$ pip install "SomeProject @ http://my.package.repo/SomeProject-1.2.3-py33-none-any.whl"
$ pip install SomeProject@http://my.package.repo/1.2.3.tar.gz


#. Install from alternative package repositories.
Expand Down
1 change: 1 addition & 0 deletions news/8576.doc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Document how to install package extras from git branch and source distributions.