Commit ae2950f3 authored by Greg Ward's avatar Greg Ward

Spewed a bunch more verbiage.

Lots of scattered wording changes.
parent 9fd6e894
...@@ -78,20 +78,19 @@ Debian package for users of Debian-based Linux systems (Debian proper, ...@@ -78,20 +78,19 @@ Debian package for users of Debian-based Linux systems (Debian proper,
Caldera, Corel, etc.), and so forth. Caldera, Corel, etc.), and so forth.
In that case, you would download the installer appropriate to your In that case, you would download the installer appropriate to your
platform and do the usual thing with it: run it if it's an executable platform and do the obvious thing with it: run it if it's an executable
installer, \code{rpm -I} it if it's an RPM, etc. You don't need to run installer, \code{rpm --install} it if it's an RPM, etc. You don't need
Python or a setup script, you don't need to compile anything---you might to run Python or a setup script, you don't need to compile
not even need to read any instructions (although it's always a good idea anything---you might not even need to read any instructions (although
to do so anyways). it's always a good idea to do so anyways).
Of course, things will not always be that easy. You might be interested Of course, things will not always be that easy. You might be interested
in a module distribution that nobody has created an easy-to-use in a module distribution that doesn't have an easy-to-use installer for
installer for use on your platform. In that case, you'll have to start your platform. In that case, you'll have to start with the source
with the source distribution released by the module's distribution released by the module's author/maintainer. Installing
author/maintainer. Installing from a source distribution is not too from a source distribution is not too hard, as long as the modules are
hard, as long as the modules are packaged in the standard way. The bulk packaged in the standard way. The bulk of this document is about
of this document is about building and installing modules that were building and installing modules from standard source distributions.
packaged in the standard way.
\subsection{The new standard: Distutils} \subsection{The new standard: Distutils}
...@@ -125,15 +124,17 @@ Before the Distutils, there was no infrastructure to support installing ...@@ -125,15 +124,17 @@ Before the Distutils, there was no infrastructure to support installing
third-party modules in a consistent, standardized way. Thus, it's not third-party modules in a consistent, standardized way. Thus, it's not
really possible to write a general manual for installing Python modules really possible to write a general manual for installing Python modules
that don't use the Distutils; the only truly general statement that can that don't use the Distutils; the only truly general statement that can
be made is, ``Read the module's own documentation on installation.'' be made is, ``Read the module's own installation instructions.''
However, such documentation is often woefully inadequate, assuming that However, if such instructions exists at all, they are often woefully
you are familiar with how the Python library is laid out and will inadequate and targeted at experienced Python developers. Such users
somehow just know where to copy various files in order for Python to are already familiar with how the Python library is laid out on their
find them. Also, since there is only one way to lay out the Python platform, and know where to copy various files in order for Python to
library on a given platform, this manual is a good place to learn that find them. This document makes no such assumptions, and explains how
layout. That way, if you do have to manually install an old, the Python library is laid out on three major platforms (Unix, Windows,
pre-Distutils module distribution, you won't be completely on your own. and Mac~OS), so that you can understand what happens when the Distutils
do their job \emph{and} know how to install modules manually when the
module author fails to provide a setup script.
Additionally, while there has not previously been a standard Additionally, while there has not previously been a standard
installation mechanism, Python has had some standard machinery for installation mechanism, Python has had some standard machinery for
...@@ -158,8 +159,8 @@ a module distribution using the Distutils is usually one simple command: ...@@ -158,8 +159,8 @@ a module distribution using the Distutils is usually one simple command:
python setup.py install python setup.py install
\end{verbatim} \end{verbatim}
On Unix, you'd run this command from a shell prompt; on Windows, you On Unix, you'd run this command from a shell prompt; on Windows, you
have to open a command prompt window and do it there; on Mac OS ... have to open a command prompt window and do it there; on Mac~OS ...
\XXX{what the heck do you do on Mac OS?}. \XXX{what the heck do you do on Mac~OS?}.
\subsection{Platform variations} \subsection{Platform variations}
...@@ -175,17 +176,20 @@ cd foo-1.0 ...@@ -175,17 +176,20 @@ cd foo-1.0
python setup.py install python setup.py install
\end{verbatim} \end{verbatim}
On Windows, you'd probably unpack the archive before opening the command On Windows, you'd probably unpack the archive before opening the command
prompt. If you downloaded the archive file to \file{C:\bslash{}Temp}, then prompt. If you downloaded the archive file to \file{C:\bslash{}Temp},
it probably unpacked (depending on your software) into then it probably unpacked (depending on your software) into
\file{C:\bslash{}Temp\bslash{}foo-1.0}; from the command prompt window, you would \file{C:\bslash{}Temp\bslash{}foo-1.0}; from the command prompt window,
then run you would then run
\begin{verbatim} \begin{verbatim}
cd c:\temp\foo-1.0 cd c:\temp\foo-1.0
python setup.py install python setup.py install
\end{verbatim} \end{verbatim}
On Mac OS, ... \XXX{again, how do you run Python scripts on Mac OS?} On Mac~OS, ... \XXX{again, how do you run Python scripts on Mac~OS?}
\XXX{arg, my lovely ``bslash'' macro doesn't work in non-tt fonts! help
me \LaTeX, you're my only hope...}
\subsection{Splitting the job up} \subsection{Splitting the job up}
...@@ -202,27 +206,119 @@ python setup.py build ...@@ -202,27 +206,119 @@ python setup.py build
python setup.py install python setup.py install
\end{verbatim} \end{verbatim}
(If you do this, you will notice that running the \command{install} (If you do this, you will notice that running the \command{install}
command first runs the \command{build} command, which will quickly command first runs the \command{build} command, which quickly notices
notice that it has nothing to do, since everything in the \file{build} that it has nothing to do, since everything in the \file{build}
directory is up-to-date. directory is up-to-date.)
% This will cover: \XXX{concrete reason for splitting things up?}
% * setup.py install (the usual thing)
% * setup.py build (if you like doing things one-at-a-time)
% * setup.py build install (not necessary unless you need to supply \subsection{How building works}
% build options--ref. next section)
% * where things are installed, on Unix and Windows (Mac...?) As implied above, the \command{build} command is responsible for putting
% * simple custom install: "install --prefix=$HOME" the files to install into a \emph{build directory}. By default, this is
\comingsoon \file{build} under the distribution root; if you're excessively
concerned with speed, or want to keep the source tree pristine, you can
change the build directory with the \option{--build-base} option. For
example:
% takes eight args (four pairs): \begin{verbatim}
% pure module distribution base + directory python setup.py build --build-base=/tmp/pybuild/foo-1.0
% non-pure module distribution base + directory \end{verbatim}
% script base + directory (Or you could do this permanently with a directive in your system or
% data base + directory personal Distutils configuration file; see
% ...and will no doubt take more args in future! section~\ref{sec:config-files}.) Normally, this isn't necessary.
The default layout for the build tree is as follows:
\begin{verbatim}
--- build/ --- lib/
or
--- build/ --- lib.<plat>/
temp.<plat>/
\end{verbatim}
where \code{<plat>} expands to a brief description of the current
OS/hardware platform. The first form, with just a \file{lib} directory,
is used for ``pure module distributions''---that is, module
distributions that include only pure Python modules. If a module
distribution contains any extensions (modules written in C/C++, or Java
for JPython), then the second form, with two \code{<plat>} directories,
is used. In that case, the \file{temp.\filevar{plat}} directory holds
temporary files generated by the compile/link process that don't
actually get installed. In either case, the \file{lib} (or
\file{lib.\filevar{plat}}) directory contains all Python modules (pure
Python and extensions) that will be installed.
In the future, more directories will be added to handle Python scripts,
documentation, binary executables, and whatever else is needed to handle
the job of installing Python modules and applicatins.
\subsection{How installation works}
After the \command{build} command runs (whether you run it explicitly,
or the \command{install} command does it for you), the work of the
\command{install} command is relatively simple: all it has to do is copy
everything under \file{build/lib} (or \file{build/lib.\filevar{plat}})
to your chosen installation directory.
If you don't choose an installation directory---i.e., if you just run
\code{setup.py install}---then the \command{install} command installs to
the standard location for third-party Python modules. This location
varies by platform and by how you built/installed Python itself. On
Unix and Mac OS, it also depends on whether the module distribution
being installed is pure Python or contains extensions (``non-pure''):
\begin{tableiii}{lll}{textrm}%
{Platform}{Standard installation location}{Default value}
\lineiii{Unix (pure Python modules)}
{\file{\filevar{prefix}/lib/python1.6/site-packages}}
{\file{/usr/local/lib/python1.6/site-packages}}
\lineiii{Unix (non-pure distribution)}
{\file{\filevar{exec-prefix}/lib/python1.6/site-packages}}
{\file{/usr/local/lib/python1.6/site-packages}}
\lineiii{Windows}
{\filevar{prefix}}
{\file{C:\bslash{}Python}
\footnote{\file{C:\bslash{}Program Files\bslash{}Python}
under Python 1.6a1 and earlier}}
\lineiii{Mac~OS (pure Python modules)}
{\file{\filevar{prefix}}:Lib}
{\file{Python:Lib}\XXX{???}}
\lineiii{Mac~OS (non-pure distribution)}
{\file{\filevar{prefix}}:Mac:PlugIns}
{\file{Python:Mac:PlugIns}\XXX{???}}
\end{tableiii}
\filevar{prefix} and \filevar{exec-prefix} stand for the directories
that Python is installed to, and where it finds its libraries at
run-time. They are always the same under Windows and Mac~OS, and very
often the same under Unix. You can find out what your Python
installation uses for \filevar{prefix} and \filevar{exec-prefix} by
running Python in interactive mode and typing a few simple commands.
Under Unix, just type \code{python} at the shell prompt; under Windows,
run ``Python 1.6 (interpreter)'' \XXX{right?}; under Mac~OS, \XXX{???}.
Once the interpreter is started, you type Python code at the \code{>>>}
prompt. For example, on my Linux system, I type the three Python
statements shown below, and get the output as shown, to find out my
\filevar{prefix} and \filevar{exec-prefix}:
\begin{verbatim}
Python 1.5.2 (#1, Apr 18 1999, 16:03:16) [GCC pgcc-2.91.60 19981201 (egcs-1.1.1 on linux2
Copyright 1991-1995 Stichting Mathematisch Centrum, Amsterdam
>>> import sys
>>> sys.prefix
'/usr'
>>> sys.exec_prefix
'/usr'
\end{verbatim}
If you don't want to install to the standard location, or if you don't
have permission to write there, then you need to read about alternate
installations in the next section.
% This rather nasty macro is used to generate the tables that describe
% each installation scheme. It's nasty because it takes two arguments
% for each "slot" in an installation scheme, there will soon be more
% than five of these slots, and TeX has a limit of 10 arguments to a
% macro. Uh-oh.
\newcommand{\installscheme}[8] \newcommand{\installscheme}[8]
{\begin{tableiii}{lll}{textrm} {\begin{tableiii}{lll}{textrm}
{Type of file} {Type of file}
...@@ -230,21 +326,18 @@ directory is up-to-date. ...@@ -230,21 +326,18 @@ directory is up-to-date.
{Override option} {Override option}
\lineiii{pure module distribution} \lineiii{pure module distribution}
{\filevar{#1}\filenq{#2}} {\filevar{#1}\filenq{#2}}
{\option{install-purelib}} {\option{--install-purelib}}
\lineiii{non-pure module distribution} \lineiii{non-pure module distribution}
{\filevar{#3}\filenq{#4}} {\filevar{#3}\filenq{#4}}
{\option{install-platlib}} {\option{--install-platlib}}
\lineiii{scripts} \lineiii{scripts}
{\filevar{#5}\filenq{#6}} {\filevar{#5}\filenq{#6}}
{\option{install-scripts}} {\option{--install-scripts}}
\lineiii{data} \lineiii{data}
{\filevar{#7}\filenq{#8}} {\filevar{#7}\filenq{#8}}
{\option{install-data}} {\option{--install-data}}
\end{tableiii}} \end{tableiii}}
\section{Alternate Installation} \section{Alternate Installation}
\label{sec:alt-install} \label{sec:alt-install}
...@@ -271,25 +364,22 @@ of the following section applies to you. ...@@ -271,25 +364,22 @@ of the following section applies to you.
Under Unix, there are two ways to perform an alternate installation. Under Unix, there are two ways to perform an alternate installation.
The ``prefix scheme'' is similar to how alternate installation works The ``prefix scheme'' is similar to how alternate installation works
under Windows and Mac OS, but is not necessarily the most useful way to under Windows and Mac~OS, but is not necessarily the most useful way to
maintain a personal Python library. Hence, we document the more maintain a personal Python library. Hence, we document the more
convenient and commonly useful ``home scheme'' first. convenient and commonly useful ``home scheme'' first.
The idea behind the ``home scheme'' is that you are building and The idea behind the ``home scheme'' is that you build and maintain a
maintaining a personal stash of Python modules, probably under your home personal stash of Python modules, probably under your home directory.
directory. Installing a new module distribution is as simple as Installing a new module distribution is as simple as
\begin{verbatim}
python setup.py install --home # arg, doesn't work (getopt)
\end{verbatim}
or
\begin{verbatim} \begin{verbatim}
python setup.py install --home=<dir> python setup.py install --home=<dir>
\end{verbatim} \end{verbatim}
where you can supply any directory you like for the \option{home} where you can supply any directory you like for the \option{home}
option. If you don't supply a directory (as in the first example option. Lazy typists can just type a tilde (\code{\tilde}); the
above), the \command{install} command uses the \code{HOME} environment \command{install} command will expand this to your home directory:
variable (or your official home directory as supplied by the password \begin{verbatim}
file, if \code{HOME} is not defined). python setup.py install --home=~
\end{verbatim}
The \option{home} option defines the installation base directory. Files The \option{home} option defines the installation base directory. Files
are installed to the following directories under the installation base are installed to the following directories under the installation base
...@@ -363,10 +453,10 @@ header files (\file{Python.h} and friends) installed with the Python ...@@ -363,10 +453,10 @@ header files (\file{Python.h} and friends) installed with the Python
interpreter used to run the setup script will be used in compiling interpreter used to run the setup script will be used in compiling
extensions. It is your responsibility to ensure that the interpreter extensions. It is your responsibility to ensure that the interpreter
used to run extensions installed in this way is compatibile with the used to run extensions installed in this way is compatibile with the
interpreter used to build them. The best way to ensure this is that the interpreter used to build them. The best way to do this is to ensure
two interpreters are the same version of Python (possibly different that the two interpreters are the same version of Python (possibly
builds, or possibly copies of the same build). (Of course, if your different builds, or possibly copies of the same build). (Of course, if
\option{prefix} and \option{exec-prefix} don't even point to an your \option{prefix} and \option{exec-prefix} don't even point to an
alternate Python installation, this is immaterial.) alternate Python installation, this is immaterial.)
...@@ -393,10 +483,10 @@ installed as follows: ...@@ -393,10 +483,10 @@ installed as follows:
{prefix}{\bslash{}Data} {prefix}{\bslash{}Data}
\subsection{Alternate installation: Mac OS} \subsection{Alternate installation: Mac~OS}
\label{sec:alt-macos} \label{sec:alt-macos}
Like Windows, Mac OS has no notion of home directories (or even of Like Windows, Mac~OS has no notion of home directories (or even of
users), and a fairly simple standard Python installation. Thus, only a users), and a fairly simple standard Python installation. Thus, only a
\option{prefix} option is needed. It defines the installation base, and \option{prefix} option is needed. It defines the installation base, and
files are installed under it as follows: files are installed under it as follows:
...@@ -478,13 +568,13 @@ Python's module search path, e.g. by putting a \file{.pth} file in ...@@ -478,13 +568,13 @@ Python's module search path, e.g. by putting a \file{.pth} file in
If you want to define an entire installation scheme, you just have to If you want to define an entire installation scheme, you just have to
supply all of the installation directory options. The recommended way supply all of the installation directory options. The recommended way
to do this is to supply relative paths; for example, if want to maintain to do this is to supply relative paths; for example, if you want to
all Python module-related files under \file{python} in your home maintain all Python module-related files under \file{python} in your
directory, and you want a separate directory for each platform that you home directory, and you want a separate directory for each platform that
use your home directory from, you might define the following you use your home directory from, you might define the following
installation scheme: installation scheme:
\begin{verbatim} \begin{verbatim}
python setup.py install --home \ python setup.py install --home=~ \
--install-purelib=python/lib \ --install-purelib=python/lib \
--install-platlib=python/lib.$PLAT \ --install-platlib=python/lib.$PLAT \
--install-scripts=python/scripts --install-scripts=python/scripts
...@@ -536,27 +626,29 @@ case, you probably want to supply an installation base of ...@@ -536,27 +626,29 @@ case, you probably want to supply an installation base of
You probably noticed the use of \code{\$HOME} and \code{\$PLAT} in the You probably noticed the use of \code{\$HOME} and \code{\$PLAT} in the
sample configuration file input. These are Distutils configuration sample configuration file input. These are Distutils configuration
variables, which bear a strong resemblance to environment variables. In variables, which bear a strong resemblance to environment variables. In
fact, you can use environment variables in config files, but the fact, you can use environment variables in config files---on platforms
Distutils additionally define a few extra variables that may not be in that have such a notion---but the Distutils additionally define a few
your environment, such as \code{\$PATH}. See extra variables that may not be in your environment, such as
\code{\$PLAT}. (And of course, you can only use the configuration
variables supplied by the Distutils on systems that don't have
environment variables, such as Mac~OS (\XXX{true?}).) See
section~\ref{sec:config-files} for details. section~\ref{sec:config-files} for details.
\XXX{need some Windows and Mac OS examples---when would custom \XXX{need some Windows and Mac~OS examples---when would custom
installation schemes be needed on those platforms?} installation schemes be needed on those platforms?}
\section{Distutils Configuration Files} \section{Distutils Configuration Files}
\label{sec:config-files} \label{sec:config-files}
\comingsoon \XXX{not even implemented yet, much less documented!}
\section{Pre-Distutils Conventions} \section{Pre-Distutils Conventions}
\label{sec:pre-distutils} \label{sec:pre-distutils}
\subsection{The \protect\file{Makefile.pre.in} file} \subsection{The Makefile.pre.in file}
\label{sec:makefile-pre-in} \label{sec:makefile-pre-in}
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment