Skip to content

Commit f217cfc

Browse files
Punctuation and minor style corrections
1 parent ded8541 commit f217cfc

1 file changed

Lines changed: 29 additions & 28 deletions

File tree

‎source/tutorials/installing-packages.rst‎

Lines changed: 29 additions & 28 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:
@@ -284,7 +284,7 @@ script directly from the command shell like so:
284284
285285
Managing multiple virtual environments directly can become tedious, so the
286286
:ref:`dependency management tutorial <managing-dependencies>` introduces a
287-
higher level tool, :ref:`Pipenv`, that automatically manages a separate
287+
higher-level tool :ref:`Pipenv` that automatically manages a separate
288288
virtual environment for each project and application that you work on.
289289

290290

@@ -375,7 +375,7 @@ Source Distributions vs Wheels
375375
:ref:`pip` can install from either :term:`Source Distributions (sdist) <Source
376376
Distribution (or "sdist")>` or :term:`Wheels <Wheel>`, but if both are present
377377
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
378+
pip's default behavior by e.g. using its :ref:`--no-binary
379379
<pip:install_--no-binary>` option.
380380

381381
:term:`Wheels <Wheel>` are a pre-built :term:`distribution <Distribution
@@ -391,7 +391,7 @@ in the future.
391391
Upgrading packages
392392
==================
393393

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

396396
.. tab:: Unix/macOS
397397

@@ -425,12 +425,12 @@ current user, use the ``--user`` flag:
425425
426426
py -m pip install --user SomeProject
427427
428-
For more information see the `User Installs
428+
For more information, see the `User Installs
429429
<https://pip.pypa.io/en/latest/user_guide/#user-installs>`_ section
430430
from the pip docs.
431431

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

435435
If ``SomeProject`` defines any command-line scripts or console entry points,
436436
``--user`` will cause them to be installed inside the `user base`_'s binary
@@ -443,13 +443,13 @@ directory to your :envvar:`PATH`:
443443
- On Linux and macOS you can find the user base binary directory by running
444444
``python -m site --user-base`` and adding ``bin`` to the end. For example,
445445
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
446+
path to your home directory), so you'll need to add ``~/.local/bin`` to your
447447
``PATH``. You can set your ``PATH`` permanently by `modifying ~/.profile`_.
448448

449449
- On Windows you can find the user base binary directory by running ``py -m
450450
site --user-site`` and replacing ``site-packages`` with ``Scripts``. For
451451
example, this could return
452-
``C:\Users\Username\AppData\Roaming\Python36\site-packages`` so you would
452+
``C:\Users\Username\AppData\Roaming\Python36\site-packages``, so you would
453453
need to set your ``PATH`` to include
454454
``C:\Users\Username\AppData\Roaming\Python36\Scripts``. You can set your user
455455
``PATH`` permanently in the `Control Panel`_. You may need to log out for the
@@ -463,7 +463,7 @@ Requirements files
463463
==================
464464

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

468468
.. tab:: Unix/macOS
469469

@@ -480,8 +480,7 @@ Install a list of requirements specified in a :ref:`Requirements File
480480
Installing from VCS
481481
===================
482482

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>`.
483+
Install a project from VCS in "editable" mode:
485484

486485
.. tab:: Unix/macOS
487486

@@ -501,10 +500,12 @@ syntax, see pip's section on :ref:`VCS Support <pip:VCS Support>`.
501500
py -m pip install -e SomeProject @ svn+svn://svn.repo/some_pkg/trunk/ # from svn
502501
py -m pip install -e SomeProject @ git+https://git.repo/some_pkg.git@feature # from a branch
503502
503+
For a full breakdown of the syntax, see pip's section on :ref:`VCS Support <pip:VCS Support>`.
504+
504505
Installing from other Indexes
505506
=============================
506507

507-
Install from an alternate index
508+
Install from an alternate index:
508509

509510
.. tab:: Unix/macOS
510511

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

524525
.. tab:: Unix/macOS
525526

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

545546
.. tab:: Unix/macOS
546547

@@ -554,7 +555,7 @@ still editable from the src tree.
554555
555556
py -m pip install -e <path>
556557
557-
You can also install normally from src
558+
You can also install normally from src:
558559

559560
.. tab:: Unix/macOS
560561

@@ -571,7 +572,7 @@ You can also install normally from src
571572
Installing from local archives
572573
==============================
573574

574-
Install a particular source archive file.
575+
Install a particular source archive file:
575576

576577
.. tab:: Unix/macOS
577578

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

591592
.. tab:: Unix/macOS
592593

@@ -607,10 +608,10 @@ Install from a local directory containing archives (and don't check :term:`PyPI
607608
Installing from other sources
608609
=============================
609610

610-
To install from other data sources (for example Amazon S3 storage)
611+
To install from other data sources (for example, Amazon S3 storage),
611612
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.
613+
in a format compliant with the :ref:`simple repository API <simple-repository-api>`
614+
and use the ``--extra-index-url`` flag to direct pip to use that index:
614615

615616
.. code-block:: bash
616617
@@ -621,8 +622,8 @@ and use the ``--extra-index-url`` flag to direct pip to use that index.
621622
Installing Prereleases
622623
======================
623624

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

627628
.. tab:: Unix/macOS
628629

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

0 commit comments

Comments
 (0)