Skip to content

Commit 7c738e1

Browse files
authored
Merge pull request #2137 from MikhailRyazanov/patch-1
Punctuation and minor style corrections in “Installing Packages”
2 parents bfb91a2 + 143b326 commit 7c738e1

1 file changed

Lines changed: 30 additions & 30 deletions

File tree

‎source/tutorials/installing-packages.rst‎

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ check this by running:
110110
py -m pip --version
111111
112112
If you installed Python from source, with an installer from `python.org`_, or
113-
via `Homebrew`_ you should already have pip. If you're on Linux and installed
113+
via `Homebrew`_, you should already have pip. If you're on Linux and installed
114114
using your OS package manager, you may have to install pip separately, see
115115
:doc:`/guides/installing-using-linux-tools`.
116116

@@ -144,9 +144,9 @@ If that still doesn't allow you to run ``python -m pip``:
144144

145145
Be cautious if you're using a Python install that's managed by your
146146
operating system or another package manager. get-pip.py does not
147-
coordinate with those tools, and may leave your system in an
147+
coordinate with those tools and may leave your system in an
148148
inconsistent state. You can use ``python get-pip.py --prefix=/usr/local/``
149-
to install in ``/usr/local`` which is designed for locally-installed
149+
to install in ``/usr/local`` which is designed for locally installed
150150
software.
151151

152152

@@ -188,7 +188,7 @@ but here's the basic :doc:`venv <python:library/venv>` [3]_ command to use on a
188188
py -m venv tutorial_env
189189
tutorial_env\Scripts\activate
190190
191-
This will create a new virtual environment in the ``tutorial_env`` subdirectory,
191+
This will create a new virtual environment in the ``tutorial_env`` subdirectory
192192
and configure the current shell to use it as the default ``python`` environment.
193193

194194

@@ -200,7 +200,7 @@ Creating Virtual Environments
200200
Python "Virtual Environments" allow Python :term:`packages <Distribution
201201
Package>` to be installed in an isolated location for a particular application,
202202
rather than being installed globally. If you are looking to safely install
203-
global command line tools,
203+
global command-line tools,
204204
see :doc:`/guides/installing-stand-alone-command-line-tools`.
205205

206206
Imagine you have an application that needs version 1 of LibFoo, but another
@@ -217,7 +217,7 @@ Also, what if you can’t install :term:`packages <Distribution Package>` into t
217217
global site-packages directory? For instance, on a shared host.
218218

219219
In all these cases, virtual environments can help you. They have their own
220-
installation directories and they don’t share libraries with other virtual
220+
installation directories and don’t share libraries with other virtual
221221
environments.
222222

223223
Currently, there are two common tools for creating Python virtual environments:
@@ -281,10 +281,9 @@ script directly from the command shell like so:
281281
<DIR>\Scripts\activate
282282
283283
284-
285284
Managing multiple virtual environments directly can become tedious, so the
286-
:ref:`dependency management tutorial <managing-dependencies>` introduces a
287-
higher level tool, :ref:`Pipenv`, that automatically manages a separate
285+
:ref:`dependency management tutorial <managing-dependencies>` introduces
286+
:ref:`Pipenv`, a higher-level tool that automatically manages a separate
288287
virtual environment for each project and application that you work on.
289288

290289

@@ -375,7 +374,7 @@ Source Distributions vs Wheels
375374
:ref:`pip` can install from either :term:`Source Distributions (sdist) <Source
376375
Distribution (or "sdist")>` or :term:`Wheels <Wheel>`, but if both are present
377376
on PyPI, pip will prefer a compatible :term:`wheel <Wheel>`. You can override
378-
pip`s default behavior by e.g. using its :ref:`--no-binary
377+
pip's default behavior by e.g. using its :ref:`--no-binary
379378
<pip:install_--no-binary>` option.
380379

381380
:term:`Wheels <Wheel>` are a pre-built :term:`distribution <Distribution
@@ -391,7 +390,7 @@ in the future.
391390
Upgrading packages
392391
==================
393392

394-
Upgrade an already installed ``SomeProject`` to the latest from PyPI.
393+
Upgrade an already installed ``SomeProject`` to the latest from PyPI:
395394

396395
.. tab:: Unix/macOS
397396

@@ -425,12 +424,12 @@ current user, use the ``--user`` flag:
425424
426425
py -m pip install --user SomeProject
427426
428-
For more information see the `User Installs
427+
For more information, see the `User Installs
429428
<https://pip.pypa.io/en/latest/user_guide/#user-installs>`_ section
430429
from the pip docs.
431430

432431
Note that the ``--user`` flag has no effect when inside a virtual environment
433-
- all installation commands will affect the virtual environment.
432+
– all installation commands will affect the virtual environment.
434433

435434
If ``SomeProject`` defines any command-line scripts or console entry points,
436435
``--user`` will cause them to be installed inside the `user base`_'s binary
@@ -443,13 +442,13 @@ directory to your :envvar:`PATH`:
443442
- On Linux and macOS you can find the user base binary directory by running
444443
``python -m site --user-base`` and adding ``bin`` to the end. For example,
445444
this will typically print ``~/.local`` (with ``~`` expanded to the absolute
446-
path to your home directory) so you'll need to add ``~/.local/bin`` to your
445+
path to your home directory), so you'll need to add ``~/.local/bin`` to your
447446
``PATH``. You can set your ``PATH`` permanently by `modifying ~/.profile`_.
448447

