Merge upstream master

1 files changed, 260 insertions, 126 deletions

diff --git a/docs/tutorials/wiki/installation.rst b/docs/tutorials/wiki/installation.rst
index 20df389c6..6172b122b 100644
--- a/docs/tutorials/wiki/installation.rst
+++ b/docs/tutorials/wiki/installation.rst
@@ -1,17 +1,19 @@
+.. _wiki_installation:
+
 ============
 Installation
 ============
 
 Before you begin
-================
+----------------
 
 This tutorial assumes that you have already followed the steps in
-:ref:`installing_chapter`, except **do not create a virtualenv or install
-Pyramid**.  Thereby you will satisfy the following requirements.
+:ref:`installing_chapter`, except **do not create a virtual environment or
+install Pyramid**.  Thereby you will satisfy the following requirements.
+
+* A Python interpreter is installed on your operating system.
+* You've satisfied the :ref:`requirements-for-installing-packages`.
 
-* Python interpreter is installed on your operating system
-* :term:`setuptools` or :term:`distribute` is installed
-* :term:`virtualenv` is installed
 
 Create directory to contain the project
 ---------------------------------------
@@ -21,257 +23,366 @@ We need a workspace for our project files.
 On UNIX
 ^^^^^^^
 
-.. code-block:: text
+.. code-block:: bash
 
     $ mkdir ~/pyramidtut
 
 On Windows
 ^^^^^^^^^^
 
-.. code-block:: text
+.. code-block:: doscon
 
    c:\> mkdir pyramidtut
 
+
 Create and use a virtual Python environment
 -------------------------------------------
 
-Next let's create a `virtualenv` workspace for our project.  We will
-use the `VENV` environment variable instead of the absolute path of the
-virtual environment.
+Next let's create a virtual environment workspace for our project.  We will use
+the ``VENV`` environment variable instead of the absolute path of the virtual
+environment.
 
 On UNIX
 ^^^^^^^
 
-.. code-block:: text
+.. code-block:: bash
 
    $ export VENV=~/pyramidtut
-   $ virtualenv $VENV
-   New python executable in /home/foo/env/bin/python
-   Installing setuptools.............done.
+   $ python3 -m venv $VENV
 
 On Windows
 ^^^^^^^^^^
 
-.. code-block:: text
+.. code-block:: doscon
 
    c:\> set VENV=c:\pyramidtut
 
-Versions of Python use different paths, so you will need to adjust the
+Each version of Python uses different paths, so you will need to adjust the
 path to the command for your Python version.
 
 Python 2.7:
 
-.. code-block:: text
+.. code-block:: doscon
 
    c:\> c:\Python27\Scripts\virtualenv %VENV%
 
-Python 3.2:
+Python 3.5:
 
-.. code-block:: text
+.. code-block:: doscon
+
+   c:\> c:\Python35\Scripts\python -m venv %VENV%
 
-   c:\> c:\Python32\Scripts\virtualenv %VENV%
 
-Install Pyramid and tutorial dependencies into the virtual Python environment
------------------------------------------------------------------------------
+Upgrade ``pip`` and ``setuptools`` in the virtual environment
+-------------------------------------------------------------
 
 On UNIX
 ^^^^^^^
 
-.. code-block:: text
+.. code-block:: bash
 
-    $ $VENV/bin/easy_install docutils pyramid_tm pyramid_zodbconn \
-            pyramid_debugtoolbar nose coverage
+    $ $VENV/bin/pip install --upgrade pip setuptools
 
 On Windows
 ^^^^^^^^^^
 
-.. code-block:: text
+.. code-block:: doscon
+
+   c:\> %VENV%\Scripts\pip install --upgrade pip setuptools
+
+
+Install Pyramid into the virtual Python environment
+---------------------------------------------------
+
+On UNIX
+^^^^^^^
+
+.. parsed-literal::
+
+   $ $VENV/bin/pip install "pyramid==\ |release|\ "
+
+On Windows
+^^^^^^^^^^
+
+.. parsed-literal::
 
-     c:\> %VENV%\Scripts\easy_install docutils pyramid_tm pyramid_zodbconn \
-            pyramid_debugtoolbar nose coverage
+   c:\\> %VENV%\\Scripts\\pip install "pyramid==\ |release|\ "
 
-Change Directory to Your Virtual Python Environment
+
+Change directory to your virtual Python environment
 ---------------------------------------------------
 
-Change directory to the ``pyramidtut`` directory.
+Change directory to the ``pyramidtut`` directory, which is both your workspace
+and your virtual environment.
 
 On UNIX
 ^^^^^^^
 
-.. code-block:: text
+.. code-block:: bash
 
    $ cd pyramidtut
 
 On Windows
 ^^^^^^^^^^
 
