diff options
Diffstat (limited to 'docs/narr/install.rst')
| -rw-r--r-- | docs/narr/install.rst | 121 |
1 files changed, 57 insertions, 64 deletions
diff --git a/docs/narr/install.rst b/docs/narr/install.rst index f23b3c819..e4eb284f9 100644 --- a/docs/narr/install.rst +++ b/docs/narr/install.rst @@ -7,11 +7,11 @@ Before You Install ------------------ You will need `Python <http://python.org>`_ version 2.4 or better to -run :mod:`repoze.bfg`. It has been tested under Python 2.4.5, Python -2.5.2 and Python 2.6. Development of :mod:`repoze.bfg` is currently -done primarily under Python 2.4 and Python 2.5. :mod:`repoze.bfg` -does *not* run under any version of Python before 2.4, and does *not* -run under Python 3.X. +run :mod:`repoze.bfg`. It has been tested under Python 2.4.6, Python +2.5.4 and Python 2.6.2, and Python 2.7a1. Development of +:mod:`repoze.bfg` is currently done primarily under Python 2.4 and +Python 2.5. :mod:`repoze.bfg` does *not* run under any version of +Python before 2.4, and does *not* run under Python 3.X. .. sidebar:: You Don't Need A Compiler @@ -21,24 +21,15 @@ run under Python 3.X. development tools installed on the target machine to install :mod:`repoze.bfg`. -BFG is known to run properly on all popular Unix-like systems such as -Linux, MacOS X, and FreeBSD. +:mod:`repoze.bfg` is known to run properly on all popular Unix-like +systems such as Linux, MacOS X, and FreeBSD. :mod:`repoze.bfg` is +also known to run on Windows systems. However, none of its developers +use Windows as a primary development platform. It is also known to +run on Google's App Engine. -:mod:`repoze.bfg` is also known to run on Windows systems. However, -none of its developers use Windows as a primary development platform. -Therefore, most of the platform-specific documentation (excepting this -chapter) assumes you're using a UNIX system. If you're using a Windows -system, you'll need to transliterate command lines in the -documentation to their Windows equivalents. - -:mod:`repoze.bfg` is also known to run on Google's App Engine. - -It is not known whether :mod:`repoze.bfg` will or will not run under -Jython or IronPython. - -.. note:: If you'd like to help make sure :mod:`repoze.bfg` keeps - running on your favorite alternate platform, we'd love to hear from - you. Please contact us via the `repoze.dev maillist +.. note:: If you'd like to help us make sure :mod:`repoze.bfg` runs on + your favorite alternate platform, we'd love to hear from you. + Please contact us via the `repoze.dev maillist <http://lists.repoze.org/listinfo/repoze-dev>`_ if you'd like to contribute. @@ -61,9 +52,9 @@ For example, on an Ubuntu Linux system, to use the system package manager to install a Python 2.5 interpreter, use the following command: -.. code-block:: bash +.. code-block:: text - $ sudo apt-get install python2.5-dev + $ sudo apt-get install python2.5-dev Once these steps are performed, the Python interpreter will usually be invokable via ``python2.5`` from a shell prompt. @@ -82,9 +73,9 @@ To compile software on your UNIX system, typically you need development tools. Often these can be installed via the package manager. For example, this works to do so on an Ubuntu Linux system: -.. code-block:: bash +.. code-block:: text - $ sudo apt-get install build-essential + $ sudo apt-get install build-essential On Mac OS X, installing XCode has much the same effect. @@ -92,18 +83,19 @@ Once you've got development tools installed on your system, On the same system, to install a Python 2.5 interpreter from *source*, use the following commands: -.. code-block:: bash +.. code-block:: text + :linenos: - [chrism@vitaminf ~]$ cd ~ - [chrism@vitaminf ~]$ mkdir tmp - [chrism@vitaminf ~]$ mkdir opt - [chrism@vitaminf ~]$ cd tmp - [chrism@vitaminf tmp]$ cd tmp - [chrism@vitaminf tmp]$ wget http://python.org/ftp/python/2.5.4/Python-2.5.4.tgz - [chrism@vitaminf tmp]$ tar xvzf Python-2.5.4.tgz - [chrism@vitaminf tmp]$ cd Python-2.5.4 - [chrism@vitaminf Python-2.5.4]$ ./configure --prefix=$HOME/opt/Python-2.5.4 - [chrism@vitaminf Python-2.5.4]$ make; make install + [chrism@vitaminf ~]$ cd ~ + [chrism@vitaminf ~]$ mkdir tmp + [chrism@vitaminf ~]$ mkdir opt + [chrism@vitaminf ~]$ cd tmp + [chrism@vitaminf tmp]$ cd tmp + [chrism@vitaminf tmp]$ wget http://python.org/ftp/python/2.5.4/Python-2.5.4.tgz + [chrism@vitaminf tmp]$ tar xvzf Python-2.5.4.tgz + [chrism@vitaminf tmp]$ cd Python-2.5.4 + [chrism@vitaminf Python-2.5.4]$ ./configure --prefix=$HOME/opt/Python-2.5.4 + [chrism@vitaminf Python-2.5.4]$ make; make install Once these steps are performed, the Python interpreter will be invokable via ``$HOME/opt/Python-2.5.4/bin/python`` from a shell @@ -135,13 +127,14 @@ ensure that :term:`setuptools` is installed. Invoke ``import setuptools`` within the Python interpreter you'd like to run :mod:`repoze.bfg` under: -.. code-block:: bash +.. code-block:: text + :linenos: - [chrism@vitaminf bfg]$ python - Python 2.4.5 (#1, Aug 29 2008, 12:27:37) - [GCC 4.0.1 (Apple Inc. build 5465)] on darwin - Type "help", "copyright", "credits" or "license" for more information. - >>> import setuptools + [chrism@vitaminf bfg]$ python + Python 2.4.5 (#1, Aug 29 2008, 12:27:37) + [GCC 4.0.1 (Apple Inc. build 5465)] on darwin + Type "help", "copyright", "credits" or "license" for more information. + >>> import setuptools If ``import setuptools`` does not raise an ``ImportError``, it means that setuptools is already installed into your Python interpreter. If @@ -161,18 +154,18 @@ To install setuptools by hand, first download `ez_setup.py <http://peak.telecommunity.com/dist/ez_setup.py>`_ then invoke it using the Python interpreter you want to install setuptools into. -.. code-block:: bash +.. code-block:: text - $ sudo python ez_setup.py + $ sudo python ez_setup.py Once this command is invoked, setuptools should be installed on your system. If the command fails due to permission errors, you may need to be the administrative user on your system to successfully invoke the script. To remediate this, you may need to do: -.. code-block:: bash +.. code-block:: text - $ sudo python ez_setup.py + $ sudo python ez_setup.py Installing the ``virtualenv`` Package ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -182,17 +175,17 @@ Once you've got setuptools installed, you should install the into your setuptools-enabled Python interpreter, use the ``easy_install`` command. -.. code-block:: bash +.. code-block:: text - $ easy_install virtualenv + $ easy_install virtualenv This command should succeed, and tell you that the virtualenv package is now installed. If it fails due to permission errors, you may need to install it as your system's administrative user. For example: -.. code-block:: bash +.. code-block:: text - $ sudo easy_install virtualenv + $ sudo easy_install virtualenv Creating the Virtual Python Environment ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -201,7 +194,7 @@ Once the :term:`virtualenv` package is installed in your Python, you can actually create a virtual environment. To do so, invoke the following: -.. code-block:: bash +.. code-block:: text :linenos: $ virtualenv --no-site-packages bfgenv @@ -231,7 +224,7 @@ After you've got your ``bfgenv`` virtualenv installed, you may install :mod:`repoze.bfg` itself using the following commands from within the virtualenv (``bfgenv``) directory: -.. code-block:: bash +.. code-block:: text :linenos: $ bin/easy_install -i http://dist.repoze.org/bfg/1.1/simple repoze.bfg @@ -250,33 +243,33 @@ Installing :mod:`repoze.bfg` on a Windows System pick the right download for Python 2.5 and install it using the same Python installation from the previous step. -#. Install latest `setuptools` into the Python you +#. Install latest :term:`setuptools` distribution into the Python you obtained/installed/found in the step above: download `ez_setup.py <http://peak.telecommunity.com/dist/ez_setup.py>`_ and run it using the ``python`` interpreter of your Python 2.5 installation using a command prompt: - .. code-block:: bat + .. code-block:: text - c:\> c:\Python25\python ez_setup.py + c:\> c:\Python25\python ez_setup.py #. Use that Python's `bin/easy_install` to install `virtualenv`: - .. code-block:: bat + .. code-block:: text - c:\> c:\Python25\Scripts\easy_install virtualenv + c:\> c:\Python25\Scripts\easy_install virtualenv #. Use that Python's virtualenv to make a workspace: - .. code-block:: bat + .. code-block:: text - c:\> c:\Python25\Scripts\virtualenv --no-site-packages bfgenv + c:\> c:\Python25\Scripts\virtualenv --no-site-packages bfgenv #. Switch to the ``bfgenv`` directory: - .. code-block:: bat + .. code-block:: text - c:\> cd bfgenv + c:\> cd bfgenv #. (Optional) Consider using ``bin\activate.bat`` to make your shell environment wired to use the virtualenv. @@ -284,9 +277,9 @@ Installing :mod:`repoze.bfg` on a Windows System #. Use ``easy_install`` and point to the BFG "1.1" index to get BFG and its direct dependencies installed: - .. code-block:: bat + .. code-block:: text - c:\bfgenv> Scripts\easy_install -i http://dist.repoze.org/bfg/1.1/simple repoze.bfg + c:\bfgenv> Scripts\easy_install -i http://dist.repoze.org/bfg/1.1/simple repoze.bfg Installing :mod:`repoze.bfg` on Google App Engine ------------------------------------------------- |