summaryrefslogtreecommitdiff
path: root/docs/quick_tutorial/requirements.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/quick_tutorial/requirements.rst')
-rw-r--r--docs/quick_tutorial/requirements.rst44
1 files changed, 22 insertions, 22 deletions
diff --git a/docs/quick_tutorial/requirements.rst b/docs/quick_tutorial/requirements.rst
index 29f263176..08ea93cb2 100644
--- a/docs/quick_tutorial/requirements.rst
+++ b/docs/quick_tutorial/requirements.rst
@@ -33,7 +33,7 @@ This *Quick Tutorial* is based on:
projects* (a directory with packaging information and *Python packages* of
working code.)
-* **Unix commands**. Commands in this tutorial use UNIX syntax and paths.
+* **Unix commands**. Commands in this tutorial use Unix syntax and paths.
Windows users should adjust commands accordingly.
.. note::
@@ -62,7 +62,7 @@ Install Python 3
See the detailed recommendation for your operating system described under
:ref:`installing_chapter`.
-- :ref:`for-mac-os-x-users`
+- :ref:`for-macos-users`
- :ref:`if-you-don-t-yet-have-a-python-interpreter-unix`
- :ref:`if-you-don-t-yet-have-a-python-interpreter-windows`
@@ -89,23 +89,23 @@ will reside as we proceed through the tutorial:
│ └── app.py
└── setup.py
-For Linux, the commands to do so are as follows:
+For macOS and Linux, the commands to do so are as follows:
.. code-block:: bash
- # Mac and Linux
- $ cd ~
- $ mkdir -p projects/quick_tutorial
- $ cd projects/quick_tutorial
+ # macOS and Linux
+ cd ~
+ mkdir -p projects/quick_tutorial
+ cd projects/quick_tutorial
For Windows:
.. code-block:: doscon
# Windows
- c:\> cd \
- c:\> mkdir projects\quick_tutorial
- c:\> cd projects\quick_tutorial
+ cd \
+ mkdir projects\quick_tutorial
+ cd projects\quick_tutorial
In the above figure, your user home directory is represented by ``~``. In your
home directory, all of your projects are in the ``projects`` directory. This is
@@ -129,13 +129,13 @@ environment`. We set an environment variable to save typing later.
.. code-block:: bash
- # Mac and Linux
- $ export VENV=~/projects/quick_tutorial/env
+ # macOS and Linux
+ export VENV=~/projects/quick_tutorial/env
.. code-block:: doscon
# Windows
- c:\> set VENV=c:\projects\quick_tutorial\env
+ set VENV=c:\projects\quick_tutorial\env
.. _create-a-virtual-environment:
@@ -150,13 +150,13 @@ environment variable.
.. code-block:: bash
- # Mac and Linux
- $ python3 -m venv $VENV
+ # macOS and Linux
+ python3 -m venv $VENV
.. code-block:: doscon
# Windows
- c:\> python -m venv %VENV%
+ python -m venv %VENV%
.. seealso:: See also Python 3's :mod:`venv module <python:venv>` and Python
2's `virtualenv <https://virtualenv.pypa.io/en/latest/>`_ package.
@@ -171,13 +171,13 @@ time of its release.
.. code-block:: bash
- # Mac and Linux
- $ $VENV/bin/pip install --upgrade pip setuptools
+ # macOS and Linux
+ $VENV/bin/pip install --upgrade pip setuptools
.. code-block:: doscon
# Windows
- c:\> %VENV%\Scripts\pip install --upgrade pip setuptools
+ %VENV%\Scripts\pip install --upgrade pip setuptools
.. seealso:: See also :ref:`Why use $VENV/bin/pip instead of source
bin/activate, then pip <venv-bin-pip-vs-source-bin-activate>`.
@@ -193,11 +193,11 @@ part is pretty easy. We'll also install a WSGI server, Waitress.
.. parsed-literal::
- # Mac and Linux
- $ $VENV/bin/pip install "pyramid==\ |release|\ " waitress
+ # macOS and Linux
+ $VENV/bin/pip install "pyramid==\ |release|\ " waitress
# Windows
- c:\\> %VENV%\\Scripts\\pip install "pyramid==\ |release|\ " waitress
+ %VENV%\\Scripts\\pip install "pyramid==\ |release|\ " waitress
Our Python virtual environment now has the Pyramid software available
as well as the ``waitress`` package.