From b9b2ee39c251dd68a12e717e1f6d9d02a29efe9a Mon Sep 17 00:00:00 2001 From: Marc Abramowitz Date: Fri, 30 Nov 2012 09:27:09 -0800 Subject: A bunch of minor tweaks to the wiki2 tutorial in docs/tutorials/wiki2 --- docs/tutorials/wiki2/installation.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'docs/tutorials/wiki2/installation.rst') diff --git a/docs/tutorials/wiki2/installation.rst b/docs/tutorials/wiki2/installation.rst index 6589a1557..4ab02a13a 100644 --- a/docs/tutorials/wiki2/installation.rst +++ b/docs/tutorials/wiki2/installation.rst @@ -2,7 +2,7 @@ Installation ============ -This tutorial assumes that Python and virtualenv are already installed +This tutorial assumes that Python and :term:`virtualenv` are already installed and working in your system. If you need help setting this up, you should refer to the chapters on :ref:`installing_chapter`. @@ -98,9 +98,9 @@ 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:`sql_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: @@ -158,8 +158,8 @@ test`` does but provides additional "coverage" information, exposing which lines of your project are "covered" (or not covered) by the tests. -To get this functionality working, we'll need to install a couple of -other packages into our ``virtualenv``: ``nose`` and ``coverage``: +To get this functionality working, we'll need to install the ``nose`` and +``coverage`` packages into our ``virtualenv``: On UNIX: -- cgit v1.2.3 From e91085ec75ddbeb793bec305eb693dad03c34518 Mon Sep 17 00:00:00 2001 From: Steve Johnson Date: Mon, 31 Dec 2012 10:28:16 -0800 Subject: Mention ZopeTxnExt and pyramid_tm in tutorial If this page is found via web search while trying to configure SQLAlchemy from scratch without a scaffold, it is helpful to mention pyramid_tm as a requirement somewhere. Otherwise, a hapless user such as your humble author might spend lots of time wondering why his sessions aren't getting committed after his requests despite his best efforts to properly configure SQLAlchemy and ZopeTransactionExtension. --- docs/tutorials/wiki2/installation.rst | 3 +++ 1 file changed, 3 insertions(+) (limited to 'docs/tutorials/wiki2/installation.rst') diff --git a/docs/tutorials/wiki2/installation.rst b/docs/tutorials/wiki2/installation.rst index 4ab02a13a..05b6a2a42 100644 --- a/docs/tutorials/wiki2/installation.rst +++ b/docs/tutorials/wiki2/installation.rst @@ -303,6 +303,9 @@ the following assumptions: - you are willing to use :term:`url dispatch` to map URLs to code. +- you want to use ``ZopeTransactionExtension`` and ``pyramid_tm`` to scope + sessions to requests + .. note:: :app:`Pyramid` supports any persistent storage mechanism (e.g. object -- cgit v1.2.3 From fdc6975c2c1c2824dbbab543ddc62fc9e3d1655a Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Wed, 2 Jan 2013 22:27:50 +0200 Subject: Reduce duplicated installation instructions from the tutorials * This also removes the mention of running 'source bin/activate' (see #759). --- docs/tutorials/wiki2/installation.rst | 35 ++++------------------------------- 1 file changed, 4 insertions(+), 31 deletions(-) (limited to 'docs/tutorials/wiki2/installation.rst') diff --git a/docs/tutorials/wiki2/installation.rst b/docs/tutorials/wiki2/installation.rst index 05b6a2a42..572bffcab 100644 --- a/docs/tutorials/wiki2/installation.rst +++ b/docs/tutorials/wiki2/installation.rst @@ -2,30 +2,22 @@ Installation ============ -This tutorial assumes that Python and :term:`virtualenv` are already installed -and working in your system. If you need help setting this up, you should -refer to the chapters on :ref:`installing_chapter`. - Preparation =========== -Please take the following steps to prepare for the tutorial. The -steps are slightly different depending on whether you're using UNIX or -Windows. +Follow the steps in :ref:`installing_chapter`, but name the virtualenv +directory ``pyramidtut``. Preparation, UNIX ----------------- #. Install SQLite3 and its development packages if you don't already have them installed. Usually this is via your system's package - manager. For example, on a Debian Linux system, do ``sudo apt-get - install libsqlite3-dev``. - -#. Use your Python's virtualenv to make a workspace: + manager. On a Debian system, this would be: .. code-block:: text - $ path/to/my/Python-2.6/bin/virtualenv --no-site-packages pyramidtut + $ sudo apt-get install libsqlite3-dev #. Switch to the ``pyramidtut`` directory: @@ -33,35 +25,16 @@ Preparation, UNIX $ cd pyramidtut -#. Use ``easy_install`` to get :app:`Pyramid` and its direct - dependencies installed: - - .. code-block:: text - - $ bin/easy_install pyramid Preparation, Windows -------------------- -#. Use your Python's virtualenv to make a workspace: - - .. code-block:: text - - c:\> c:\Python26\Scripts\virtualenv --no-site-packages pyramidtut - #. Switch to the ``pyramidtut`` directory: .. code-block:: text c:\> cd pyramidtut -#. Use ``easy_install`` to get :app:`Pyramid` and its direct - dependencies installed: - - .. code-block:: text - - c:\pyramidtut> Scripts\easy_install pyramid - .. _sql_making_a_project: Making a Project -- cgit v1.2.3 From f65e191ed7da0ff97638879cf854c0b1cb505aaa Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Wed, 2 Jan 2013 23:09:40 +0200 Subject: typos --- docs/tutorials/wiki2/installation.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/tutorials/wiki2/installation.rst') diff --git a/docs/tutorials/wiki2/installation.rst b/docs/tutorials/wiki2/installation.rst index 572bffcab..1e47e18c3 100644 --- a/docs/tutorials/wiki2/installation.rst +++ b/docs/tutorials/wiki2/installation.rst @@ -159,7 +159,7 @@ On Windows: .. code-block:: text - c:\pyramidtut\tutorial> ..\Scripts\nosetests --cover-package=tutorial ^ + c:\pyramidtut\tutorial> ..\Scripts\nosetests --cover-package=tutorial \ --cover-erase --with-coverage If successful, you will see output something like this:: -- cgit v1.2.3 From af1a96331c8de1e4ccc7eebba6f21974d21ebed6 Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Sat, 5 Jan 2013 01:40:32 +0200 Subject: Reduce duplicated content in wiki2 tutorial --- docs/tutorials/wiki2/installation.rst | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'docs/tutorials/wiki2/installation.rst') diff --git a/docs/tutorials/wiki2/installation.rst b/docs/tutorials/wiki2/installation.rst index 572bffcab..d4d5c0cce 100644 --- a/docs/tutorials/wiki2/installation.rst +++ b/docs/tutorials/wiki2/installation.rst @@ -66,6 +66,9 @@ On Windows: 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: + Installing the Project in "Development Mode" ============================================ @@ -181,6 +184,9 @@ If successful, you will see output something like this:: Looks like our package doesn't quite have 100% test coverage. + +.. _initialize_db_wiki2: + Initializing the Database ========================= -- cgit v1.2.3