diff options
| -rw-r--r-- | docs/quick_tutorial/debugtoolbar.rst | 5 | ||||
| -rw-r--r-- | docs/quick_tutorial/functional_testing.rst | 4 | ||||
| -rw-r--r-- | docs/quick_tutorial/tutorial_approach.rst | 2 | ||||
| -rw-r--r-- | docs/quick_tutorial/unit_testing.rst | 4 |
4 files changed, 8 insertions, 7 deletions
diff --git a/docs/quick_tutorial/debugtoolbar.rst b/docs/quick_tutorial/debugtoolbar.rst index dbd93a6cb..1c4d600d1 100644 --- a/docs/quick_tutorial/debugtoolbar.rst +++ b/docs/quick_tutorial/debugtoolbar.rst @@ -102,8 +102,9 @@ temporarily. Extra credit ============ -#. We added ``pyramid_debugtoolbar`` to the list of ``install_requires`` dependencies in ``debugtoolbar/setup.py`` because this tutorial is for development and educational purposes only. - In what cases would you *not* want to add ``pyramid_debugtoolbar`` to your dependencies? +#. We added ``pyramid_debugtoolbar`` to the list of ``dev_requires`` dependencies in ``debugtoolbar/setup.py``. + We then installed the dependencies via ``pip install -e ".[dev]"`` by virtue of the Setuptools ``extras_require`` value in the Python dictionary. + Why did we add them there instead of in the ``requires`` list? #. Introduce a bug into your application. Change: diff --git a/docs/quick_tutorial/functional_testing.rst b/docs/quick_tutorial/functional_testing.rst index b09c68b36..a4676d7a5 100644 --- a/docs/quick_tutorial/functional_testing.rst +++ b/docs/quick_tutorial/functional_testing.rst @@ -45,11 +45,11 @@ Steps :emphasize-lines: 16 #. Install our project and its newly added dependency. - Note that we use the extra specifier ``[testing]`` to install testing requirements and surround it with double quote marks. + Note that we use the extra specifier ``[dev]`` to install testing requirements and surround it with double quote marks. .. code-block:: bash - $VENV/bin/pip install -e ".[testing]" + $VENV/bin/pip install -e ".[dev]" #. Let's extend ``functional_testing/tutorial/tests.py`` to include a functional test: diff --git a/docs/quick_tutorial/tutorial_approach.rst b/docs/quick_tutorial/tutorial_approach.rst index 0b9212e62..a16bce406 100644 --- a/docs/quick_tutorial/tutorial_approach.rst +++ b/docs/quick_tutorial/tutorial_approach.rst @@ -45,4 +45,4 @@ For most steps you will copy an earlier step's directory to a new directory, cha For a few steps, you won't copy an earlier step's directory, but you will still need to install your project with ``$VENV/bin/pip install -e .``. -Finally for a few steps, you might add a dependency to your project in its ``setup.py`` file, and then install both the dependency and the project with either ``$VENV/bin/pip install -e .`` or ``$VENV/bin/pip install -e ".[testing]"``. +Finally for a few steps, you might add a dependency to your project in its ``setup.py`` file, and then install both the dependency and the project with either ``$VENV/bin/pip install -e .`` or ``$VENV/bin/pip install -e ".[dev]"``. diff --git a/docs/quick_tutorial/unit_testing.rst b/docs/quick_tutorial/unit_testing.rst index 283730f0f..4170e9e06 100644 --- a/docs/quick_tutorial/unit_testing.rst +++ b/docs/quick_tutorial/unit_testing.rst @@ -57,11 +57,11 @@ Steps :emphasize-lines: 11-16, 21-23 #. Install our project and its newly added dependency. - Note that we use the extra specifier ``[testing]`` to install testing requirements and surround it with double quote marks. + Note that we use the extra specifier ``[dev]`` to install testing requirements and surround it with double quote marks. .. code-block:: bash - $VENV/bin/pip install -e ".[testing]" + $VENV/bin/pip install -e ".[dev]" #. Now we write a simple unit test in ``unit_testing/tutorial/tests.py``: |