diff options
Diffstat (limited to 'docs/quick_tutorial/tutorial_approach.rst')
| -rw-r--r-- | docs/quick_tutorial/tutorial_approach.rst | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/docs/quick_tutorial/tutorial_approach.rst b/docs/quick_tutorial/tutorial_approach.rst new file mode 100644 index 000000000..6d534fe13 --- /dev/null +++ b/docs/quick_tutorial/tutorial_approach.rst @@ -0,0 +1,47 @@ +================= +Tutorial Approach +================= + +This tutorial uses conventions to keep the introduction focused and concise. +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 +============== + +As we develop our tutorial, our directory tree will resemble the structure +below: + +.. code-block:: text + + quick_tutorial + ├── env + └── request_response + ├── tutorial + │ ├── __init__.py + │ ├── tests.py + │ └── views.py + ├── development.ini + └── setup.py + +Each of the first-level directories (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. |
