diff options
| author | Steve Piercy <web@stevepiercy.com> | 2016-12-26 23:09:42 -0800 |
|---|---|---|
| committer | Steve Piercy <web@stevepiercy.com> | 2016-12-26 23:09:42 -0800 |
| commit | b00c4e46cafbaefa32288480477005caabf88bc9 (patch) | |
| tree | 15cb428145cd1370a10724c797235678a6ab1515 /docs/quick_tutorial/tutorial_approach.rst | |
| parent | 910b8a085085fae3d8b44bca6f037fc61d4b10d0 (diff) | |
| download | pyramid-b00c4e46cafbaefa32288480477005caabf88bc9.tar.gz pyramid-b00c4e46cafbaefa32288480477005caabf88bc9.tar.bz2 pyramid-b00c4e46cafbaefa32288480477005caabf88bc9.zip | |
quick_tutorial/tutorial_approach - Fix up the process description to reflect reality, and improve flow
Diffstat (limited to 'docs/quick_tutorial/tutorial_approach.rst')
| -rw-r--r-- | docs/quick_tutorial/tutorial_approach.rst | 34 |
1 files changed, 17 insertions, 17 deletions
diff --git a/docs/quick_tutorial/tutorial_approach.rst b/docs/quick_tutorial/tutorial_approach.rst index d944aaebd..8da9f71b3 100644 --- a/docs/quick_tutorial/tutorial_approach.rst +++ b/docs/quick_tutorial/tutorial_approach.rst @@ -7,24 +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 repository, where each step's directory is -a Python package. - -To successfully run each step, you'll usually copy the current step's directory to a new directory, 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 step's directory. 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: @@ -40,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 start of each step, we usually 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 .``. |
