diff options
Diffstat (limited to 'docs/tutorials/wiki/installation.rst')
| -rw-r--r-- | docs/tutorials/wiki/installation.rst | 63 |
1 files changed, 36 insertions, 27 deletions
diff --git a/docs/tutorials/wiki/installation.rst b/docs/tutorials/wiki/installation.rst index c55c310ef..330b17c86 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 @@ -149,14 +149,18 @@ 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 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 @@ -180,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. @@ -198,48 +202,53 @@ On Windows: c:\pyramidtut\tutorial> ..\Scripts\python setup.py test -q -Starting the Application -======================== +Expose Test Coverage Information +================================ -Start the application. +You can run the ``nosetests`` command to see test coverage +information. This runs the tests in the same way that ``setup.py +test`` does but provides additional "coverage" information, exposing +which lines of your project are "covered" (or not covered) by the +tests. On UNIX: .. code-block:: text - $ ../bin/pserve development.ini --reload + $ ../bin/nosetests --cover-package=tutorial --cover-erase --with-coverage On Windows: .. code-block:: text - c:\pyramidtut\tutorial> ..\Scripts\pserve development.ini --reload + c:\pyramidtut\tutorial> ..\Scripts\nosetests --cover-package=tutorial ^ + --cover-erase --with-coverage -Exposing Test Coverage Information -================================== +Looks like the code in the ``zodb`` scaffold for ZODB projects is +missing some test coverage, particularly in the file named +``models.py``. -You can run the ``nosetests`` command to see test coverage -information. This runs the tests in the same way that ``setup.py -test`` does but provides additional "coverage" information, exposing -which lines of your project are "covered" (or not covered) by the -tests. +Start the Application +===================== + +Start the application. On UNIX: .. code-block:: text - $ ../bin/nosetests --cover-package=tutorial --cover-erase --with-coverage + $ ../bin/pserve development.ini --reload On Windows: .. code-block:: text - c:\pyramidtut\tutorial> ..\Scripts\nosetests --cover-package=tutorial ^ - --cover-erase --with-coverage + c:\pyramidtut\tutorial> ..\Scripts\pserve development.ini --reload -Looks like the code in the ``pyramid_zodb`` scaffold for ZODB projects is -missing some test coverage, particularly in the file named -``models.py``. +.. 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 ================================== @@ -252,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 |