Updates for distutils package.

This commit is contained in:
Barry Warsaw 2004-10-03 03:57:37 +00:00
parent 2ec4854f13
commit 43790b4b21
1 changed files with 8 additions and 36 deletions

View File

@ -9,7 +9,7 @@
\title{email Package Reference}
\author{Barry Warsaw}
\authoraddress{\email{barry@zope.com}}
\authoraddress{\email{barry@python.org}}
\date{\today}
\release{2.5} % software release, not documentation
@ -38,19 +38,12 @@ The \module{email} package provides classes and utilities to create,
parse, generate, and modify email messages, conforming to all the
relevant email and MIME related RFCs.
This document describes the current version of the \module{email}
package, which is available to Python programmers in a number of ways.
Python 2.2.2 and 2.3 come with \module{email} version 2, while earlier
versions of Python 2.2.x come with \module{email} version 1. Python
2.1.x and earlier do not come with any version of the \module{email}
package.
The \module{email} package is also available as a standalone distutils
package, and is compatible with Python 2.1.3 and beyond. Thus, if
you're using Python 2.1.3 you can download the standalone package and
install it in your \file{site-packages} directory. The standalone
\module{email} package is available on the
\ulink{SourceForge \module{mimelib} project}{http://mimelib.sf.net}.
This document describes version 3.0 of the \module{email} package, which is
distributed with Python 2.4 and is availble as a standalone distutils-based
package for use with Python 2.3. \module{email} 3.0 is not compatible with
Python versions earlier than 2.3. For more information about the
\module{email} package, including download links and mailing lists, see
\ulink{Python's email SIG}{http://www.python.org/sigs/email-sig}.
The documentation that follows was written for the Python project, so
if you're reading this as part of the standalone \module{email}
@ -58,28 +51,7 @@ package documentation, there are a few notes to be aware of:
\begin{itemize}
\item Deprecation and ``version added'' notes are relative to the
Python version a feature was added or deprecated. To find out
what version of the \module{email} package a particular item was
added, changed, or removed, refer to the package's
\ulink{\file{NEWS} file}{http://cvs.sf.net/cgi-bin/viewcvs.cgi/mimelib/mimelib/NEWS?rev=1.36&content-type=text/vnd.viewcvs-markup}.
\item The code samples are written with Python 2.2 in mind. For
Python 2.1.3, some adjustments are necessary. For example, this
code snippet;
\begin{verbatim}
if isinstance(s, str):
# ...
\end{verbatim}
would need to be written this way in Python 2.1.3:
\begin{verbatim}
from types import StringType
# ...
if isinstance(s, StringType):
# ...
\end{verbatim}
Python version a feature was added or deprecated.
\item If you're reading this documentation as part of the
standalone \module{email} package, some of the internal links to