From 4466bb20f3dada4d7fde0aff0a49213d8eb177ab Mon Sep 17 00:00:00 2001 From: kenmanheimer Date: Tue, 8 Nov 2011 11:56:25 -0800 Subject: Convert absolute 'tutorial' package references that are from within the package to relative ones, to reduce brittleness, eg when the user names the package something other than 'tutorial'. - make imports relative - use plain relative URLs for resources (like stylesheets and images) in page templates. --- docs/tutorials/wiki/installation.rst | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'docs/tutorials/wiki/installation.rst') diff --git a/docs/tutorials/wiki/installation.rst b/docs/tutorials/wiki/installation.rst index c55c310ef..a315201fb 100644 --- a/docs/tutorials/wiki/installation.rst +++ b/docs/tutorials/wiki/installation.rst @@ -149,6 +149,10 @@ On Windows: c:\pyramidtut> Scripts\pcreate -s zodb tutorial +.. note:: You don't have to call it `tutorial` -- the code uses + relative paths for imports and finding templates and static + resources. + .. note:: If you are using Windows, the ``zodb`` scaffold doesn't currently deal gracefully with installation into a location that contains spaces in the path. If you experience startup -- cgit v1.2.3 From f846512f9946810f978f8df1e37e602fbee948bd Mon Sep 17 00:00:00 2001 From: kenmanheimer Date: Tue, 8 Nov 2011 14:14:13 -0800 Subject: Swap order of the test-coverage and starting-application sections, so test-coverage comes right after the test section, and the starting-application section right before the visit-app-in-browser section. --- docs/tutorials/wiki/installation.rst | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) (limited to 'docs/tutorials/wiki/installation.rst') diff --git a/docs/tutorials/wiki/installation.rst b/docs/tutorials/wiki/installation.rst index a315201fb..0509f4e44 100644 --- a/docs/tutorials/wiki/installation.rst +++ b/docs/tutorials/wiki/installation.rst @@ -202,23 +202,6 @@ On Windows: c:\pyramidtut\tutorial> ..\Scripts\python setup.py test -q -Starting the Application -======================== - -Start the application. - -On UNIX: - -.. code-block:: text - - $ ../bin/pserve development.ini --reload - -On Windows: - -.. code-block:: text - - c:\pyramidtut\tutorial> ..\Scripts\pserve development.ini --reload - Exposing Test Coverage Information ================================== @@ -245,6 +228,23 @@ Looks like the code in the ``pyramid_zodb`` scaffold for ZODB projects is missing some test coverage, particularly in the file named ``models.py``. +Starting the Application +======================== + +Start the application. + +On UNIX: + +.. code-block:: text + + $ ../bin/pserve development.ini --reload + +On Windows: + +.. code-block:: text + + c:\pyramidtut\tutorial> ..\Scripts\pserve development.ini --reload + Visit the Application in a Browser ================================== -- cgit v1.2.3 From 42410ef646d4427adc3f5d8a5d11b48fd51c0a08 Mon Sep 17 00:00:00 2001 From: kenmanheimer Date: Tue, 8 Nov 2011 14:26:43 -0800 Subject: Use active ("Run the Tests") rather than passive ("Running the Tests") voice for the headings. --- docs/tutorials/wiki/installation.rst | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) (limited to 'docs/tutorials/wiki/installation.rst') diff --git a/docs/tutorials/wiki/installation.rst b/docs/tutorials/wiki/installation.rst index 0509f4e44..4153b9dfd 100644 --- a/docs/tutorials/wiki/installation.rst +++ b/docs/tutorials/wiki/installation.rst @@ -127,8 +127,8 @@ Preparation, Windows .. _making_a_project: -Making a Project -================ +Make a Project +============== Your next step is to create a project. :app:`Pyramid` supplies a variety of scaffolds to generate sample projects. For this tutorial, we will use the @@ -159,8 +159,8 @@ On Windows: problems, try putting both the virtualenv and the project into directories that do not contain spaces in their paths. -Installing the Project in "Development Mode" -============================================ +Install 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 @@ -184,8 +184,8 @@ On Windows: .. _running_tests: -Running the Tests -================= +Run the Tests +============= After you've installed the project in development mode, you may run the tests for the project. @@ -202,8 +202,8 @@ On Windows: c:\pyramidtut\tutorial> ..\Scripts\python setup.py test -q -Exposing Test Coverage Information -================================== +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 @@ -228,8 +228,8 @@ Looks like the code in the ``pyramid_zodb`` scaffold for ZODB projects is missing some test coverage, particularly in the file named ``models.py``. -Starting the Application -======================== +Start the Application +===================== Start the application. -- cgit v1.2.3 From e909e61f1b182fce547782f28855d01b6847ca5a Mon Sep 17 00:00:00 2001 From: kenmanheimer Date: Tue, 8 Nov 2011 14:36:10 -0800 Subject: Note that firewalls may ask for network connection authorization. --- docs/tutorials/wiki/installation.rst | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'docs/tutorials/wiki/installation.rst') diff --git a/docs/tutorials/wiki/installation.rst b/docs/tutorials/wiki/installation.rst index 4153b9dfd..c90306e73 100644 --- a/docs/tutorials/wiki/installation.rst +++ b/docs/tutorials/wiki/installation.rst @@ -245,6 +245,11 @@ On Windows: c:\pyramidtut\tutorial> ..\Scripts\pserve development.ini --reload +.. note:: + + Your OS firewall, if any, may pop up a dialog asking for authorization + to allow python to accept incoming network connections. + Visit the Application in a Browser ================================== -- cgit v1.2.3 From 19799769801c2e0bdca18f6f1e7336c1a2a07eb6 Mon Sep 17 00:00:00 2001 From: kenmanheimer Date: Tue, 8 Nov 2011 15:02:46 -0800 Subject: Track change of the scaffolding file names, removing 'pyramid_' prefix. --- docs/tutorials/wiki/installation.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'docs/tutorials/wiki/installation.rst') diff --git a/docs/tutorials/wiki/installation.rst b/docs/tutorials/wiki/installation.rst index c90306e73..330b17c86 100644 --- a/docs/tutorials/wiki/installation.rst +++ b/docs/tutorials/wiki/installation.rst @@ -224,7 +224,7 @@ On Windows: c:\pyramidtut\tutorial> ..\Scripts\nosetests --cover-package=tutorial ^ --cover-erase --with-coverage -Looks like the code in the ``pyramid_zodb`` scaffold for ZODB projects is +Looks like the code in the ``zodb`` scaffold for ZODB projects is missing some test coverage, particularly in the file named ``models.py``. @@ -261,10 +261,10 @@ 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 ``pyramid_zodb`` Scaffold Has Made For You -======================================================== +Decisions the ``zodb`` Scaffold Has Made For You +================================================ -Creating a project using the ``pyramid_zodb`` scaffold makes the following +Creating a project using the ``zodb`` scaffold makes the following assumptions: - you are willing to use :term:`ZODB` as persistent storage -- cgit v1.2.3