From 5acf4b4809e88dfeb3882f5033622a9517763d02 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Thu, 22 Nov 2012 00:39:19 -0500 Subject: appeasement --- docs/narr/install.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) (limited to 'docs/narr/install.rst') diff --git a/docs/narr/install.rst b/docs/narr/install.rst index e8482a289..32f331550 100644 --- a/docs/narr/install.rst +++ b/docs/narr/install.rst @@ -243,6 +243,17 @@ Once you've got setuptools or distribute installed, you should install the :term:`virtualenv` package. To install the :term:`virtualenv` package into your setuptools-enabled Python interpreter, use the ``easy_install`` command. +.. warning:: + + Even though Python 3.3 and better comes with ``pyvenv`` out of the box, + which is similar to ``virtualenv``, we suggest using ``virtualenv`` instead. + ``virtualenv`` works on well Python 3.3. This isn't a recommendation made + for technical reasons, it's one made because it's not possible for the + authors of this guide to explain setup using multiple virtual environment + systems. ``pyenv`` will work fine. However, if you use ``pyvenv`` instead, + you'll need to understand how to install software such as ``distribute`` + into the virtual environment manually, which this guide does not cover. + .. code-block:: text $ easy_install virtualenv -- cgit v1.2.3 From 5d9c28f4e7f1fd3eba75e5bb51aebcbb56440df8 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Thu, 22 Nov 2012 00:40:47 -0500 Subject: more appeasement --- docs/narr/install.rst | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) (limited to 'docs/narr/install.rst') diff --git a/docs/narr/install.rst b/docs/narr/install.rst index 32f331550..663f0df6c 100644 --- a/docs/narr/install.rst +++ b/docs/narr/install.rst @@ -248,11 +248,14 @@ your setuptools-enabled Python interpreter, use the ``easy_install`` command. Even though Python 3.3 and better comes with ``pyvenv`` out of the box, which is similar to ``virtualenv``, we suggest using ``virtualenv`` instead. ``virtualenv`` works on well Python 3.3. This isn't a recommendation made - for technical reasons, it's one made because it's not possible for the + for technical reasons, it's one made because it's not feasible for the authors of this guide to explain setup using multiple virtual environment - systems. ``pyenv`` will work fine. However, if you use ``pyvenv`` instead, - you'll need to understand how to install software such as ``distribute`` - into the virtual environment manually, which this guide does not cover. + systems. We are aiming to not need to make the installation documentation + Turing-complete. + + ``pyenv`` will work fine. However, if you use ``pyvenv`` instead, you'll + need to understand how to install software such as ``distribute`` into the + virtual environment manually, which this guide does not cover. .. code-block:: text -- cgit v1.2.3 From fb30e2cb79490f9dcafaea3d5ce2c0af140eae71 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Thu, 22 Nov 2012 13:28:41 -0500 Subject: typos --- docs/narr/install.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) (limited to 'docs/narr/install.rst') diff --git a/docs/narr/install.rst b/docs/narr/install.rst index 663f0df6c..882e76f11 100644 --- a/docs/narr/install.rst +++ b/docs/narr/install.rst @@ -253,9 +253,10 @@ your setuptools-enabled Python interpreter, use the ``easy_install`` command. systems. We are aiming to not need to make the installation documentation Turing-complete. - ``pyenv`` will work fine. However, if you use ``pyvenv`` instead, you'll - need to understand how to install software such as ``distribute`` into the - virtual environment manually, which this guide does not cover. + ``pyvenv`` will work fine. However, if you use ``pyvenv`` instead of + ``virtualenv``, you'll need to understand how to install software such as + ``distribute`` into the virtual environment manually, which this guide does + not cover. .. code-block:: text -- cgit v1.2.3 From b27d66f81274625446c301c2675638b36b5e16b3 Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Tue, 1 Jan 2013 20:12:47 +0200 Subject: fix #746: explain why a dev package is installed --- docs/narr/install.rst | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'docs/narr/install.rst') diff --git a/docs/narr/install.rst b/docs/narr/install.rst index 882e76f11..c9cdb745a 100644 --- a/docs/narr/install.rst +++ b/docs/narr/install.rst @@ -52,6 +52,10 @@ command: $ sudo apt-get install python2.7-dev +This command will install both the Python interpreter and its header files. +Note that these headers are required by some dependencies you will use +in this docomentation, not by Pyramid itself. + Once these steps are performed, the Python interpreter will usually be invokable via ``python2.7`` from a shell prompt. -- cgit v1.2.3 From 78bacaa69f63fe2bc6980d7d40fc0523d5af9199 Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Tue, 1 Jan 2013 21:52:33 +0200 Subject: typos --- docs/narr/install.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/narr/install.rst') diff --git a/docs/narr/install.rst b/docs/narr/install.rst index 882e76f11..09c37c7f2 100644 --- a/docs/narr/install.rst +++ b/docs/narr/install.rst @@ -167,10 +167,10 @@ installed: Python 2.7.3 (default, Aug 1 2012, 05:14:39) [GCC 4.6.3] on linux2 Type "help", "copyright", "credits" or "license" for more information. - >>> import setutptools + >>> import setuptools Traceback (most recent call last): File "", line 1, in - ImportError: No module named setutptools + ImportError: No module named setuptools >>> If ``import setuptools`` raises an :exc:`ImportError` as it does above, you -- cgit v1.2.3 From 78bba61a7a53949529c1b7444fd6611e116b725d Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Tue, 1 Jan 2013 23:34:09 +0200 Subject: improve wording regarding pyvenv --- docs/narr/install.rst | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) (limited to 'docs/narr/install.rst') diff --git a/docs/narr/install.rst b/docs/narr/install.rst index 882e76f11..8a8513348 100644 --- a/docs/narr/install.rst +++ b/docs/narr/install.rst @@ -245,18 +245,19 @@ your setuptools-enabled Python interpreter, use the ``easy_install`` command. .. warning:: - Even though Python 3.3 and better comes with ``pyvenv`` out of the box, - which is similar to ``virtualenv``, we suggest using ``virtualenv`` instead. - ``virtualenv`` works on well Python 3.3. This isn't a recommendation made - for technical reasons, it's one made because it's not feasible for the + Python 3.3 includes ``pyvenv`` out of the box, which provides similar + functionality to ``virtualenv``. + We however suggest using ``virtualenv`` instead, + which works well with Python 3.3. + This isn't a recommendation made for technical reasons; + it's made because it's not feasible for the authors of this guide to explain setup using multiple virtual environment systems. We are aiming to not need to make the installation documentation Turing-complete. - ``pyvenv`` will work fine. However, if you use ``pyvenv`` instead of - ``virtualenv``, you'll need to understand how to install software such as - ``distribute`` into the virtual environment manually, which this guide does - not cover. + If you insist on using ``pyvenv``, you'll need to understand how to install + software such as``distribute`` into the virtual environment manually, + which this guide does not cover. .. code-block:: text -- cgit v1.2.3 From 638ce950df1c8c8393c44a578270480f86dd060c Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Tue, 1 Jan 2013 21:11:38 -0500 Subject: fix rationale and typo --- docs/narr/install.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'docs/narr/install.rst') diff --git a/docs/narr/install.rst b/docs/narr/install.rst index c9cdb745a..a1c7b0d64 100644 --- a/docs/narr/install.rst +++ b/docs/narr/install.rst @@ -52,9 +52,9 @@ command: $ sudo apt-get install python2.7-dev -This command will install both the Python interpreter and its header files. -Note that these headers are required by some dependencies you will use -in this docomentation, not by Pyramid itself. +This command will install both the Python interpreter and its development +header files. Note that the headers are required by some (optional) C +extensions in software depended upon by Pyramid, not by Pyramid itself. Once these steps are performed, the Python interpreter will usually be invokable via ``python2.7`` from a shell prompt. -- cgit v1.2.3 From 00d83a42a4499a1a94d9019b740cc477270960cf Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Tue, 1 Jan 2013 21:23:12 -0500 Subject: reflow, typo --- docs/narr/install.rst | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) (limited to 'docs/narr/install.rst') diff --git a/docs/narr/install.rst b/docs/narr/install.rst index 8947a891f..6db0d88f5 100644 --- a/docs/narr/install.rst +++ b/docs/narr/install.rst @@ -250,17 +250,15 @@ your setuptools-enabled Python interpreter, use the ``easy_install`` command. .. warning:: Python 3.3 includes ``pyvenv`` out of the box, which provides similar - functionality to ``virtualenv``. - We however suggest using ``virtualenv`` instead, - which works well with Python 3.3. - This isn't a recommendation made for technical reasons; - it's made because it's not feasible for the - authors of this guide to explain setup using multiple virtual environment - systems. We are aiming to not need to make the installation documentation + functionality to ``virtualenv``. We however suggest using ``virtualenv`` + instead, which works well with Python 3.3. This isn't a recommendation made + for technical reasons; it's made because it's not feasible for the authors + of this guide to explain setup using multiple virtual environment systems. + We are aiming to not need to make the installation documentation Turing-complete. If you insist on using ``pyvenv``, you'll need to understand how to install - software such as``distribute`` into the virtual environment manually, + software such as ``distribute`` into the virtual environment manually, which this guide does not cover. .. code-block:: text -- cgit v1.2.3 From 22ed77d69b0f2348983be0c4e8758a44cf160671 Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Wed, 9 Jan 2013 02:30:47 +0200 Subject: take advantage of the -c option of Python --- docs/narr/install.rst | 21 +++++---------------- 1 file changed, 5 insertions(+), 16 deletions(-) (limited to 'docs/narr/install.rst') diff --git a/docs/narr/install.rst b/docs/narr/install.rst index ff89553ae..a78c1b2bd 100644 --- a/docs/narr/install.rst +++ b/docs/narr/install.rst @@ -150,32 +150,21 @@ To set up a virtualenv in which to install :app:`Pyramid`, first ensure that ``import setuptools`` within the Python interpreter you'd like to run :app:`Pyramid` under. -Here's the output you'll expect if setuptools or distribute is already -installed: +The following command will not display anything if setuptools or distribute is +already installed: .. code-block:: text - [chrism@thinko docs]$ python2.7 - Python 2.7.3 (default, Aug 1 2012, 05:14:39) - [GCC 4.6.3] on linux2 - Type "help", "copyright", "credits" or "license" for more information. - >>> import setuptools - >>> + $ python2.7 -c 'import setuptools' -Here's the output you can expect if setuptools or distribute is not already -installed: +Running the same command will yield the following output if setuptools or +distribute is not yet installed: .. code-block:: text - [chrism@thinko docs]$ python2.7 - Python 2.7.3 (default, Aug 1 2012, 05:14:39) - [GCC 4.6.3] on linux2 - Type "help", "copyright", "credits" or "license" for more information. - >>> import setuptools Traceback (most recent call last): File "", line 1, in ImportError: No module named setuptools - >>> If ``import setuptools`` raises an :exc:`ImportError` as it does above, you will need to install setuptools or distribute manually. Note that above -- cgit v1.2.3 From 7e10cd0fd38bdeeba988e6ecf1b6179a0086559c Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Thu, 17 Jan 2013 22:06:50 +0200 Subject: miscellaneous doc improvements * the word "system" can be misleading, so use a clearer choice of words * reduce repetition * mention Debian, since it is similar to Ubuntu, and is major enough * it is now "Ubuntu", not "Ubuntu Linux" --- docs/narr/install.rst | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) (limited to 'docs/narr/install.rst') diff --git a/docs/narr/install.rst b/docs/narr/install.rst index a78c1b2bd..6653243d5 100644 --- a/docs/narr/install.rst +++ b/docs/narr/install.rst @@ -40,13 +40,11 @@ UNIX system that has development tools. Package Manager Method ++++++++++++++++++++++ -You can use your system's "package manager" to install Python. Every -system's package manager is slightly different, but the "flavor" of +You can use your system's "package manager" to install Python. +Each package manager is slightly different, but the "flavor" of them is usually the same. -For example, on an Ubuntu Linux system, to use the system package -manager to install a Python 2.7 interpreter, use the following -command: +For example, on a Debian or Ubuntu system, use the following command: .. code-block:: text -- cgit v1.2.3 From b31e5c9c46f4d87177b114f50328a8b0b39908be Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Thu, 17 Jan 2013 22:30:25 +0200 Subject: fix #747 --- docs/narr/install.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'docs/narr/install.rst') diff --git a/docs/narr/install.rst b/docs/narr/install.rst index a78c1b2bd..19c144156 100644 --- a/docs/narr/install.rst +++ b/docs/narr/install.rst @@ -70,7 +70,8 @@ Python interpreter to develop your software. The authors of :app:`Pyramid` tend not to use the system Python for development purposes; always a self-compiled one. Compiling Python is usually easy, and often the "system" Python is compiled with options that -aren't optimal for web development. +aren't optimal for web development. For an explanation, see +https://github.com/Pylons/pyramid/issues/747. To compile software on your UNIX system, typically you need development tools. Often these can be installed via the package -- cgit v1.2.3 From 6821582d7e691b8c068ce80ec067319c65195716 Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Wed, 30 Jan 2013 01:18:06 +0200 Subject: this obsolete info should have been removed in commit 22ed77d --- docs/narr/install.rst | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) (limited to 'docs/narr/install.rst') diff --git a/docs/narr/install.rst b/docs/narr/install.rst index 224a62db7..c467779f4 100644 --- a/docs/narr/install.rst +++ b/docs/narr/install.rst @@ -166,9 +166,7 @@ distribute is not yet installed: ImportError: No module named setuptools If ``import setuptools`` raises an :exc:`ImportError` as it does above, you -will need to install setuptools or distribute manually. Note that above -we're using a Python 2.7-series interpreter on Mac OS X; your output may -differ if you're using a later Python version or a different platform. +will need to install setuptools or distribute manually. If you are using a "system" Python (one installed by your OS distributor or a 3rd-party packager such as Fink or MacPorts), you can usually install the -- cgit v1.2.3 From bd070e77f4183a34507fe6f19604751cb78e3e8c Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Mon, 4 Feb 2013 21:15:08 +0200 Subject: unuglify Unix Python installation instructions --- docs/narr/install.rst | 20 +++++++++----------- 1 file changed, 9 insertions(+), 11 deletions(-) (limited to 'docs/narr/install.rst') diff --git a/docs/narr/install.rst b/docs/narr/install.rst index c467779f4..e18716baa 100644 --- a/docs/narr/install.rst +++ b/docs/narr/install.rst @@ -88,17 +88,15 @@ using the following commands: .. code-block:: text - [chrism@vitaminf ~]$ cd ~ - [chrism@vitaminf ~]$ mkdir tmp - [chrism@vitaminf ~]$ mkdir opt - [chrism@vitaminf ~]$ cd tmp - [chrism@vitaminf tmp]$ wget \ - http://www.python.org/ftp/python/2.7.3/Python-2.7.3.tgz - [chrism@vitaminf tmp]$ tar xvzf Python-2.7.3.tgz - [chrism@vitaminf tmp]$ cd Python-2.7.3 - [chrism@vitaminf Python-2.7.3]$ ./configure \ - --prefix=$HOME/opt/Python-2.7.3 - [chrism@vitaminf Python-2.7.3]$ make; make install + $ cd ~ + $ mkdir tmp + $ mkdir opt + $ cd tmp + $ wget http://www.python.org/ftp/python/2.7.3/Python-2.7.3.tgz + $ tar xvzf Python-2.7.3.tgz + $ cd Python-2.7.3 + $ ./configure --prefix=$HOME/opt/Python-2.7.3 + $ make && make install Once these steps are performed, the Python interpreter will be invokable via ``$HOME/opt/Python-2.7.3/bin/python`` from a shell -- cgit v1.2.3 From 148c7da017ef775932b2a4baeb0bd3057976adcc Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Mon, 4 Feb 2013 21:27:03 +0200 Subject: no need to be so specific This should reduce the frequency of needing to update it. --- docs/narr/install.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/narr/install.rst') diff --git a/docs/narr/install.rst b/docs/narr/install.rst index c467779f4..91e1cae6f 100644 --- a/docs/narr/install.rst +++ b/docs/narr/install.rst @@ -14,8 +14,8 @@ run :app:`Pyramid`. .. sidebar:: Python Versions - As of this writing, :app:`Pyramid` has been tested under Python 2.6.8, - Python 2.7.3, Python 3.2.3, and Python 3.3b1. :app:`Pyramid` does not + As of this writing, :app:`Pyramid` has been tested under Python 2.6, + Python 2.7, Python 3.2, and Python 3.3. :app:`Pyramid` does not run under any version of Python before 2.6. :app:`Pyramid` is known to run on all popular UNIX-like systems such as -- cgit v1.2.3