| docs/tutorials/wiki/design.rst | ●●●●● patch | view | raw | blame | history | |
| docs/tutorials/wiki/installation.rst | ●●●●● patch | view | raw | blame | history | |
| docs/tutorials/wiki2/background.rst | ●●●●● patch | view | raw | blame | history | |
| docs/tutorials/wiki2/design.rst | ●●●●● patch | view | raw | blame | history | |
| docs/tutorials/wiki2/installation.rst | ●●●●● patch | view | raw | blame | history |
docs/tutorials/wiki/design.rst
@@ -2,22 +2,22 @@ Design ========== Following is a quick overview of our wiki application, to help us understand the changes that we will be doing next in our default files generated by the ``zodb`` scaffold. Following is a quick overview of the design of our wiki application, to help us understand the changes that we will be making as we work through the tutorial. Overall ------- We choose to use ``reStructuredText`` markup in the wiki text. Translation from reStructuredText to HTML is provided by the widely used ``docutils`` Python module. We will add this module in the dependency list on the project ``setup.py`` file. We choose to use :term:`reStructuredText` markup in the wiki text. Translation from reStructuredText to HTML is provided by the widely used ``docutils`` Python module. We will add this module in the dependency list on the project ``setup.py`` file. Models ------ The root resource, named *Wiki*, will be a mapping of wiki page The root resource named ``Wiki`` will be a mapping of wiki page names to page resources. The page resources will be instances of a *Page* class and they store the text content. @@ -29,9 +29,9 @@ is created and its name and reference are added to the Wiki mapping. A page named *FrontPage* containing the text *This is the front page*, will be created when the storage is initialized, and will be used as the wiki home page. A page named ``FrontPage`` containing the text *This is the front page*, will be created when the storage is initialized, and will be used as the wiki home page. Views ----- @@ -57,14 +57,13 @@ corresponding passwords. - GROUPS, a dictionary mapping :term:`userids <userid>` to a list of groups to which they belong to. list of groups to which they belong. - ``groupfinder``, an *authorization callback* that looks up USERS and GROUPS. It will be provided in a new *security.py* file. - ``groupfinder``, an *authorization callback* that looks up USERS and GROUPS. It will be provided in a new ``security.py`` file. - An :term:`ACL` is attached to the root :term:`resource`. Each row below details an :term:`ACE`: - An :term:`ACL` is attached to the root :term:`resource`. Each row below details an :term:`ACE`: +----------+----------------+----------------+ | Action | Principal | Permission | @@ -125,7 +124,7 @@ | | | | authenticate. | | | | | | | | | | | | | | - If authentication | | | | | | | successful, | | | | | | | succeeds, | | | | | | | redirect to the | | | | | | | page that we | | | | | | | came from. | | | @@ -145,6 +144,6 @@ when there is no view name. .. [2] Pyramid will return a default 404 Not Found page if the page *PageName* does not exist yet. .. [3] pyramid.exceptions.Forbidden is reached when a .. [3] ``pyramid.exceptions.Forbidden`` is reached when a user tries to invoke a view that is not authorized by the authorization policy. docs/tutorials/wiki/installation.rst
@@ -2,125 +2,218 @@ Installation ============ Preparation =========== Before you begin ================ Follow the steps in :ref:`installing_chapter`, but name the virtualenv directory ``pyramidtut``. This tutorial assumes that you have already followed the steps in :ref:`installing_chapter`, except **do not create a virtualenv or install Pyramid**. Thereby you will satisfy the following requirements. Preparation, UNIX ----------------- * Python interpreter is installed on your operating system * :term:`setuptools` or :term:`distribute` is installed * :term:`virtualenv` is installed Create directory to contain the project --------------------------------------- #. Switch to the ``pyramidtut`` directory: We need a workspace for our project files. .. code-block:: text $ cd pyramidtut #. Install tutorial dependencies: .. code-block:: text $ $VENV/bin/easy_install docutils pyramid_tm pyramid_zodbconn \ pyramid_debugtoolbar nose coverage Preparation, Windows -------------------- #. Switch to the ``pyramidtut`` directory: .. code-block:: text c:\> cd pyramidtut #. Install tutorial dependencies: .. code-block:: text c:\pyramidtut> %VENV%\Scripts\easy_install docutils pyramid_tm \ pyramid_zodbconn pyramid_debugtoolbar nose coverage .. _making_a_project: Make a Project ============== Your next step is to create a project. For this tutorial, we will use the :term:`scaffold` named ``zodb``, which generates an application that uses :term:`ZODB` and :term:`traversal`. :app:`Pyramid` supplies a variety of scaffolds to generate sample projects. The below instructions assume your current working directory is the "virtualenv" named "pyramidtut". On UNIX: On UNIX ^^^^^^^ .. code-block:: text $ $VENV/bin/pcreate -s zodb tutorial $ mkdir ~/pyramidtut On Windows: On Windows ^^^^^^^^^^ .. code-block:: text c:\> mkdir pyramidtut Create and use a virtual Python environment ------------------------------------------- Next let's create a `virtualenv` workspace for our project. We will use the `VENV` environment variable instead of the absolute path of the virtual environment. On UNIX ^^^^^^^ .. code-block:: text $ export VENV=~/pyramidtut $ virtualenv $VENV New python executable in /home/foo/env/bin/python Installing setuptools.............done. On Windows ^^^^^^^^^^ .. code-block:: text c:\> set VENV=c:\pyramidtut Versions of Python use different paths, so you will need to adjust the path to the command for your Python version. Python 2.7: .. code-block:: text c:\> c:\Python27\Scripts\virtualenv %VENV% Python 3.2: .. code-block:: text c:\> c:\Python32\Scripts\virtualenv %VENV% Install Pyramid and tutorial dependencies into the virtual Python environment ----------------------------------------------------------------------------- On UNIX ^^^^^^^ .. code-block:: text $ $VENV/bin/easy_install docutils pyramid_tm pyramid_zodbconn \ pyramid_debugtoolbar nose coverage On Windows ^^^^^^^^^^ .. code-block:: text c:\> %VENV%\Scripts\easy_install docutils pyramid_tm pyramid_zodbconn \ pyramid_debugtoolbar nose coverage Change Directory to Your Virtual Python Environment --------------------------------------------------- Change directory to the ``pyramidtut`` directory. On UNIX ^^^^^^^ .. code-block:: text $ cd pyramidtut On Windows ^^^^^^^^^^ .. code-block:: text c:\> cd pyramidtut .. _making_a_project: Making a project ================ Your next step is to create a project. For this tutorial, we will use the :term:`scaffold` named ``zodb``, which generates an application that uses :term:`ZODB` and :term:`traversal`. :app:`Pyramid` supplies a variety of scaffolds to generate sample projects. We will use `pcreate`—a script that comes with Pyramid to quickly and easily generate scaffolds, usually with a single command—to create the scaffold for our project. By passing `zodb` into the `pcreate` command, the script creates the files needed to use ZODB. By passing in our application name `tutorial`, the script inserts that application name into all the required files. The below instructions assume your current working directory is "pyramidtut". On UNIX ------- .. code-block:: text $ $VENV/bin/pcreate -s zodb tutorial On Windows ---------- .. code-block:: text c:\pyramidtut> %VENV%\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 may not 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. .. 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_project_in_dev_mode_zodb: Install the Project in "Development Mode" ========================================= Installing 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 ``setup.py develop`` command. In order to do so, cd to the "tutorial" ``setup.py develop`` command. In order to do so, cd to the `tutorial` directory you created in :ref:`making_a_project`, and run the "setup.py develop" command using virtualenv Python interpreter. ``setup.py develop`` command using the virtualenv Python interpreter. On UNIX: On UNIX ------- .. code-block:: text $ cd tutorial $ $VENV/bin/python setup.py develop $ cd tutorial $ $VENV/bin/python setup.py develop On Windows: On Windows ---------- .. code-block:: text C:\pyramidtut> cd tutorial C:\pyramidtut\tutorial> %VENV%\Scripts\python setup.py develop c:\pyramidtut> cd tutorial c:\pyramidtut\tutorial> %VENV%\Scripts\python setup.py develop The console will show `setup.py` checking for packages and installing missing packages. Success executing this command will show a line like the following:: Finished processing dependencies for tutorial==0.0 .. _running_tests: Run the Tests Run the tests ============= After you've installed the project in development mode, you may run the tests for the project. On UNIX: On UNIX ------- .. code-block:: text $ $VENV/bin/python setup.py test -q $ $VENV/bin/python setup.py test -q On Windows: On Windows ---------- .. code-block:: text c:\pyramidtut\tutorial> %VENV%\Scripts\python setup.py test -q c:\pyramidtut\tutorial> %VENV%\Scripts\python setup.py test -q Expose Test Coverage Information For a successful test run, you should see output that ends like this:: . ---------------------------------------------------------------------- Ran 1 test in 0.094s OK Expose test coverage information ================================ You can run the ``nosetests`` command to see test coverage @@ -129,48 +222,73 @@ which lines of your project are "covered" (or not covered) by the tests. On UNIX: On UNIX ------- .. code-block:: text $ $VENV/bin/nosetests --cover-package=tutorial --cover-erase --with-coverage $ $VENV/bin/nosetests --cover-package=tutorial --cover-erase --with-coverage On Windows: On Windows ---------- .. code-block:: text c:\pyramidtut\tutorial> %VENV%\Scripts\nosetests --cover-package=tutorial ^ --cover-erase --with-coverage c:\pyramidtut\tutorial> %VENV%\Scripts\nosetests --cover-package=tutorial \ --cover-erase --with-coverage Looks like the code in the ``zodb`` scaffold for ZODB projects is missing some test coverage, particularly in the file named ``models.py``. If successful, you will see output something like this:: . Name Stmts Miss Cover Missing -------------------------------------------------- tutorial.py 12 7 42% 7-8, 14-18 tutorial/models.py 10 6 40% 9-14 tutorial/views.py 4 0 100% -------------------------------------------------- TOTAL 26 13 50% ---------------------------------------------------------------------- Ran 1 test in 0.392s OK Looks like our package doesn't quite have 100% test coverage. .. _wiki-start-the-application: Start the Application Start the application ===================== Start the application. On UNIX: On UNIX ------- .. code-block:: text $ $VENV/bin/pserve development.ini --reload $ $VENV/bin/pserve development.ini --reload On Windows: On Windows ---------- .. code-block:: text c:\pyramidtut\tutorial> %VENV%\Scripts\pserve development.ini --reload c:\pyramidtut\tutorial> %VENV%\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 If successful, you will see something like this on your console:: Starting subprocess with file monitor Starting server in PID 95736. serving on http://0.0.0.0:6543 This means the server is ready to accept requests. Visit the application in a browser ================================== In a browser, visit `http://localhost:6543/ <http://localhost:6543>`_. You @@ -181,7 +299,7 @@ :ref:`debug_toolbar`. It allows you to get information about your application while you develop. Decisions the ``zodb`` Scaffold Has Made For You Decisions the ``zodb`` scaffold has made for you ================================================ Creating a project using the ``zodb`` scaffold makes the following @@ -189,11 +307,11 @@ - you are willing to use :term:`ZODB` as persistent storage - you are willing to use :term:`traversal` to map URLs to code. - you are willing to use :term:`traversal` to map URLs to code .. note:: :app:`Pyramid` supports any persistent storage mechanism (e.g., a SQL database or filesystem files). :app:`Pyramid` also supports an additional database or filesystem files). It also supports an additional mechanism to map URLs to code (:term:`URL dispatch`). However, for the purposes of this tutorial, we'll only be using traversal and ZODB. docs/tutorials/wiki2/background.rst
@@ -2,10 +2,12 @@ Background ========== This tutorial presents a :app:`Pyramid` application that uses technologies which will be familiar to someone with SQL database experience. It uses This version of the :app:`Pyramid` wiki tutorial presents a :app:`Pyramid` application that uses technologies which will be familiar to someone with SQL database experience. It uses :term:`SQLAlchemy` as a persistence mechanism and :term:`url dispatch` to map URLs to code. URLs to code. It can also be followed by people without any prior Python web framework experience. To code along with this tutorial, the developer will need a UNIX machine with development tools (Mac OS X with XCode, any Linux or BSD docs/tutorials/wiki2/design.rst
@@ -9,7 +9,7 @@ Overall ------- We choose to use :term:`reStructuredText` markup in the wiki text. Translation We choose to use :term:`reStructuredText` markup in the wiki text. Translation from reStructuredText to HTML is provided by the widely used ``docutils`` Python module. We will add this module in the dependency list on the project ``setup.py`` file. @@ -37,8 +37,8 @@ ----- There will be three views to handle the normal operations of adding, editing and viewing wiki pages, plus one view for the wiki front page. Two templates will be used, one for viewing, and one for both for adding editing, and viewing wiki pages, plus one view for the wiki front page. Two templates will be used, one for viewing, and one for both adding and editing wiki pages. The default templating systems in :app:`Pyramid` are @@ -53,13 +53,14 @@ We'll eventually be adding security to our application. The components we'll use to do this are below. - USERS, a dictionary mapping users names (the user's :term:`userids <userid>`) to their corresponding passwords. - USERS, a dictionary mapping :term:`userids <userid>` to their corresponding passwords. - GROUPS, a dictionary mapping user names to a list of groups they belong to. - GROUPS, a dictionary mapping :term:`userids <userid>` to a list of groups to which they belong. - ``groupfinder``, an *authorization callback* that looks up USERS and GROUPS. It will be provided in a new *security.py* file. GROUPS. It will be provided in a new ``security.py`` file. - An :term:`ACL` is attached to the root :term:`resource`. Each row below details an :term:`ACE`: @@ -101,7 +102,7 @@ | | with existing | | | | | | content. | | | | | | | | | | | | If the form is | | | | | | If the form was | | | | | | submitted, redirect | | | | | | to /PageName | | | | +----------------------+-----------------------+-------------+------------+------------+ @@ -111,7 +112,7 @@ | | the edit form | | | | | | without content. | | | | | | | | | | | | If the form is | | | | | | If the form was | | | | | | submitted, | | | | | | redirect to | | | | | | /PageName | | | | @@ -119,7 +120,7 @@ | /login | Display login form, | login | login.pt | | | | Forbidden [3]_ | | | | | | | | | | | | If the form is | | | | | | If the form was | | | | | | submitted, | | | | | | authenticate. | | | | | | | | | | docs/tutorials/wiki2/installation.rst
@@ -2,22 +2,41 @@ Installation ============ Before You Begin Before you begin ================ This tutorial assumes that you have already followed the steps in :ref:`installing_chapter`, thereby satisfying the following requirements. :ref:`installing_chapter`, except **do not create a virtualenv or install Pyramid**. Thereby you will satisfy the following requirements. * Python interpreter is installed on your operating system * :term:`setuptools` or :term:`distribute` is installed * :term:`virtualenv` is installed Create and Use a Virtual Python Environment Create directory to contain the project --------------------------------------- We need a workspace for our project files. On UNIX ^^^^^^^ .. code-block:: text $ mkdir ~/pyramidtut On Windows ^^^^^^^^^^ .. code-block:: text c:\> mkdir pyramidtut Create and use a virtual Python environment ------------------------------------------- Next let's create a `virtualenv` workspace for our project. We will use the `VENV` environment variable instead of absolute path of the use the `VENV` environment variable instead of the absolute path of the virtual environment. On UNIX @@ -32,8 +51,6 @@ On Windows ^^^^^^^^^^ Set the `VENV` environment variable. .. code-block:: text @@ -54,7 +71,7 @@ c:\> c:\Python32\Scripts\virtualenv %VENV% Install Pyramid Into the Virtual Python Environment Install Pyramid into the virtual Python environment --------------------------------------------------- On UNIX @@ -69,9 +86,9 @@ .. code-block:: text c:\env> %VENV%\Scripts\easy_install pyramid c:\> %VENV%\Scripts\easy_install pyramid Install SQLite3 and Its Development Packages Install SQLite3 and its development packages -------------------------------------------- If you used a package manager to install your Python or if you compiled @@ -87,7 +104,7 @@ $ sudo apt-get install libsqlite3-dev Change Directory to Your Virtual Python Environment Change directory to your virtual Python environment --------------------------------------------------- Change directory to the ``pyramidtut`` directory. @@ -108,7 +125,7 @@ .. _sql_making_a_project: Making a Project Making a project ================ Your next step is to create a project. For this tutorial we will use @@ -117,7 +134,7 @@ :app:`Pyramid` supplies a variety of scaffolds to generate sample projects. We will use `pcreate`—a script that comes with Pyramid to quickly and easily generate scaffolds usually with a single command—to quickly and easily generate scaffolds, usually with a single command—to create the scaffold for our project. By passing `alchemy` into the `pcreate` command, the script creates @@ -126,8 +143,7 @@ required files. For example, `pcreate` creates the ``initialize_tutorial_db`` in the ``pyramidtut/bin`` directory. The below instructions assume your current working directory is the "virtualenv" named "pyramidtut". The below instructions assume your current working directory is "pyramidtut". On UNIX ------- @@ -141,7 +157,7 @@ .. code-block:: text c:\pyramidtut> %VENV%\pcreate -s alchemy tutorial c:\pyramidtut> %VENV%\Scripts\pcreate -s alchemy tutorial .. note:: If you are using Windows, the ``alchemy`` scaffold may not deal gracefully with installation into a @@ -151,7 +167,7 @@ .. _installing_project_in_dev_mode: Installing the Project in Development Mode Installing the project in development mode ========================================== In order to do development on the project easily, you must "register" @@ -184,8 +200,8 @@ .. _sql_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. @@ -212,8 +228,8 @@ OK 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 @@ -274,10 +290,9 @@ Looks like our package doesn't quite have 100% test coverage. .. _initialize_db_wiki2: Initializing the Database Initializing the database ========================= We need to use the ``initialize_tutorial_db`` :term:`console @@ -333,8 +348,8 @@ .. _wiki2-start-the-application: Starting the Application ======================== Start the application ===================== Start the application. @@ -352,6 +367,11 @@ c:\pyramidtut\tutorial> %VENV%\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. If successful, you will see something like this on your console:: Starting subprocess with file monitor @@ -360,19 +380,22 @@ This means the server is ready to accept requests. At this point, when you visit ``http://localhost:6543/`` in your web browser, you will see the generated application's default page. Visit the application in a browser ================================== In a browser, visit `http://localhost:6543/ <http://localhost:6543>`_. You will see the generated application's default page. One thing you'll notice is the "debug toolbar" icon on right hand side of the 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 ``alchemy`` Scaffold Has Made for You Decisions the ``alchemy`` scaffold has made for you ================================================================= Creating a project using the ``alchemy`` scaffold makes the following assumptions: Creating a project using the ``alchemy`` scaffold makes the following assumptions: - you are willing to use :term:`SQLAlchemy` as a database access tool