449448
- On Windows you can find the user base binary directory by running ``py -m
450449
site --user-site`` and replacing ``site-packages`` with ``Scripts``. For
451450
example, this could return
452-
``C:\Users\Username\AppData\Roaming\Python36\site-packages`` so you would
451+
``C:\Users\Username\AppData\Roaming\Python36\site-packages``, so you would
453452
need to set your ``PATH`` to include
454453
``C:\Users\Username\AppData\Roaming\Python36\Scripts``. You can set your user
455454
``PATH`` permanently in the `Control Panel`_. You may need to log out for the
@@ -463,7 +462,7 @@ Requirements files
463462
==================
464463

465464
Install a list of requirements specified in a :ref:`Requirements File
466-
<pip:Requirements Files>`.
465+
<pip:Requirements Files>`:
467466

468467
.. tab:: Unix/macOS
469468

@@ -480,8 +479,7 @@ Install a list of requirements specified in a :ref:`Requirements File
480479
Installing from VCS
481480
===================
482481

483-
Install a project from VCS in "editable" mode. For a full breakdown of the
484-
syntax, see pip's section on :ref:`VCS Support <pip:VCS Support>`.
482+
Install a project from VCS in "editable" mode:
485483

486484
.. tab:: Unix/macOS
487485

@@ -501,10 +499,12 @@ syntax, see pip's section on :ref:`VCS Support <pip:VCS Support>`.
501499
py -m pip install -e "SomeProject @ svn+svn://svn.repo/some_pkg/trunk/" # from svn
502500
py -m pip install -e "SomeProject @ git+https://git.repo/some_pkg.git@feature" # from a branch
503501
502+
For a full breakdown of the syntax, see pip's section on :ref:`VCS Support <pip:VCS Support>`.
503+
504504
Installing from other Indexes
505505
=============================
506506

507-
Install from an alternate index
507+
Install from an alternate index:
508508

509509
.. tab:: Unix/macOS
510510

@@ -519,7 +519,7 @@ Install from an alternate index
519519
py -m pip install --index-url http://my.package.repo/simple/ SomeProject
520520
521521
Search an additional index during install, in addition to :term:`PyPI <Python
522-
Package Index (PyPI)>`
522+
Package Index (PyPI)>`:
523523

524524
.. tab:: Unix/macOS
525525

@@ -540,7 +540,7 @@ Installing from a local src tree
540540
Installing from local src in
541541
:doc:`Development Mode <setuptools:userguide/development_mode>`,
542542
i.e. in such a way that the project appears to be installed, but yet is
543-
still editable from the src tree.
543+
still editable from the src tree:
544544

545545
.. tab:: Unix/macOS
546546

@@ -554,7 +554,7 @@ still editable from the src tree.
554554
555555
py -m pip install -e <path>
556556
557-
You can also install normally from src
557+
You can also install normally from src:
558558

559559
.. tab:: Unix/macOS
560560

@@ -571,7 +571,7 @@ You can also install normally from src
571571
Installing from local archives
572572
==============================
573573

574-
Install a particular source archive file.
574+
Install a particular source archive file:
575575

576576
.. tab:: Unix/macOS
577577

@@ -586,7 +586,7 @@ Install a particular source archive file.
586586
py -m pip install ./downloads/SomeProject-1.0.4.tar.gz
587587
588588
Install from a local directory containing archives (and don't check :term:`PyPI
589-
<Python Package Index (PyPI)>`)
589+
<Python Package Index (PyPI)>`):
590590

591591
.. tab:: Unix/macOS
592592

@@ -607,10 +607,10 @@ Install from a local directory containing archives (and don't check :term:`PyPI
607607
Installing from other sources
608608
=============================
609609

610-
To install from other data sources (for example Amazon S3 storage)
610+
To install from other data sources (for example, Amazon S3 storage),
611611
you can create a helper application that presents the data
612-
in a format compliant with the :ref:`simple repository API <simple-repository-api>`:,
613-
and use the ``--extra-index-url`` flag to direct pip to use that index.
612+
in a format compliant with the :ref:`simple repository API <simple-repository-api>`
613+
and use the ``--extra-index-url`` flag to direct pip to use that index:
614614

615615
.. code-block:: bash
616616
@@ -621,8 +621,8 @@ and use the ``--extra-index-url`` flag to direct pip to use that index.
621621
Installing Prereleases
622622
======================
623623

624-
Find pre-release and development versions, in addition to stable versions. By
625-
default, pip only finds stable versions.
624+
Find pre-release and development versions, in addition to stable versions (by
625+
default, pip only finds stable versions):
626626

627627
.. tab:: Unix/macOS
628628

@@ -678,4 +678,4 @@ you know publishes one, you can include it in the pip installation command:
678678
679679
.. [4] The compatible release specifier was accepted in :pep:`440`
680680
and support was released in :ref:`setuptools` v8.0 and
681-
:ref:`pip` v6.0
681+
:ref:`pip` v6.0.

0 commit comments

Comments
 (0)