From 7a8b0d3e9ab3ad73df9ec3110def55c38c527214 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Wed, 20 Mar 2013 14:39:11 -0700 Subject: Make installation explicit and discrete, combining suggestions from @thesteve0, @tshepang, @mcdonc. --- docs/tutorials/wiki2/installation.rst | 108 +++++++++++++++++++++++++--------- 1 file changed, 79 insertions(+), 29 deletions(-) (limited to 'docs/tutorials/wiki2/installation.rst') diff --git a/docs/tutorials/wiki2/installation.rst b/docs/tutorials/wiki2/installation.rst index 8c4149bfc..4b09f6eb7 100644 --- a/docs/tutorials/wiki2/installation.rst +++ b/docs/tutorials/wiki2/installation.rst @@ -5,25 +5,72 @@ Installation Before You Begin ================ -Installation Requirements -------------------------- - -Follow the steps in :ref:`installing_chapter`, but name the virtualenv -directory ``pyramidtut``. Following these steps will ensure you have met the -following requirements: +This tutorial assumes that you have already followed the steps in +:ref:`installing_chapter`, thereby satisfying the following +requirements. * Python interpreter is installed on your operating system * :term:`setuptools` or :term:`distribute` is installed * :term:`virtualenv` is installed -* a virtual Python environment named ``pyramidtut`` has been created -* Pyramid is installed -UNIX Requirements ------------------ +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 +virtual environment. + +**On UNIX:** + +.. code-block:: text + + $ export VENV=~/pyramidtut + $ virtualenv --no-site-packages $VENV + New python executable in /home/foo/env/bin/python + Installing setuptools.............done. + +**On Windows:** + +Set the `VENV` environment variable. + +.. 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. -#. Install SQLite3 and its development packages if you don't already - have them installed. Usually this is via your system's package - manager. On a Debian system, this would be: +Python 2.7: + +.. code-block:: text + + c:\> c:\Python27\Scripts\virtualenv --no-site-packages %VENV% + +Python 3.2: + +.. code-block:: text + + c:\> c:\Python32\Scripts\virtualenv --no-site-packages %VENV% + +Install Pyramid Into the Virtual Python Environment +--------------------------------------------------- + +**On UNIX:** + +.. code-block:: text + + $ $VENV/bin/easy_install pyramid + +**On Windows** + +.. code-block:: text + + c:\env> %VENV%\Scripts\easy_install pyramid + +SQLite3 +------- + +If you used a package manager to install your Python, or if you compiled your Python from source, then you must install SQLite3 and its development packages. If you downloaded your Python from python.org On a Debian system, this would be: .. code-block:: text @@ -49,10 +96,20 @@ Windows Requirements Making a Project ================ -Your next step is to create a project. For this tutorial, we will use the -:term:`scaffold` named ``alchemy``, which generates an application -that uses :term:`SQLAlchemy` and :term:`URL dispatch`. :app:`Pyramid` -supplies a variety of scaffolds to generate sample projects. +Your next step is to create a project. For this tutorial we will use +the :term:`scaffold` named ``alchemy`` which generates an application +that uses :term:`SQLAlchemy` and :term:`URL dispatch`. + +: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 in `alchemy` into the `pcreate` command, the script creates +the files needed to use SQLAlchemy. By passing in our application name +`tutorial`, the script inserts that application name into all the +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". @@ -75,18 +132,10 @@ On Windows: startup problems, try putting both the virtualenv and the project into directories that do not contain spaces in their paths. -`pcreate` is a script that comes with Pyramid that helps by creating and organizing files -needed as part of a Pyramid project. By passing in `alchemy`, we are asking the script to -create the files needed to use SQLAlchemy. By passing in our app name `tutorial`, the script -places that application name in all the different files required. For example, the ``initialize_tutorial_db`` -that is in the ``pyramidtut/bin`` directory was created by `pcreate`. - - - .. _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" the project as a development egg in your workspace using the @@ -108,8 +157,9 @@ On Windows: c:\pyramidtut> cd tutorial c:\pyramidtut\tutorial> %VENV%\Scripts\python setup.py develop -Success executing this command will end with a line to the console something -like:: +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 -- cgit v1.2.3 From 9435d665b797e7a61410cf608d1f1bff4695c2f8 Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Thu, 21 Mar 2013 01:54:00 +0200 Subject: revert to a better paragraph --- docs/tutorials/wiki2/installation.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'docs/tutorials/wiki2/installation.rst') diff --git a/docs/tutorials/wiki2/installation.rst b/docs/tutorials/wiki2/installation.rst index 4b09f6eb7..bb22371ab 100644 --- a/docs/tutorials/wiki2/installation.rst +++ b/docs/tutorials/wiki2/installation.rst @@ -70,7 +70,9 @@ Install Pyramid Into the Virtual Python Environment SQLite3 ------- -If you used a package manager to install your Python, or if you compiled your Python from source, then you must install SQLite3 and its development packages. If you downloaded your Python from python.org On a Debian system, this would be: +Install SQLite3 and its development packages if you don't already +have them installed. Usually this is via your system's package +manager. On a Debian system, this would be: .. code-block:: text -- cgit v1.2.3 From a4010d1b2d3e7c266c2369bb166cf2d7cfafc783 Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Thu, 21 Mar 2013 02:03:20 +0200 Subject: slightly re-organise --- docs/tutorials/wiki2/installation.rst | 11 ++++++----- 1 file changed, 6 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 4b09f6eb7..f55c047ba 100644 --- a/docs/tutorials/wiki2/installation.rst +++ b/docs/tutorials/wiki2/installation.rst @@ -76,16 +76,17 @@ If you used a package manager to install your Python, or if you compiled your Py $ sudo apt-get install libsqlite3-dev -#. Switch to the ``pyramidtut`` directory: +Entering the virtualenv +----------------------- + +Do not forget to switch to the ``pyramidtut`` directory. +In order to do so, run this command if you are on Unix: .. code-block:: text $ cd pyramidtut -Windows Requirements --------------------- - -#. Switch to the ``pyramidtut`` directory: +And run this if you are on Windows: .. code-block:: text -- cgit v1.2.3 From 124daa3f3de2350ee4079d684736acd10b415046 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Thu, 21 Mar 2013 13:27:14 -0700 Subject: Clean up: * SQLite3 language * cd into venv * minor heading names --- docs/tutorials/wiki2/installation.rst | 26 +++++++++++++++++--------- 1 file changed, 17 insertions(+), 9 deletions(-) (limited to 'docs/tutorials/wiki2/installation.rst') diff --git a/docs/tutorials/wiki2/installation.rst b/docs/tutorials/wiki2/installation.rst index 4b09f6eb7..a8b8ee877 100644 --- a/docs/tutorials/wiki2/installation.rst +++ b/docs/tutorials/wiki2/installation.rst @@ -67,25 +67,34 @@ Install Pyramid Into the Virtual Python Environment c:\env> %VENV%\Scripts\easy_install pyramid -SQLite3 -------- +Install SQLite3 and Its Development Packages +-------------------------------------------- -If you used a package manager to install your Python, or if you compiled your Python from source, then you must install SQLite3 and its development packages. If you downloaded your Python from python.org On a Debian system, this would be: +If you used a package manager to install your Python or if you compiled +your Python from source, then you must install SQLite3 and its +development packages. If you downloaded your Python as an installer +from python.org, then you already have it installed and can proceed to +the next section :ref:`sql_making_a_project`.. + +If you need to install the SQLite3 packages, then, for example, using +the Debian system and apt-get, the command would be the following: .. code-block:: text $ sudo apt-get install libsqlite3-dev -#. Switch to the ``pyramidtut`` directory: +Change Directory to Your Virtual Python Environment +--------------------------------------------------- + +Change directory to the ``pyramidtut`` directory. + +**On UNIX:** .. code-block:: text $ cd pyramidtut -Windows Requirements --------------------- - -#. Switch to the ``pyramidtut`` directory: +**On Windows** .. code-block:: text @@ -358,4 +367,3 @@ the following assumptions: mechanism to map URLs to code (:term:`traversal`). However, for the purposes of this tutorial, we'll only be using url dispatch and SQLAlchemy. - -- cgit v1.2.3 From 1ec39d51636ec72ef55b6bfb6c3115cc0be7c160 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Thu, 21 Mar 2013 13:40:10 -0700 Subject: Meh. git hate me. --- docs/tutorials/wiki2/installation.rst | 17 ----------------- 1 file changed, 17 deletions(-) (limited to 'docs/tutorials/wiki2/installation.rst') diff --git a/docs/tutorials/wiki2/installation.rst b/docs/tutorials/wiki2/installation.rst index dd7c76d5f..4361f18e8 100644 --- a/docs/tutorials/wiki2/installation.rst +++ b/docs/tutorials/wiki2/installation.rst @@ -70,7 +70,6 @@ Install Pyramid Into the Virtual Python Environment Install SQLite3 and Its Development Packages -------------------------------------------- -<<<<<<< HEAD If you used a package manager to install your Python or if you compiled your Python from source, then you must install SQLite3 and its development packages. If you downloaded your Python as an installer @@ -79,40 +78,24 @@ the next section :ref:`sql_making_a_project`.. If you need to install the SQLite3 packages, then, for example, using the Debian system and apt-get, the command would be the following: -======= -Install SQLite3 and its development packages if you don't already -have them installed. Usually this is via your system's package -manager. On a Debian system, this would be: ->>>>>>> upstream/master .. code-block:: text $ sudo apt-get install libsqlite3-dev -<<<<<<< HEAD Change Directory to Your Virtual Python Environment --------------------------------------------------- Change directory to the ``pyramidtut`` directory. **On UNIX:** -======= -Entering the virtualenv ------------------------ - -Do not forget to switch to the ``pyramidtut`` directory. -In order to do so, run this command if you are on Unix: ->>>>>>> upstream/master .. code-block:: text $ cd pyramidtut -<<<<<<< HEAD **On Windows** ======= -And run this if you are on Windows: ->>>>>>> upstream/master .. code-block:: text -- cgit v1.2.3 From 2f7320c4fcf38ee95e2aa97228e30c9a873ef1f9 Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Fri, 22 Mar 2013 01:36:29 +0200 Subject: some consistency fixes --- docs/tutorials/wiki2/installation.rst | 49 +++++++++++++++++------------------ 1 file changed, 24 insertions(+), 25 deletions(-) (limited to 'docs/tutorials/wiki2/installation.rst') diff --git a/docs/tutorials/wiki2/installation.rst b/docs/tutorials/wiki2/installation.rst index 4361f18e8..9590e4abe 100644 --- a/docs/tutorials/wiki2/installation.rst +++ b/docs/tutorials/wiki2/installation.rst @@ -29,7 +29,7 @@ virtual environment. New python executable in /home/foo/env/bin/python Installing setuptools.............done. -**On Windows:** +**On Windows**: Set the `VENV` environment variable. @@ -61,7 +61,7 @@ Install Pyramid Into the Virtual Python Environment $ $VENV/bin/easy_install pyramid -**On Windows** +**On Windows**: .. code-block:: text @@ -79,27 +79,26 @@ the next section :ref:`sql_making_a_project`.. If you need to install the SQLite3 packages, then, for example, using the Debian system and apt-get, the command would be the following: - .. code-block:: text +.. code-block:: text - $ sudo apt-get install libsqlite3-dev + $ sudo apt-get install libsqlite3-dev Change Directory to Your Virtual Python Environment --------------------------------------------------- Change directory to the ``pyramidtut`` directory. -**On UNIX:** +**On UNIX**: - .. code-block:: text +.. code-block:: text - $ cd pyramidtut + $ cd pyramidtut -**On Windows** -======= +**On Windows**: - .. code-block:: text +.. code-block:: text - c:\> cd pyramidtut + c:\> cd pyramidtut .. _sql_making_a_project: @@ -124,13 +123,13 @@ required files. For example, `pcreate` creates the The below instructions assume your current working directory is the "virtualenv" named "pyramidtut". -On UNIX: +**On UNIX**: .. code-block:: text $ $VENV/bin/pcreate -s alchemy tutorial -On Windows: +**On Windows**: .. code-block:: text @@ -153,14 +152,14 @@ the project as a development egg in your workspace using the directory you created in :ref:`sql_making_a_project`, and run the ``setup.py develop`` command using the virtualenv Python interpreter. -On UNIX: +**On UNIX**: .. code-block:: text $ cd tutorial $ $VENV/bin/python setup.py develop -On Windows: +**On Windows**: .. code-block:: text @@ -181,13 +180,13 @@ Running 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 -On Windows: +**On Windows**: .. code-block:: text @@ -213,13 +212,13 @@ tests. To get this functionality working, we'll need to install the ``nose`` and ``coverage`` packages into our ``virtualenv``: -On UNIX: +**On UNIX**: .. code-block:: text $ $VENV/bin/easy_install nose coverage -On Windows: +**On Windows**: .. code-block:: text @@ -228,13 +227,13 @@ On Windows: Once ``nose`` and ``coverage`` are installed, we can actually run the coverage tests. -On UNIX: +**On UNIX**: .. code-block:: text $ $VENV/bin/nosetests --cover-package=tutorial --cover-erase --with-coverage -On Windows: +**On Windows**: .. code-block:: text @@ -272,13 +271,13 @@ script` to initialize our database. Type the following command, make sure you are still in the ``tutorial`` directory (the directory with a ``development.ini`` in it): -On UNIX: +**On UNIX**: .. code-block:: text $ $VENV/bin/initialize_tutorial_db development.ini -On Windows: +**On Windows**: .. code-block:: text @@ -320,13 +319,13 @@ Starting the Application Start the application. -On UNIX: +**On UNIX**: .. code-block:: text $ $VENV/bin/pserve development.ini --reload -On Windows: +**On Windows**: .. code-block:: text -- cgit v1.2.3 From 609aeb5daf91d2af3091d2e3cd7078ad47f8867f Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Sat, 23 Mar 2013 03:25:47 -0700 Subject: place colon within strong style --- docs/tutorials/wiki2/installation.rst | 36 +++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) (limited to 'docs/tutorials/wiki2/installation.rst') diff --git a/docs/tutorials/wiki2/installation.rst b/docs/tutorials/wiki2/installation.rst index 9590e4abe..3543d9b9c 100644 --- a/docs/tutorials/wiki2/installation.rst +++ b/docs/tutorials/wiki2/installation.rst @@ -29,7 +29,7 @@ virtual environment. New python executable in /home/foo/env/bin/python Installing setuptools.............done. -**On Windows**: +**On Windows:** Set the `VENV` environment variable. @@ -61,7 +61,7 @@ Install Pyramid Into the Virtual Python Environment $ $VENV/bin/easy_install pyramid -**On Windows**: +**On Windows:** .. code-block:: text @@ -88,13 +88,13 @@ Change Directory to Your Virtual Python Environment Change directory to the ``pyramidtut`` directory. -**On UNIX**: +**On UNIX:** .. code-block:: text $ cd pyramidtut -**On Windows**: +**On Windows:** .. code-block:: text @@ -123,13 +123,13 @@ required files. For example, `pcreate` creates the The below instructions assume your current working directory is the "virtualenv" named "pyramidtut". -**On UNIX**: +**On UNIX:** .. code-block:: text $ $VENV/bin/pcreate -s alchemy tutorial -**On Windows**: +**On Windows:** .. code-block:: text @@ -152,14 +152,14 @@ the project as a development egg in your workspace using the directory you created in :ref:`sql_making_a_project`, and run the ``setup.py develop`` command using the virtualenv Python interpreter. -**On UNIX**: +**On UNIX:** .. code-block:: text $ cd tutorial $ $VENV/bin/python setup.py develop -**On Windows**: +**On Windows:** .. code-block:: text @@ -180,13 +180,13 @@ Running 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 -**On Windows**: +**On Windows:** .. code-block:: text @@ -212,13 +212,13 @@ tests. To get this functionality working, we'll need to install the ``nose`` and ``coverage`` packages into our ``virtualenv``: -**On UNIX**: +**On UNIX:** .. code-block:: text $ $VENV/bin/easy_install nose coverage -**On Windows**: +**On Windows:** .. code-block:: text @@ -227,13 +227,13 @@ To get this functionality working, we'll need to install the ``nose`` and Once ``nose`` and ``coverage`` are installed, we can actually run the coverage tests. -**On UNIX**: +**On UNIX:** .. code-block:: text $ $VENV/bin/nosetests --cover-package=tutorial --cover-erase --with-coverage -**On Windows**: +**On Windows:** .. code-block:: text @@ -271,13 +271,13 @@ script` to initialize our database. Type the following command, make sure you are still in the ``tutorial`` directory (the directory with a ``development.ini`` in it): -**On UNIX**: +**On UNIX:** .. code-block:: text $ $VENV/bin/initialize_tutorial_db development.ini -**On Windows**: +**On Windows:** .. code-block:: text @@ -319,13 +319,13 @@ Starting the Application Start the application. -**On UNIX**: +**On UNIX:** .. code-block:: text $ $VENV/bin/pserve development.ini --reload -**On Windows**: +**On Windows:** .. code-block:: text -- cgit v1.2.3 From 70cc73739af9171f4c918253eb73994ec63677fe Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Mon, 25 Mar 2013 01:37:41 -0700 Subject: give installation a colectomy; give it headings; --- docs/tutorials/wiki2/installation.rst | 60 +++++++++++++++++++++++------------ 1 file changed, 40 insertions(+), 20 deletions(-) (limited to 'docs/tutorials/wiki2/installation.rst') diff --git a/docs/tutorials/wiki2/installation.rst b/docs/tutorials/wiki2/installation.rst index 3543d9b9c..17788cdde 100644 --- a/docs/tutorials/wiki2/installation.rst +++ b/docs/tutorials/wiki2/installation.rst @@ -20,7 +20,8 @@ Next let's create a `virtualenv` workspace for our project. We will use the `VENV` environment variable instead of absolute path of the virtual environment. -**On UNIX:** +On UNIX +^^^^^^^ .. code-block:: text @@ -29,7 +30,8 @@ virtual environment. New python executable in /home/foo/env/bin/python Installing setuptools.............done. -**On Windows:** +On Windows +^^^^^^^^^^ Set the `VENV` environment variable. @@ -55,13 +57,15 @@ Python 3.2: Install Pyramid Into the Virtual Python Environment --------------------------------------------------- -**On UNIX:** +On UNIX +^^^^^^^ .. code-block:: text $ $VENV/bin/easy_install pyramid -**On Windows:** +On Windows +^^^^^^^^^^ .. code-block:: text @@ -88,13 +92,15 @@ Change Directory to Your Virtual Python Environment Change directory to the ``pyramidtut`` directory. -**On UNIX:** +On UNIX +^^^^^^^ .. code-block:: text $ cd pyramidtut -**On Windows:** +On Windows +^^^^^^^^^^ .. code-block:: text @@ -123,13 +129,15 @@ required files. For example, `pcreate` creates the The below instructions assume your current working directory is the "virtualenv" named "pyramidtut". -**On UNIX:** +On UNIX +------- .. code-block:: text $ $VENV/bin/pcreate -s alchemy tutorial -**On Windows:** +On Windows +---------- .. code-block:: text @@ -152,14 +160,16 @@ the project as a development egg in your workspace using the directory you created in :ref:`sql_making_a_project`, and run the ``setup.py develop`` command using the virtualenv Python interpreter. -**On UNIX:** +On UNIX +------- .. code-block:: text $ cd tutorial $ $VENV/bin/python setup.py develop -**On Windows:** +On Windows +---------- .. code-block:: text @@ -180,13 +190,15 @@ Running 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 -**On Windows:** +On Windows +---------- .. code-block:: text @@ -212,13 +224,15 @@ tests. To get this functionality working, we'll need to install the ``nose`` and ``coverage`` packages into our ``virtualenv``: -**On UNIX:** +On UNIX +------- .. code-block:: text $ $VENV/bin/easy_install nose coverage -**On Windows:** +On Windows +---------- .. code-block:: text @@ -227,13 +241,15 @@ To get this functionality working, we'll need to install the ``nose`` and Once ``nose`` and ``coverage`` are installed, we can actually run the coverage tests. -**On UNIX:** +On UNIX +------- .. code-block:: text $ $VENV/bin/nosetests --cover-package=tutorial --cover-erase --with-coverage -**On Windows:** +On Windows +---------- .. code-block:: text @@ -271,13 +287,15 @@ script` to initialize our database. Type the following command, make sure you are still in the ``tutorial`` directory (the directory with a ``development.ini`` in it): -**On UNIX:** +On UNIX +------- .. code-block:: text $ $VENV/bin/initialize_tutorial_db development.ini -**On Windows:** +On Windows +---------- .. code-block:: text @@ -319,13 +337,15 @@ Starting the Application Start the application. -**On UNIX:** +On UNIX +------- .. code-block:: text $ $VENV/bin/pserve development.ini --reload -**On Windows:** +On Windows +---------- .. code-block:: text -- cgit v1.2.3