From b1b92284f496800a4dfd2cea72cb9be07ba8661c Mon Sep 17 00:00:00 2001 From: Paul Everitt Date: Fri, 13 Sep 2013 16:52:14 -0400 Subject: First cut at import of quick tutorial. --- docs/quick_tutorial/tutorial_approach.rst | 45 +++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 docs/quick_tutorial/tutorial_approach.rst (limited to 'docs/quick_tutorial/tutorial_approach.rst') diff --git a/docs/quick_tutorial/tutorial_approach.rst b/docs/quick_tutorial/tutorial_approach.rst new file mode 100644 index 000000000..80af1b3d4 --- /dev/null +++ b/docs/quick_tutorial/tutorial_approach.rst @@ -0,0 +1,45 @@ +================= +Tutorial Approach +================= + +In summary: + +- Tutorial broken into topics with quick working examples + +- Each step is a Python *package* with working code in the repo + +- Setup each step with ``python setup.py develop`` + +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:: + + $ cd request_response + $ python setup.py develop + +...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:: + + request_response/ + development.ini + setup.py + tutorial/ + __init__.py + home.pt + tests.py + views.py + +Each of the first-level directories are a *Python project* +(except, as noted, the first.) The ``tutorial`` directory is a *Python +package*. At the end of each step, we copy the old directory into a new +directory to use as a starting point. \ No newline at end of file -- cgit v1.2.3 From 187104fd81418beeb51592913041d9751bafe08d Mon Sep 17 00:00:00 2001 From: Paul Everitt Date: Wed, 25 Sep 2013 09:27:43 -0400 Subject: Quick Tutorial: Improve the setup instructions (adapted from Steve Piercy's work), particularly for Windows. Change all the steps to use $VENV/bin prefixes on commands (don't presume that they have done source env/bin/activate). --- docs/quick_tutorial/tutorial_approach.rst | 40 +++++++++++++++---------------- 1 file changed, 20 insertions(+), 20 deletions(-) (limited to 'docs/quick_tutorial/tutorial_approach.rst') diff --git a/docs/quick_tutorial/tutorial_approach.rst b/docs/quick_tutorial/tutorial_approach.rst index 80af1b3d4..52d768306 100644 --- a/docs/quick_tutorial/tutorial_approach.rst +++ b/docs/quick_tutorial/tutorial_approach.rst @@ -2,13 +2,11 @@ Tutorial Approach ================= -In summary: +This tutorial uses conventions to keep the introduction focused and +concise. Details, references, and deeper discussions are mentioned in +"See Also" notes. -- Tutorial broken into topics with quick working examples - -- Each step is a Python *package* with working code in the repo - -- Setup each step with ``python setup.py develop`` +.. 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. @@ -19,7 +17,7 @@ repo, where each step/topic/directory is a Python package. To successfully run each step:: $ cd request_response - $ python setup.py develop + $ $VENV/bin/python setup.py develop ...and repeat for each step you would like to work on. In most cases we will start with the results of an earlier step. @@ -30,16 +28,18 @@ Directory Tree As we develop our tutorial our directory tree will resemble the structure below:: - request_response/ - development.ini - setup.py - tutorial/ - __init__.py - home.pt - tests.py - views.py - -Each of the first-level directories are a *Python project* -(except, as noted, the first.) The ``tutorial`` directory is a *Python -package*. At the end of each step, we copy the old directory into a new -directory to use as a starting point. \ No newline at end of file + quicktutorial/ + request_response/ + development.ini + setup.py + tutorial/ + __init__.py + home.pt + tests.py + views.py + +Each of the first-level directories (e.g. ``request_response``) is a +*Python project* (except, as noted, 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. \ No newline at end of file -- cgit v1.2.3