-.. code-block:: text
+.. code-block:: doscon
 
    c:\> cd pyramidtut
 
+
 .. _making_a_project:
 
 Making a project
-================
+----------------
 
 Your next step is to create a project.  For this tutorial, we will use
 the :term:`scaffold` named ``zodb``, which generates an application
 that uses :term:`ZODB` and :term:`traversal`.
 
-:app:`Pyramid` supplies a variety of scaffolds to generate sample
-projects. We will use `pcreate`—a script that comes with Pyramid to
-quickly and easily generate scaffolds, usually with a single command—to
-create the scaffold for our project.
+:app:`Pyramid` supplies a variety of scaffolds to generate sample projects. We
+will use ``pcreate``, a script that comes with Pyramid, to create our project
+using a scaffold.
 
-By passing `zodb` into the `pcreate` command, the script creates
-the files needed to use ZODB. By passing in our application name
-`tutorial`, the script inserts that application name into all the
-required files.
+By passing ``zodb`` into the ``pcreate`` command, the script creates the files
+needed to use ZODB. By passing in our application name ``tutorial``, the script
+inserts that application name into all the required files.
 
 The below instructions assume your current working directory is "pyramidtut".
 
 On UNIX
--------
+^^^^^^^
 
-.. code-block:: text
+.. code-block:: bash
 
    $ $VENV/bin/pcreate -s zodb tutorial
 
 On Windows
-----------
+^^^^^^^^^^
 
-.. code-block:: text
+.. code-block:: doscon
 
    c:\pyramidtut> %VENV%\Scripts\pcreate -s zodb tutorial
 
-.. note:: If you are using Windows, the ``zodb``
-   scaffold may not deal gracefully with installation into a
-   location that contains spaces in the path.  If you experience
-   startup problems, try putting both the virtualenv and the project
-   into directories that do not contain spaces in their paths.
+.. note:: If you are using Windows, the ``zodb`` scaffold may not deal
+   gracefully with installation into a location that contains spaces in the
+   path. If you experience startup problems, try putting both the virtual
+   environment and the project into directories that do not contain spaces in
+   their paths.
+
 
 .. _installing_project_in_dev_mode_zodb:
 
 Installing the project in development mode
-==========================================
+------------------------------------------
 
-In order to do development on the project easily, you must "register"
-the project as a development egg in your workspace using the
-``setup.py develop`` command.  In order to do so, cd to the `tutorial`
-directory you created in :ref:`making_a_project`, and run the
-``setup.py develop`` command using the virtualenv Python interpreter.
+In order to do development on the project easily, you must "register" the
+project as a development egg in your workspace using the ``pip install -e .``
+command. In order to do so, change directory to the ``tutorial`` directory that
+you created in :ref:`making_a_project`, and run the ``pip install -e .``
+command using the virtual environment Python interpreter.
 
 On UNIX
--------
+^^^^^^^
 
-.. code-block:: text
+.. code-block:: bash
 
    $ cd tutorial
-   $ $VENV/bin/python setup.py develop
+   $ $VENV/bin/pip install -e .
 
 On Windows
-----------
+^^^^^^^^^^
 
-.. code-block:: text
+.. code-block:: doscon
 
    c:\pyramidtut> cd tutorial
-   c:\pyramidtut\tutorial> %VENV%\Scripts\python setup.py develop
+   c:\pyramidtut\tutorial> %VENV%\Scripts\pip install -e .
+
+The console will show ``pip`` checking for packages and installing missing
+packages. Success executing this command will show a line like the following:
+
+.. code-block:: bash
+
+   Successfully installed BTrees-4.2.0 Chameleon-2.24 Mako-1.0.4 \
+   MarkupSafe-0.23 Pygments-2.1.3 ZConfig-3.1.0 ZEO-4.2.0b1 ZODB-4.2.0 \
+   ZODB3-3.11.0 mock-2.0.0 pbr-1.8.1 persistent-4.1.1 pyramid-chameleon-0.3 \
+   pyramid-debugtoolbar-2.4.2 pyramid-mako-1.0.2 pyramid-tm-0.12.1 \
+   pyramid-zodbconn-0.7 six-1.10.0 transaction-1.4.4 tutorial waitress-0.8.10 \
+   zc.lockfile-1.1.0 zdaemon-4.1.0 zodbpickle-0.6.0 zodburi-2.0
+
+
+.. _install-testing-requirements-zodb:
+
+Install testing requirements
+----------------------------
+
+In order to run tests, we need to install the testing requirements. This is
+done through our project's ``setup.py`` file, in the ``tests_require`` and
+``extras_require`` stanzas, and by issuing the command below for your
+operating system.
+
+.. literalinclude:: src/installation/setup.py
+   :language: python
+   :linenos:
+   :lineno-start: 22
+   :lines: 22-26
+
+.. literalinclude:: src/installation/setup.py
+   :language: python
+   :linenos:
+   :lineno-start: 45
+   :lines: 45-47
+
+On UNIX
+^^^^^^^
 
