diff options
| author | Michael Merickel <michael@merickel.org> | 2017-01-02 19:22:28 -0600 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-01-02 19:22:28 -0600 |
| commit | f01e74d21e7cadd052c1853d7fe482bd7b9970fa (patch) | |
| tree | abcec287bda4b706bfa3e6bc40601d0883206122 /docs/quick_tutorial/tutorial_approach.rst | |
| parent | fc163d411bd57b232f68ed6554aff3a3ef8f2339 (diff) | |
| parent | a36d33bf7872575fb79cdc0e5959a62b30df5742 (diff) | |
| download | pyramid-f01e74d21e7cadd052c1853d7fe482bd7b9970fa.tar.gz pyramid-f01e74d21e7cadd052c1853d7fe482bd7b9970fa.tar.bz2 pyramid-f01e74d21e7cadd052c1853d7fe482bd7b9970fa.zip | |
Merge pull request #2889 from stevepiercy/docs-cookiecutter-changes-only
Docs cookiecutter changes only - Quick Tutorial and all other files
Diffstat (limited to 'docs/quick_tutorial/tutorial_approach.rst')
| -rw-r--r-- | docs/quick_tutorial/tutorial_approach.rst | 35 |
1 files changed, 17 insertions, 18 deletions
diff --git a/docs/quick_tutorial/tutorial_approach.rst b/docs/quick_tutorial/tutorial_approach.rst index 49a6bfd85..8da9f71b3 100644 --- a/docs/quick_tutorial/tutorial_approach.rst +++ b/docs/quick_tutorial/tutorial_approach.rst @@ -7,25 +7,16 @@ Details, references, and deeper discussions are mentioned in "See also" notes. .. seealso:: This is an example "See also" note. -This "Getting Started" tutorial is broken into independent steps, starting with -the smallest possible "single file WSGI app" example. Each of these steps -introduce a topic and a very small set of concepts via working code. The steps -each correspond to a directory in this repo, where each step/topic/directory is -a Python package. - -To successfully run each step: - -.. code-block:: bash - - $ cd request_response - $ $VENV/bin/pip install -e . - -...and repeat for each step you would like to work on. In most cases we will -start with the results of an earlier step. Directory tree ============== +This "Getting Started" tutorial is broken into independent steps, starting with +the smallest possible "single file WSGI app" example. Each of these steps +introduces a topic and a very small set of concepts via working code. The steps +each correspond to a directory in our workspace, where each step's directory is +a Python package. + As we develop our tutorial, our directory tree will resemble the structure below: @@ -41,7 +32,15 @@ below: │── development.ini `── setup.py -Each of the first-level directories (e.g., ``request_response``) is a *Python +Each of the directories in our ``quick_tutorial`` workspace (e.g., ``request_response``) is a *Python project* (except as noted for the ``hello_world`` step). The ``tutorial`` -directory is a *Python package*. At the end of each step, we copy a previous -directory into a new directory to use as a starting point. +directory is a *Python package*. + +For most steps you will copy the previous step's directory to a new directory, and change your working directory to the new directory, then install your project: + +.. code-block:: bash + + $ cd ..; cp -r package ini; cd ini + $ $VENV/bin/pip install -e . + +For a few steps, you won't copy the previous step's directory, but you will still need to install your project with ``$VENV/bin/pip install -e .``. |