-The console will show `setup.py` checking for packages and installing
-missing packages. Success executing this command will show a line like
-the following::
+.. code-block:: bash
+
+   $ $VENV/bin/pip install -e ".[testing]"
+
+On Windows
+^^^^^^^^^^
+
+.. code-block:: doscon
+
+   c:\pyramidtut\tutorial> %VENV%\Scripts\pip install -e ".[testing]"
 
-   Finished processing dependencies for tutorial==0.0
 
 .. _running_tests:
 
 Run the tests
-=============
+-------------
 
-After you've installed the project in development mode, you may run
-the tests for the project.
+After you've installed the project in development mode as well as the testing
+requirements, you may run the tests for the project. The following commands
+provide options to py.test that specify the module for which its tests shall be
+run, and to run py.test in quiet mode.
 
 On UNIX
--------
+^^^^^^^
 
-.. code-block:: text
+.. code-block:: bash
 
-   $ $VENV/bin/python setup.py test -q
+   $ $VENV/bin/py.test -q
 
 On Windows
-----------
+^^^^^^^^^^
 
-.. code-block:: text
+.. code-block:: doscon
 
-   c:\pyramidtut\tutorial> %VENV%\Scripts\python setup.py test -q
+   c:\pyramidtut\tutorial> %VENV%\Scripts\py.test -q
 
-For a successful test run, you should see output that ends like this::
+For a successful test run, you should see output that ends like this:
+
+.. code-block:: bash
+
+   .
+   1 passed in 0.24 seconds
 
-  .
-  ----------------------------------------------------------------------
-  Ran 1 test in 0.094s
- 
-  OK
 
 Expose test coverage information
-================================
+--------------------------------
 
-You can run the ``nosetests`` command to see test coverage
-information.  This runs the tests in the same way that ``setup.py
-test`` does but provides additional "coverage" information, exposing
-which lines of your project are "covered" (or not covered) by the
+You can run the ``py.test`` command to see test coverage information. This
+runs the tests in the same way that ``py.test`` does, but provides additional
+"coverage" information, exposing which lines of your project are covered by the
 tests.
 
+We've already installed the ``pytest-cov`` package into our virtual
+environment, so we can run the tests with coverage.
+
 On UNIX
--------
+^^^^^^^
 
-.. code-block:: text
+.. code-block:: bash
 
-   $ $VENV/bin/nosetests --cover-package=tutorial --cover-erase --with-coverage
+   $ $VENV/bin/py.test --cov --cov-report=term-missing
 
 On Windows
-----------
+^^^^^^^^^^
+
+.. code-block:: doscon
+
+   c:\pyramidtut\tutorial> %VENV%\Scripts\py.test --cov \
+       --cov-report=term-missing
+
+If successful, you will see output something like this:
+
+.. code-block:: bash
+
+   ======================== test session starts ========================
+   platform Python 3.5.1, pytest-2.9.1, py-1.4.31, pluggy-0.3.1
+   rootdir: /Users/stevepiercy/projects/pyramidtut/tutorial, inifile:
+   plugins: cov-2.2.1
+   collected 1 items
+
+   tutorial/tests.py .
+   ------------------ coverage: platform Python 3.5.1 ------------------
+   Name                   Stmts   Miss  Cover   Missing
+   ----------------------------------------------------
+   tutorial/__init__.py      12      7    42%   7-8, 14-18
+   tutorial/models.py        10      6    40%   9-14
+   tutorial/tests.py         12      0   100%
+   tutorial/views.py          4      0   100%
+   ----------------------------------------------------
+   TOTAL                     38     13    66%
+
+   ===================== 1 passed in 0.31 seconds ======================
+
+Our package doesn't quite have 100% test coverage.
 
-.. code-block:: text
 
-   c:\pyramidtut\tutorial> %VENV%\Scripts\nosetests --cover-package=tutorial \
-         --cover-erase --with-coverage
+.. _test_and_coverage_scaffold_defaults_zodb:
 
-If successful, you will see output something like this::
+Test and coverage scaffold defaults
+-----------------------------------
 
-    .
-    Name                 Stmts   Miss  Cover   Missing
-    --------------------------------------------------
-    tutorial.py             12      7    42%   7-8, 14-18
-    tutorial/models.py      10      6    40%   9-14
-    tutorial/views.py        4      0   100%   
-    --------------------------------------------------
-    TOTAL                   26     13    50%   
-    ----------------------------------------------------------------------
-    Ran 1 test in 0.392s
+Scaffolds include configuration defaults for ``py.test`` and test coverage.
+These configuration files are ``pytest.ini`` and ``.coveragerc``, located at
+the root of your package. Without these defaults, we would need to specify the
+path to the module on which we want to run tests and coverage.
 
-    OK
+On UNIX
+^^^^^^^
+
+.. code-block:: bash
+
+   $ $VENV/bin/py.test --cov=tutorial tutorial/tests.py -q
+
+On Windows
+^^^^^^^^^^
+
+.. code-block:: doscon
+
+   c:\pyramidtut\tutorial> %VENV%\Scripts\py.test --cov=tutorial \
+       --cov-report=term-missing tutorial\tests.py -q
+
+py.test follows :ref:`conventions for Python test discovery
+<pytest:test discovery>`, and the configuration defaults from the scaffold
+tell ``py.test`` where to find the module on which we want to run tests and
+coverage.
+
+.. seealso:: See py.test's documentation for :ref:`pytest:usage` or invoke
+   ``py.test -h`` to see its full set of options.
 
-Looks like our package doesn't quite have 100% test coverage.
 
 .. _wiki-start-the-application:
 
 Start the application
-=====================
+---------------------
 
 Start the application.
 
 On UNIX
--------
+^^^^^^^
 
-.. code-block:: text
+.. code-block:: bash
 
    $ $VENV/bin/pserve development.ini --reload
 
 On Windows
-----------
+^^^^^^^^^^
 
-.. code-block:: text
+.. code-block:: doscon
 
    c:\pyramidtut\tutorial> %VENV%\Scripts\pserve development.ini --reload
 
@@ -280,38 +391,61 @@ On Windows
    Your OS firewall, if any, may pop up a dialog asking for authorization
    to allow python to accept incoming network connections.
 
-If successful, you will see something like this on your console::
+If successful, you will see something like this on your console:
+
+.. code-block:: text
 
-    Starting subprocess with file monitor
-    Starting server in PID 95736.
-    serving on http://0.0.0.0:6543
+   Starting subprocess with file monitor
+   Starting server in PID 82349.
+   serving on http://127.0.0.1:6543
 
 This means the server is ready to accept requests.
 
+
 Visit the application in a browser
-==================================
+----------------------------------
 
-In a browser, visit `http://localhost:6543/ <http://localhost:6543>`_.  You
-will see the generated application's default page.
+In a browser, visit http://localhost:6543/. You will see the generated
+application's default page.
 
 One thing you'll notice is the "debug toolbar" icon on right hand side of the
 page.  You can read more about the purpose of the icon at
 :ref:`debug_toolbar`.  It allows you to get information about your
 application while you develop.
 
+
 Decisions the ``zodb`` scaffold has made for you
-================================================
+------------------------------------------------
 
 Creating a project using the ``zodb`` scaffold makes the following
 assumptions:
 
-- you are willing to use :term:`ZODB` as persistent storage
+- You are willing to use :term:`ZODB` as persistent storage.
 
-- you are willing to use :term:`traversal` to map URLs to code
+- You are willing to use :term:`traversal` to map URLs to code.
+
+- You want to use pyramid_zodbconn_, pyramid_tm_, and the transaction_ packages
+  to manage connections and transactions with :term:`ZODB`.
+
+- You want to use pyramid_chameleon_ to render your templates. Different
+  templating engines can be used, but we had to choose one to make this
+  tutorial. See :ref:`available_template_system_bindings` for some options.
 
 .. note::
 
-   :app:`Pyramid` supports any persistent storage mechanism (e.g., a SQL
-   database or filesystem files).  It also supports an additional
-   mechanism to map URLs to code (:term:`URL dispatch`).  However, for the
-   purposes of this tutorial, we'll only be using traversal and ZODB.
+   :app:`Pyramid` supports any persistent storage mechanism (e.g., an SQL
+   database or filesystem files). It also supports an additional mechanism to
+   map URLs to code (:term:`URL dispatch`). However, for the purposes of this
+   tutorial, we'll only be using :term:`traversal` and :term:`ZODB`.
+
+.. _pyramid_chameleon:
+   http://docs.pylonsproject.org/projects/pyramid-chameleon/en/latest/
+
+.. _pyramid_tm:
+   http://docs.pylonsproject.org/projects/pyramid-tm/en/latest/
+
+.. _pyramid_zodbconn:
+   http://docs.pylonsproject.org/projects/pyramid-zodbconn/en/latest/
+
+.. _transaction:
+   http://zodb.readthedocs.org/en/latest/transactions.html