[Python-checkins] distutils2 (merge default -> python3): Merge default
eric.araujo
python-checkins at python.org
Mon May 21 23:03:36 CEST 2012
http://hg.python.org/distutils2/rev/1eff97fce288
changeset: 1349:1eff97fce288
branch: python3
parent: 1291:7d1a7251d771
parent: 1344:70831fde0ec4
user: Éric Araujo <merwok at netwok.org>
date: Mon May 21 16:54:12 2012 -0400
summary:
Merge default
files:
.hgignore | 17 +-
.hgsigs | 1 +
.hgtags | 1 +
CHANGES.txt | 25 +-
CONTRIBUTORS.txt | 6 +
DEVNOTES.txt | 8 +-
MANIFEST.in | 1 -
README.txt | 2 +-
distutils2/__init__.py | 2 +-
distutils2/_trove.py | 11 +-
distutils2/command/build_scripts.py | 15 +-
distutils2/command/cmd.py | 16 +-
distutils2/command/register.py | 1 +
distutils2/compiler/msvc9compiler.py | 2 +-
distutils2/compiler/msvccompiler.py | 2 +-
distutils2/database.py | 94 +-
distutils2/install.py | 32 +-
distutils2/metadata.py | 33 +-
distutils2/pypi/simple.py | 4 +-
distutils2/pypi/wrapper.py | 5 +-
distutils2/run.py | 42 +-
distutils2/tests/requires.txt | 15 +
distutils2/tests/support.py | 8 +-
distutils2/tests/test_command_bdist.py | 15 +-
distutils2/tests/test_command_build_scripts.py | 71 +-
distutils2/tests/test_command_register.py | 26 +-
distutils2/tests/test_database.py | 70 +-
distutils2/tests/test_install.py | 26 +-
distutils2/tests/test_metadata.py | 37 +-
distutils2/tests/test_msvc9compiler.py | 2 +-
distutils2/tests/test_pypi_wrapper.py | 37 +
distutils2/tests/test_run.py | 95 +-
distutils2/tests/test_util.py | 57 +-
distutils2/tests/test_version.py | 10 +-
distutils2/util.py | 80 +
distutils2/version.py | 18 +-
docs/Makefile | 89 -
docs/design/configfile.rst | 131 -
docs/design/pep-0376.txt | 687 ---
docs/design/wiki.rst | 620 ---
docs/make.bat | 113 -
docs/source/_static/depgraph_big.png | Bin
docs/source/conf.py | 199 -
docs/source/contributing.rst | 25 -
docs/source/devresources.rst | 49 -
docs/source/distutils/apiref.rst | 2010 ----------
docs/source/distutils/builtdist.rst | 452 --
docs/source/distutils/commandhooks.rst | 31 -
docs/source/distutils/commandref.rst | 58 -
docs/source/distutils/configfile.rst | 130 -
docs/source/distutils/examples.rst | 332 -
docs/source/distutils/extending.rst | 95 -
docs/source/distutils/index.rst | 33 -
docs/source/distutils/introduction.rst | 193 -
docs/source/distutils/newcommands.rst | 144 -
docs/source/distutils/packageindex.rst | 104 -
docs/source/distutils/setupscript.rst | 681 ---
docs/source/distutils/sourcedist.rst | 270 -
docs/source/distutils/uploading.rst | 80 -
docs/source/images/depgraph_output.png | Bin
docs/source/index.rst | 89 -
docs/source/install/index.rst | 988 ----
docs/source/library/distutils2.depgraph.rst | 122 -
docs/source/library/distutils2.index.client.rst | 20 -
docs/source/library/distutils2.index.dist.rst | 106 -
docs/source/library/distutils2.index.rst | 31 -
docs/source/library/distutils2.index.simple.rst | 141 -
docs/source/library/distutils2.index.xmlrpc.rst | 124 -
docs/source/library/distutils2.install.rst | 23 -
docs/source/library/distutils2.metadata.rst | 93 -
docs/source/library/distutils2.rst | 44 -
docs/source/library/distutils2.tests.pypi_server.rst | 89 -
docs/source/library/distutils2.version.rst | 69 -
docs/source/library/pkgutil.rst | 330 -
docs/source/setupcfg-spec.rst | 308 -
docs/source/setupcfg.rst | 544 --
docs/source/tutorial.rst | 129 -
setup.cfg | 26 +-
setup.py | 2 +-
tox.ini | 22 +-
80 files changed, 664 insertions(+), 10049 deletions(-)
diff --git a/.hgignore b/.hgignore
--- a/.hgignore
+++ b/.hgignore
@@ -1,18 +1,15 @@
syntax: glob
*.py[co]
__pycache__/
-*.so
-configure.cache
+*.swp
+bin/
+include/
+lib/
+man/
+Distutils2.egg-info
MANIFEST
build/
dist/
-_static/
-_build/
-*.swp
+.tox/
.coverage
-.tox
-lib
-include
-bin
nosetests.xml
-Distutils2.egg-info
diff --git a/.hgsigs b/.hgsigs
new file mode 100644
--- /dev/null
+++ b/.hgsigs
@@ -0,0 +1,1 @@
+27910fcea9ed851af1f932caa58fdc0f811b748f 0 iEYEABECAAYFAk9fbhkACgkQ8s4Pc9+KtnaVdACfTNegvVs1BXtKgM+oAq/9gsuZtGwAnA04B7Zc/ICRkbpejyS4xzPTv8jw
diff --git a/.hgtags b/.hgtags
--- a/.hgtags
+++ b/.hgtags
@@ -5,3 +5,4 @@
7c8e61aa51f4748286964bc1405bd4169c270f46 1.0a3
7c8e61aa51f4748286964bc1405bd4169c270f46 1.0a3
d930ae6caab58bec92683235aa88d06bbc07ae36 1.0a3
+1e4d52d83e95c14e3f0bd2179a81ac1023ef32e9 1.0a4
diff --git a/CHANGES.txt b/CHANGES.txt
--- a/CHANGES.txt
+++ b/CHANGES.txt
@@ -8,8 +8,21 @@
(and last name initial when needed) are given for each item; see
CONTRIBUTORS.txt for full names. Bug numbers refer to http://bugs.python.org/.
+1.0a5 - 2012-xx-xx
+------------------
-1.0a4 - 2012-02-??
+- #14294: Let Metadata convert setuptools-style requires.txt [preston]
+- #14270: Add dest_dir parameter to install functions [mathieu]
+- #13166: Add __str__ to database.*Distribution for nicer output [guillaume]
+- #13614: Fix register failure with invalid rst in description [julien c,
+ mathieu, pierre paul, éric]
+- #13399: Display error message instead of unhandled traceback for missing
+ actions, commands and options [patrice]
+- #10374: Recreate scripts everytime build_scripts is called [pierre paul]
+- #14733: Have pysetup read setup.cfg early enough to find custom commands
+ [éric, janusz]
+
+1.0a4 - 2012-03-13
------------------
- Remove type check for commands in favor of minimal duck type check [tarek]
@@ -111,8 +124,8 @@
guillermoo, éric]
- Add 'pysetup generate-setup' to expose util.generate_setup_py [tarek]
- #11092: Make sdist always include setup.cfg [éric]
-- #12246: Don’t try to install something when running from an uninstalled Python
- built in its checkout [tschepang, éric]
+- #12246: Don't try to install something when running from an uninstalled Python
+ built in its checkout [tshepang, éric]
- Add packaging.util.split_multiline [julien m, erik]
- #11595: Fix assorted bugs in packaging.util.cfg_to_args [erik, éric]
- #12240: Allow multiple setup hooks [erik, éric]
@@ -169,6 +182,12 @@
- #13974: add test for util.set_platform [tshepang]
- #6884: Fix MANIFEST.in parsing bugs on Windows [éric, nadeem]
- #11841: Fix comparison bug with 'rc' versions [filip]
+- #14263: Fix function name lookup in d2.pypi.wrapper [tarek]
+- #14264: Stop removing trailing zeroes in versions [tarek]
+- #14268: Fix small error in a test [tarek]
+- Drop support for Python 2.4 [tarek, éric]
+- #13009: Out-of-date documentation removed, people should look at
+ http://docs.python.org/dev/packaging [éric]
1.0a3 - 2010-10-08
diff --git a/CONTRIBUTORS.txt b/CONTRIBUTORS.txt
--- a/CONTRIBUTORS.txt
+++ b/CONTRIBUTORS.txt
@@ -20,6 +20,7 @@
- Francisco Martín Brugué
- Nicolas Cadou
- Godefroid Chapelle
+- Julien Courteau
- Christophe Combelles
- Jason R. Coombs
- Pierre-Yves David
@@ -31,19 +32,23 @@
- Boris Feld
- Andrew Francis
- Hallvard B Furuseth
+- Patrice Gauthier
- Yannick Gingras
- Filip Gruszczyński
- Walker Hale IV
- Alexandre Hamelin
- Kelsey Hightower
- Thomas Holmes
+- Preston Holmes
- Christian Hudon
- Julien Jehannet
- Jeremy Kloth
- Amos Latteier
- Mathieu Leduc-Hamel
+- Pierre Paul Lefebvre
- Tshepang Lekhonkhobe
- Alain Leufroy
+- Janusz Lewandowski
- Martin von Löwis
- Hugo Lopes Tavares
- Guillermo López-Anglada
@@ -59,6 +64,7 @@
- Gaël Pasgrimaud
- George Peristerakis
- Mathieu Perreault
+- Guillaume Pratte
- Sean Reifschneider
- Antoine Reversat
- Arc Riley
diff --git a/DEVNOTES.txt b/DEVNOTES.txt
--- a/DEVNOTES.txt
+++ b/DEVNOTES.txt
@@ -11,7 +11,7 @@
Repo: http://hg.python.org/cpython (default branch)
More info: http://wiki.python.org/moin/Distutils/Contributing
-- Distutils2 runs on Python from 2.4 to 2.7, so make sure you don't use code
+- Distutils2 runs on Python from 2.5 to 2.7, so make sure you don't use code
that doesn't work under one of these Python versions. The version in the
"python3" branch is compatible with all version from 3.1 to 3.3.
@@ -21,12 +21,8 @@
have a look or use a diff tool with the same file in distutils or packaging
from Python 3.3. If you can't run tests, let someone else do the merge.
-- For 2.4, you need to run "python2.4 setup.py build" before you can try out
- pysetup or run tests (unless you use the runtests.py script which will call
- "setup.py build" automatically).
-
- Always run tests.sh before you commit a change. This implies that you have
- all Python versions installed from 2.4 to 2.7, as well as 3.1-.3.3 if you
+ all Python versions installed from 2.5 to 2.7, as well as 3.1-.3.3 if you
merge into the python3 branch. Be sure to also have docutils installed on all
Python versions to avoid skipping tests.
diff --git a/MANIFEST.in b/MANIFEST.in
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -1,2 +1,1 @@
-recursive-include docs *.bat *.rst *.py *.png Makefile *.txt
recursive-include distutils2/_backport *.c *.h *.cfg
diff --git a/README.txt b/README.txt
--- a/README.txt
+++ b/README.txt
@@ -10,7 +10,7 @@
- Developers of packaging-related tools who need a support library to
build on
-Authors will have to write a :file:`setup.cfg` file and run a few
+Authors will have to write a ``setup.cfg`` file and run a few
commands to package and distribute their code. End users will be able to
search for, install and remove Python projects with the included
``pysetup`` program. Last, developers will be able to reuse classes and
diff --git a/distutils2/__init__.py b/distutils2/__init__.py
--- a/distutils2/__init__.py
+++ b/distutils2/__init__.py
@@ -13,5 +13,5 @@
__all__ = ['__version__', 'logger']
-__version__ = "1.0a3"
+__version__ = "1.0a5.dev0"
logger = getLogger('distutils2')
diff --git a/distutils2/_trove.py b/distutils2/_trove.py
--- a/distutils2/_trove.py
+++ b/distutils2/_trove.py
@@ -114,6 +114,7 @@
'License :: OSI Approved :: Motosoto License',
'License :: OSI Approved :: Mozilla Public License 1.0 (MPL)',
'License :: OSI Approved :: Mozilla Public License 1.1 (MPL 1.1)',
+'License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)',
'License :: OSI Approved :: Nethack General Public License',
'License :: OSI Approved :: Nokia Open Source License',
'License :: OSI Approved :: Open Group Test Suite License',
@@ -149,6 +150,7 @@
'Natural Language :: Esperanto',
'Natural Language :: Finnish',
'Natural Language :: French',
+'Natural Language :: Galician',
'Natural Language :: German',
'Natural Language :: Greek',
'Natural Language :: Hebrew',
@@ -193,9 +195,14 @@
'Operating System :: Microsoft :: MS-DOS',
'Operating System :: Microsoft :: Windows',
'Operating System :: Microsoft :: Windows :: Windows 3.1 or Earlier',
+'Operating System :: Microsoft :: Windows :: Windows 7',
'Operating System :: Microsoft :: Windows :: Windows 95/98/2000',
'Operating System :: Microsoft :: Windows :: Windows CE',
'Operating System :: Microsoft :: Windows :: Windows NT/2000',
+'Operating System :: Microsoft :: Windows :: Windows Server 2003',
+'Operating System :: Microsoft :: Windows :: Windows Server 2008',
+'Operating System :: Microsoft :: Windows :: Windows Vista',
+'Operating System :: Microsoft :: Windows :: Windows XP',
'Operating System :: OS/2',
'Operating System :: OS Independent',
'Operating System :: Other OS',
@@ -263,10 +270,12 @@
'Programming Language :: Python :: 2.5',
'Programming Language :: Python :: 2.6',
'Programming Language :: Python :: 2.7',
+'Programming Language :: Python :: 2 :: Only',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.0',
'Programming Language :: Python :: 3.1',
'Programming Language :: Python :: 3.2',
+'Programming Language :: Python :: 3.3',
'Programming Language :: Python :: Implementation',
'Programming Language :: Python :: Implementation :: CPython',
'Programming Language :: Python :: Implementation :: IronPython',
@@ -449,8 +458,8 @@
'Topic :: Printing',
'Topic :: Religion',
'Topic :: Scientific/Engineering',
+'Topic :: Scientific/Engineering :: Artificial Intelligence',
'Topic :: Scientific/Engineering :: Artificial Life',
-'Topic :: Scientific/Engineering :: Artificial Intelligence',
'Topic :: Scientific/Engineering :: Astronomy',
'Topic :: Scientific/Engineering :: Atmospheric Science',
'Topic :: Scientific/Engineering :: Bio-Informatics',
diff --git a/distutils2/command/build_scripts.py b/distutils2/command/build_scripts.py
--- a/distutils2/command/build_scripts.py
+++ b/distutils2/command/build_scripts.py
@@ -5,7 +5,7 @@
from tokenize import detect_encoding
from distutils2.command.cmd import Command
-from distutils2.util import convert_path, newer
+from distutils2.util import convert_path
from distutils2 import logger
from distutils2.compat import Mixin2to3
from distutils2._backport import sysconfig
@@ -21,17 +21,12 @@
user_options = [
('build-dir=', 'd', "directory to build (copy) to"),
- ('force', 'f', "forcibly build everything (ignore file timestamps"),
('executable=', 'e', "specify final destination interpreter path"),
]
- boolean_options = ['force']
-
-
def initialize_options(self):
self.build_dir = None
self.scripts = None
- self.force = None
self.executable = None
self.outfiles = None
self.use_2to3 = False
@@ -42,7 +37,7 @@
self.set_undefined_options('build',
('build_scripts', 'build_dir'),
'use_2to3', 'use_2to3_fixers',
- 'convert_2to3_doctests', 'force',
+ 'convert_2to3_doctests',
'executable')
self.scripts = self.distribution.scripts
@@ -62,6 +57,8 @@
ie. starts with "\#!" and contains "python"), then adjust the first
line to refer to the current Python interpreter as we copy.
"""
+ # XXX use self.execute(shutil.rmtree, ...)
+ self.rmpath(self.build_dir)
self.mkpath(self.build_dir)
outfiles = []
for script in self.scripts:
@@ -70,10 +67,6 @@
outfile = os.path.join(self.build_dir, os.path.basename(script))
outfiles.append(outfile)
- if not self.force and not newer(script, outfile):
- logger.debug("not copying %s (up-to-date)", script)
- continue
-
# Always open the file, but ignore failures in dry-run mode --
# that way, we'll get accurate feedback if we can read the
# script.
diff --git a/distutils2/command/cmd.py b/distutils2/command/cmd.py
--- a/distutils2/command/cmd.py
+++ b/distutils2/command/cmd.py
@@ -5,7 +5,7 @@
from distutils2 import util
from distutils2 import logger
from distutils2.errors import PackagingOptionError
-from distutils2._backport.shutil import copyfile, move, make_archive
+from distutils2._backport.shutil import copyfile, move, make_archive, rmtree
class Command:
@@ -365,6 +365,20 @@
return
os.makedirs(name, mode)
+ def rmpath(self, name, dry_run=None):
+ if dry_run is None:
+ dry_run = self.dry_run
+ name = os.path.normpath(name)
+ if not os.path.isdir(name) or name == '':
+ return
+ if dry_run:
+ head = ''
+ for part in name.split(os.sep):
+ logger.info("removing directory %s%s", head, part)
+ head += part + os.sep
+ return
+ rmtree(name)
+
def copy_file(self, infile, outfile,
preserve_mode=True, preserve_times=True, link=None, level=1):
"""Copy a file respecting dry-run and force flags.
diff --git a/distutils2/command/register.py b/distutils2/command/register.py
--- a/distutils2/command/register.py
+++ b/distutils2/command/register.py
@@ -81,6 +81,7 @@
def classifiers(self):
''' Fetch the list of classifiers from the server.
'''
+ # TODO use _trove module
response = urllib.request.urlopen(self.repository+'?:action=list_classifiers')
logger.info(response.read())
diff --git a/distutils2/compiler/msvc9compiler.py b/distutils2/compiler/msvc9compiler.py
--- a/distutils2/compiler/msvc9compiler.py
+++ b/distutils2/compiler/msvc9compiler.py
@@ -20,7 +20,7 @@
from distutils2 import logger
from distutils2.util import get_platform
-import winreg
+import _winreg as winreg
RegOpenKeyEx = winreg.OpenKeyEx
RegEnumKey = winreg.EnumKey
diff --git a/distutils2/compiler/msvccompiler.py b/distutils2/compiler/msvccompiler.py
--- a/distutils2/compiler/msvccompiler.py
+++ b/distutils2/compiler/msvccompiler.py
@@ -19,7 +19,7 @@
_can_read_reg = False
try:
- import winreg
+ import _winreg as winreg
_can_read_reg = True
hkey_mod = winreg
diff --git a/distutils2/database.py b/distutils2/database.py
--- a/distutils2/database.py
+++ b/distutils2/database.py
@@ -1,17 +1,16 @@
"""PEP 376 implementation."""
import os
-import re
import csv
import sys
import zipimport
from io import StringIO
from hashlib import md5
-from distutils2 import logger
from distutils2.errors import PackagingError
from distutils2.version import suggest_normalized_version, VersionPredicate
from distutils2.metadata import Metadata
+from distutils2.util import parse_requires
__all__ = [
@@ -157,6 +156,9 @@
return '<Distribution %r %s at %r>' % (
self.name, self.version, self.path)
+ def __str__(self):
+ return "%s %s" % (self.name, self.version)
+
def _get_records(self, local=False):
results = []
with self.get_distinfo_file('RECORD') as record:
@@ -291,12 +293,6 @@
"""A :class:`distutils2.metadata.Metadata` instance loaded with
the distribution's ``METADATA`` file."""
- _REQUIREMENT = re.compile(
- r'(?P<name>[-A-Za-z0-9_.]+)\s*'
- r'(?P<first>(?:<|<=|!=|==|>=|>)[-A-Za-z0-9_.]+)?\s*'
- r'(?P<rest>(?:\s*,\s*(?:<|<=|!=|==|>=|>)[-A-Za-z0-9_.]+)*)\s*'
- r'(?P<extras>\[.*\])?')
-
def __init__(self, path):
self.path = path
if _cache_enabled and path in _cache_path_egg:
@@ -305,33 +301,14 @@
self.version = self.metadata['Version']
return
- # reused from Distribute's pkg_resources
- def yield_lines(strs):
- """Yield non-empty/non-comment lines of a ``basestring``
- or sequence"""
- if isinstance(strs, str):
- for s in strs.splitlines():
- s = s.strip()
- # skip blank lines/comments
- if s and not s.startswith('#'):
- yield s
- else:
- for ss in strs:
- for s in yield_lines(ss):
- yield s
-
requires = None
if path.endswith('.egg'):
if os.path.isdir(path):
meta_path = os.path.join(path, 'EGG-INFO', 'PKG-INFO')
self.metadata = Metadata(path=meta_path)
- try:
- req_path = os.path.join(path, 'EGG-INFO', 'requires.txt')
- with open(req_path, 'r') as fp:
- requires = fp.read()
- except IOError:
- requires = None
+ req_path = os.path.join(path, 'EGG-INFO', 'requires.txt')
+ requires = parse_requires(req_path)
else:
# FIXME handle the case where zipfile is not available
zipf = zipimport.zipimporter(path)
@@ -348,11 +325,8 @@
elif path.endswith('.egg-info'):
if os.path.isdir(path):
path = os.path.join(path, 'PKG-INFO')
- try:
- with open(os.path.join(path, 'requires.txt'), 'r') as fp:
- requires = fp.read()
- except IOError:
- requires = None
+ req_path = os.path.join(path, 'requires.txt')
+ requires = parse_requires(req_path)
self.metadata = Metadata(path=path)
self.name = self.metadata['Name']
self.version = self.metadata['Version']
@@ -361,46 +335,13 @@
raise ValueError('path must end with .egg-info or .egg, got %r' %
path)
- if requires is not None:
+ if requires:
if self.metadata['Metadata-Version'] == '1.1':
# we can't have 1.1 metadata *and* Setuptools requires
for field in ('Obsoletes', 'Requires', 'Provides'):
- del self.metadata[field]
-
- reqs = []
-
- if requires is not None:
- for line in yield_lines(requires):
- if line.startswith('['):
- logger.warning(
- 'extensions in requires.txt are not supported '
- '(used by %r %s)', self.name, self.version)
- break
- else:
- match = self._REQUIREMENT.match(line.strip())
- if not match:
- # this happens when we encounter extras; since they
- # are written at the end of the file we just exit
- break
- else:
- if match.group('extras'):
- msg = ('extra requirements are not supported '
- '(used by %r %s)', self.name, self.version)
- logger.warning(msg, self.name)
- name = match.group('name')
- version = None
- if match.group('first'):
- version = match.group('first')
- if match.group('rest'):
- version += match.group('rest')
- version = version.replace(' ', '') # trim spaces
- if version is None:
- reqs.append(name)
- else:
- reqs.append('%s (%s)' % (name, version))
-
- if len(reqs) > 0:
- self.metadata['Requires-Dist'] += reqs
+ if field in self.metadata:
+ del self.metadata[field]
+ self.metadata['Requires-Dist'] += requires
if _cache_enabled:
_cache_path_egg[self.path] = self
@@ -409,6 +350,9 @@
return '<EggInfoDistribution %r %s at %r>' % (
self.name, self.version, self.path)
+ def __str__(self):
+ return "%s %s" % (self.name, self.version)
+
def list_installed_files(self, local=False):
def _md5(path):
@@ -476,7 +420,7 @@
return '-'.join([name, normalized_version]) + file_extension
-def get_distributions(use_egg_info=False, paths=None):
+def get_distributions(use_egg_info=True, paths=None):
"""
Provides an iterator that looks for ``.dist-info`` directories in
``sys.path`` and returns :class:`Distribution` instances for each one of
@@ -503,7 +447,7 @@
yield dist
-def get_distribution(name, use_egg_info=False, paths=None):
+def get_distribution(name, use_egg_info=True, paths=None):
"""
Scans all elements in ``sys.path`` and looks for all directories
ending with ``.dist-info``. Returns a :class:`Distribution`
@@ -538,7 +482,7 @@
return None
-def obsoletes_distribution(name, version=None, use_egg_info=False):
+def obsoletes_distribution(name, version=None, use_egg_info=True):
"""
Iterates over all distributions to find which distributions obsolete
*name*.
@@ -572,7 +516,7 @@
break
-def provides_distribution(name, version=None, use_egg_info=False):
+def provides_distribution(name, version=None, use_egg_info=True):
"""
Iterates over all distributions to find which distributions provide *name*.
If a *version* is provided, it will be used to filter the results. Scans
diff --git a/distutils2/install.py b/distutils2/install.py
--- a/distutils2/install.py
+++ b/distutils2/install.py
@@ -58,10 +58,12 @@
yield old, new
-def _run_distutils_install(path):
+def _run_distutils_install(path, dest):
# backward compat: using setuptools or plain-distutils
+ # FIXME pass dest argument to the command
cmd = '%s setup.py install --record=%s'
record_file = os.path.join(path, 'RECORD')
+ # FIXME use subprocess
os.system(cmd % (sys.executable, record_file))
if not os.path.exists(record_file):
raise ValueError('failed to install')
@@ -69,7 +71,7 @@
egginfo_to_distinfo(record_file, remove_egginfo=True)
-def _run_setuptools_install(path):
+def _run_setuptools_install(path, dest):
cmd = '%s setup.py install --record=%s --single-version-externally-managed'
record_file = os.path.join(path, 'RECORD')
@@ -80,12 +82,12 @@
egginfo_to_distinfo(record_file, remove_egginfo=True)
-def _run_packaging_install(path):
+def _run_packaging_install(path, dest):
# XXX check for a valid setup.cfg?
dist = Distribution()
dist.parse_config_files()
try:
- dist.run_command('install_dist')
+ dist.run_command('install_dist', {'prefix': (None, dest)})
name = dist.metadata['Name']
return database.get_distribution(name) is not None
except (IOError, os.error, PackagingError, CCompilerError) as msg:
@@ -106,11 +108,13 @@
if where is None:
raise ValueError('Cannot locate the unpacked archive')
- return _run_install_from_archive(where)
+ return _run_install_from_archive(where, path)
def install_local_project(path):
- """Install a distribution from a source directory.
+ """Install a distribution from a source directory or archive.
+
+ If *path* is an archive, it will be unarchived first.
If the source directory contains a setup.py install using distutils1.
If a setup.cfg is found, install using the install_dist command.
@@ -134,14 +138,14 @@
return False
-def _run_install_from_archive(source_dir):
+def _run_install_from_archive(source_dir, dest_dir):
# XXX need a better way
for item in os.listdir(source_dir):
fullpath = os.path.join(source_dir, item)
if os.path.isdir(fullpath):
source_dir = fullpath
break
- return _run_install_from_dir(source_dir)
+ return _run_install_from_dir(source_dir, dest_dir)
install_methods = {
@@ -150,15 +154,14 @@
'distutils': _run_distutils_install}
-def _run_install_from_dir(source_dir):
+def _run_install_from_dir(source_dir, dest_dir=None):
old_dir = os.getcwd()
os.chdir(source_dir)
- install_method = get_install_method(source_dir)
- func = install_methods[install_method]
try:
+ install_method = get_install_method(source_dir)
func = install_methods[install_method]
try:
- func(source_dir)
+ func(source_dir, dest_dir)
return True
except ValueError as err:
# failed to install
@@ -183,7 +186,7 @@
installed_dists = []
for dist in dists:
- logger.info('Installing %r %s...', dist.name, dist.version)
+ logger.info('Installing %s...', dist)
try:
_install_dist(dist, path)
installed_dists.append(dist)
@@ -244,7 +247,8 @@
temp_dir = tempfile.mkdtemp()
for dist in remove:
files = dist.list_installed_files()
- temp_files[dist] = _move_files(files, temp_dir)
+ paths = [path for path, md5, size in files]
+ temp_files[dist] = _move_files(paths, temp_dir)
try:
if install:
install_dists(install, install_path, paths)
diff --git a/distutils2/metadata.py b/distutils2/metadata.py
--- a/distutils2/metadata.py
+++ b/distutils2/metadata.py
@@ -34,6 +34,8 @@
def system_message(self, level, message, *children, **kwargs):
self.messages.append((level, message, children, kwargs))
+ return nodes.system_message(message, level=level, type=self.
+ levels[level], *children, **kwargs)
_HAS_DOCUTILS = True
except ImportError:
@@ -48,7 +50,7 @@
# preferred version. Hopefully will be changed
# to 1.2 once PEP 345 is supported everywhere
-PKG_INFO_PREFERRED_VERSION = '1.0'
+PKG_INFO_PREFERRED_VERSION = '1.1'
_LINE_PREFIX = re.compile('\n \|')
_241_FIELDS = ('Metadata-Version', 'Name', 'Version', 'Platform',
@@ -101,7 +103,12 @@
return True
return False
- keys = list(fields)
+ keys = []
+ for key, value in fields.items():
+ if value in ([], 'UNKNOWN', None):
+ continue
+ keys.append(key)
+
possible_versions = ['1.0', '1.1', '1.2']
# first let's try to see if a field is not part of one of the version
@@ -214,8 +221,9 @@
self.read_file(fileobj)
elif mapping is not None:
self.update(mapping)
+ self.set_metadata_version()
- def _set_best_version(self):
+ def set_metadata_version(self):
self._fields['Metadata-Version'] = _best_version(self._fields)
def _write_field(self, file, name, value):
@@ -233,7 +241,6 @@
del self._fields[field_name]
except KeyError:
raise KeyError(name)
- self._set_best_version()
def __contains__(self, name):
return (name in self._fields or
@@ -332,6 +339,7 @@
value = msg[field]
if value is not None and value != 'UNKNOWN':
self.set(field, value)
+ self.set_metadata_version()
def write(self, filepath):
"""Write the metadata fields to filepath."""
@@ -340,7 +348,8 @@
def write_file(self, fileobject):
"""Write the PKG-INFO format data to a file object."""
- self._set_best_version()
+ self.set_metadata_version()
+
for field in _version2fieldlist(self['Metadata-Version']):
values = self.get(field)
if field in _ELEMENTSFIELD:
@@ -367,14 +376,6 @@
Keys that don't match a metadata field or that have an empty value are
dropped.
"""
- # XXX the code should just use self.set, which does tbe same checks and
- # conversions already, but that would break packaging.pypi: it uses the
- # update method, which does not call _set_best_version (which set
- # does), and thus allows having a Metadata object (as long as you don't
- # modify or write it) with extra fields from PyPI that are not fields
- # defined in Metadata PEPs. to solve it, the best_version system
- # should be reworked so that it's called only for writing, or in a new
- # strict mode, or with a new, more lax Metadata subclass in p7g.pypi
def _set(key, value):
if key in _ATTR2FIELD and value:
self.set(self._convert_name(key), value)
@@ -435,7 +436,6 @@
value = self._remove_line_prefix(value)
self._fields[name] = value
- self._set_best_version()
def get(self, name, default=_MISSING):
"""Get a metadata field."""
@@ -475,8 +475,10 @@
return value
def check(self, strict=False, restructuredtext=False):
- """Check if the metadata is compliant. If strict is False then raise if
+ """Check if the metadata is compliant. If strict is True then raise if
no Name or Version are provided"""
+ self.set_metadata_version()
+
# XXX should check the versions (if the file was loaded)
missing, warnings = [], []
@@ -521,6 +523,7 @@
Field names will be converted to use the underscore-lowercase style
instead of hyphen-mixed case (i.e. home_page instead of Home-page).
"""
+ self.set_metadata_version()
data = {
'metadata_version': self['Metadata-Version'],
'name': self['Name'],
diff --git a/distutils2/pypi/simple.py b/distutils2/pypi/simple.py
--- a/distutils2/pypi/simple.py
+++ b/distutils2/pypi/simple.py
@@ -196,8 +196,8 @@
def get_release(self, requirements, prefer_final=None):
"""Return only one release that fulfill the given requirements"""
predicate = get_version_predicate(requirements)
- release = self.get_releases(predicate, prefer_final)\
- .get_last(predicate)
+ releases = self.get_releases(predicate, prefer_final)
+ release = releases.get_last(predicate)
if not release:
raise ReleaseNotFound("No release matches the given criterias")
return release
diff --git a/distutils2/pypi/wrapper.py b/distutils2/pypi/wrapper.py
--- a/distutils2/pypi/wrapper.py
+++ b/distutils2/pypi/wrapper.py
@@ -25,8 +25,9 @@
exception = None
methods = [func]
for f in wrapper._indexes.values():
- if f != func.__self__ and hasattr(f, func.__name__):
- methods.append(getattr(f, func.__name__))
+ func_name = func.__func__.__name__
+ if f != func.__self__ and hasattr(f, func_name):
+ methods.append(getattr(f, func_name))
for method in methods:
try:
response = method(*args, **kwargs)
diff --git a/distutils2/run.py b/distutils2/run.py
--- a/distutils2/run.py
+++ b/distutils2/run.py
@@ -10,6 +10,7 @@
from distutils2.dist import Distribution
from distutils2.util import _is_archive_file, generate_setup_py
from distutils2.command import get_command_class, STANDARD_COMMANDS
+from distutils2.command.cmd import Command
from distutils2.install import install, install_local_project, remove
from distutils2.database import get_distribution, get_distributions
from distutils2.depgraph import generate_graph
@@ -255,6 +256,13 @@
parser = dispatcher.parser
args = args[1:]
+ # Find and parse the config file(s): they will override options from
+ # the setup script, but be overridden by the command line.
+ # XXX call the functions from config and kill the Distribution class
+ # (merging it into Dispatcher)
+ dist = Distribution()
+ dist.parse_config_files()
+
commands = STANDARD_COMMANDS # FIXME display extra commands
if args == ['--list-commands']:
@@ -270,16 +278,6 @@
if args is None:
return
- # create the Distribution class
- # need to feed setup.cfg here !
- dist = Distribution()
-
- # Find and parse the config file(s): they will override options from
- # the setup script, but be overridden by the command line.
-
- # XXX still need to be extracted from Distribution
- dist.parse_config_files()
-
for cmd in dispatcher.commands:
# FIXME need to catch MetadataMissingError here (from the check command
# e.g.)--or catch any exception, print an error message and exit with 1
@@ -309,7 +307,7 @@
number = 0
for dist in results:
- print('%r %s (from %r)' % (dist.name, dist.version, dist.path))
+ print('%s (from %r)' % (dist, dist.path))
number += 1
if number == 0:
@@ -388,6 +386,7 @@
self.parser.set_negative_aliases(negative_opt)
# FIXME this parses everything, including command options (e.g. "run
# build -i" errors with "option -i not recognized")
+ # FIXME unknown options are not detected
args = self.parser.getopt(args=args, object=self)
# if first arg is "run", we have some commands
@@ -398,8 +397,8 @@
allowed = [action[0] for action in actions] + [None]
if self.action not in allowed:
- msg = 'Unrecognized action "%s"' % self.action
- raise PackagingArgError(msg)
+ self.show_help()
+ sys.exit('error: action %r not recognized' % self.action)
self._set_logger()
self.args = args
@@ -436,7 +435,8 @@
# Pull the current command from the head of the command line
command = args[0]
if not command_re.match(command):
- raise SystemExit("invalid command name %r" % (command,))
+ self.show_help() # TODO list only commands, not actions
+ sys.exit('error: invalid command name %r' % command)
self.commands.append(command)
# Dig up the command class that implements this command, so we
@@ -445,7 +445,8 @@
try:
cmd_class = get_command_class(command)
except PackagingModuleError as msg:
- raise PackagingArgError(msg)
+ self.show_help() # TODO list only commands, not actions
+ sys.exit('error: command %r not recognized' % command)
# XXX We want to push this in distutils2.command
#
@@ -486,7 +487,11 @@
cmd_class.user_options +
help_options)
parser.set_negative_aliases(_negative_opt)
- args, opts = parser.getopt(args[1:])
+ try:
+ args, opts = parser.getopt(args[1:])
+ except PackagingArgError as msg:
+ self.show_help()
+ sys.exit('error: %s' % msg)
if hasattr(opts, 'help') and opts.help:
self._show_command_help(cmd_class)
@@ -541,9 +546,8 @@
def _show_help(self, parser, global_options_=True, display_options_=True,
commands=[]):
- # late import because of mutual dependence between these modules
- from distutils2.command.cmd import Command
-
+ # XXX want to print to stdout when help is requested (--help) but to
+ # stderr in case of error!
print('Usage: pysetup [options] action [action_options]')
print()
if global_options_:
diff --git a/distutils2/tests/requires.txt b/distutils2/tests/requires.txt
new file mode 100644
--- /dev/null
+++ b/distutils2/tests/requires.txt
@@ -0,0 +1,15 @@
+setuptools
+zope.browser
+zope.component
+zope.configuration
+zope.contenttype >= 3.5
+zope.event
+zope.exceptions
+zope.i18n
+zope.interface
+zope.location
+zope.proxy
+zope.security
+
+[test]
+zope.testing
\ No newline at end of file
diff --git a/distutils2/tests/support.py b/distutils2/tests/support.py
--- a/distutils2/tests/support.py
+++ b/distutils2/tests/support.py
@@ -45,6 +45,10 @@
import zlib
except ImportError:
zlib = None
+try:
+ import docutils
+except ImportError:
+ docutils = None
from distutils2.dist import Distribution
from distutils2.util import resolve_name
@@ -62,7 +66,7 @@
# misc. functions and decorators
'fake_dec', 'create_distribution', 'use_command',
'copy_xxmodule_c', 'fixup_build_ext',
- 'skip_2to3_optimize',
+ 'skip_2to3_optimize', 'requires_docutils',
# imported from this module for backport purposes
'unittest', 'requires_zlib', 'skip_unless_symlink',
]
@@ -404,6 +408,8 @@
requires_zlib = unittest.skipUnless(zlib, 'requires zlib')
+requires_docutils = unittest.skipUnless(docutils, 'requires docutils')
+
def unlink(filename):
try:
diff --git a/distutils2/tests/test_command_bdist.py b/distutils2/tests/test_command_bdist.py
--- a/distutils2/tests/test_command_bdist.py
+++ b/distutils2/tests/test_command_bdist.py
@@ -1,7 +1,9 @@
"""Tests for distutils.command.bdist."""
import os
+from distutils2.errors import PackagingPlatformError
+from distutils2.command.bdist import bdist, show_formats
+
from test.support import captured_stdout
-from distutils2.command.bdist import bdist, show_formats
from distutils2.tests import unittest, support
@@ -42,6 +44,17 @@
self.assertTrue(subcmd.skip_build,
'%s should take --skip-build from bdist' % name)
+ def test_unsupported_platform(self):
+ _os_name = os.name
+ try:
+ os.name = 'some-obscure-os'
+
+ dist = self.create_dist()[1]
+ cmd = bdist(dist)
+ self.assertRaises(PackagingPlatformError, cmd.ensure_finalized)
+ finally:
+ os.name = _os_name
+
def test_show_formats(self):
with captured_stdout() as stdout:
show_formats()
diff --git a/distutils2/tests/test_command_build_scripts.py b/distutils2/tests/test_command_build_scripts.py
--- a/distutils2/tests/test_command_build_scripts.py
+++ b/distutils2/tests/test_command_build_scripts.py
@@ -20,7 +20,7 @@
cmd.finalize_options()
- self.assertTrue(cmd.force)
+ self.assertFalse(cmd.force)
self.assertEqual(cmd.build_dir, "/foo/bar")
def test_build(self):
@@ -38,13 +38,14 @@
for name in expected:
self.assertIn(name, built)
- def get_build_scripts_cmd(self, target, scripts):
+ def get_build_scripts_cmd(self, target, scripts,
+ executable=sys.executable):
dist = Distribution()
dist.scripts = scripts
dist.command_obj["build"] = support.DummyCommand(
build_scripts=target,
- force=True,
- executable=sys.executable,
+ force=False,
+ executable=executable,
use_2to3=False,
use_2to3_fixers=None,
convert_2to3_doctests=None
@@ -79,10 +80,8 @@
target = self.mkdtemp()
expected = self.write_sample_scripts(source)
-
- cmd = self.get_build_scripts_cmd(target,
- [os.path.join(source, fn)
- for fn in expected])
+ cmd = self.get_build_scripts_cmd(
+ target, [os.path.join(source, fn) for fn in expected])
cmd.finalize_options()
# http://bugs.python.org/issue4524
@@ -102,6 +101,62 @@
for name in expected:
self.assertIn(name, built)
+ def test_build_dir_recreated(self):
+ source = self.mkdtemp()
+ target = self.mkdtemp()
+ self.write_script(source, 'taunt', '#! /usr/bin/python')
+
+ built = os.path.join(target, 'taunt')
+
+ cmd = self.get_build_scripts_cmd(
+ target, [os.path.join(source, 'taunt')], 'pythona')
+ cmd.finalize_options()
+ cmd.run()
+
+ with open(built) as fp:
+ firstline = fp.readline().strip()
+ self.assertEqual(firstline, '#!pythona')
+
+ cmd = self.get_build_scripts_cmd(
+ target, [os.path.join(source, 'taunt')], 'pythonx')
+ cmd.finalize_options()
+ cmd.run()
+
+ with open(built) as fp:
+ firstline = fp.readline().strip()
+ self.assertEqual(firstline, '#!pythonx')
+
+ def test_build_old_scripts_deleted(self):
+ source = self.mkdtemp()
+ target = self.mkdtemp()
+
+ expected = ['script1.py', 'script2.py']
+ self.write_script(source, "script1.py",
+ ("#! /usr/bin/env python2.3\n"
+ "pass\n"))
+ self.write_script(source, "script2.py",
+ ("#!/usr/bin/python\n"
+ "pass\n"))
+
+ cmd = self.get_build_scripts_cmd(
+ target, [os.path.join(source, fn) for fn in expected])
+ cmd.finalize_options()
+ cmd.run()
+
+ built = sorted(os.listdir(target))
+ self.assertEqual(built, expected)
+
+ # if we run build_scripts with a different list of scripts, the old
+ # ones used to be left over in the build directory and installed anyway
+ cmd = self.get_build_scripts_cmd(
+ target, [os.path.join(source, 'script1.py')])
+ cmd.finalize_options()
+ cmd.run()
+
+ built = os.listdir(target)
+ self.assertEqual(built, ['script1.py'])
+
+
def test_suite():
return unittest.makeSuite(BuildScriptsTestCase)
diff --git a/distutils2/tests/test_command_register.py b/distutils2/tests/test_command_register.py
--- a/distutils2/tests/test_command_register.py
+++ b/distutils2/tests/test_command_register.py
@@ -5,14 +5,8 @@
import urllib.error
import urllib.parse
-try:
- import docutils
- DOCUTILS_SUPPORT = True
-except ImportError:
- DOCUTILS_SUPPORT = False
-
from distutils2.tests import unittest, support
-from distutils2.tests.support import Inputs
+from distutils2.tests.support import Inputs, requires_docutils
from distutils2.command import register as register_module
from distutils2.command.register import register
from distutils2.errors import PackagingSetupError
@@ -187,7 +181,7 @@
self.assertEqual(headers['Content-length'], '298')
self.assertIn(b'tarek', req.data)
- @unittest.skipUnless(DOCUTILS_SUPPORT, 'needs docutils')
+ @requires_docutils
def test_strict(self):
# testing the strict option: when on, the register command stops if the
# metadata is incomplete or if description contains bad reST
@@ -252,6 +246,22 @@
self.assertEqual(data['metadata_version'], '1.2')
self.assertEqual(data['requires_dist'], ['lxml'])
+ @requires_docutils
+ def test_register_invalid_long_description(self):
+ description = ':funkie:`str`' # mimic Sphinx-specific markup
+ metadata = {'Home-page': 'xxx', 'Author': 'xxx',
+ 'Author-email': 'xxx',
+ 'Name': 'xxx', 'Version': 'xxx',
+ 'Description': description}
+ cmd = self._get_cmd(metadata)
+ cmd.ensure_finalized()
+ cmd.strict = True
+ inputs = Inputs('2', 'tarek', 'tarek at ziade.org')
+ register_module.input = inputs
+ with self.assertRaises(PackagingSetupError) as e:
+ cmd.run()
+ self.assertIn('funkie', str(e.exception))
+
def test_suite():
return unittest.makeSuite(RegisterTestCase)
diff --git a/distutils2/tests/test_database.py b/distutils2/tests/test_database.py
--- a/distutils2/tests/test_database.py
+++ b/distutils2/tests/test_database.py
@@ -75,12 +75,14 @@
attributes are used in test methods. See source code for details.
"""
+ def _get_dist_path(self, distdir):
+ here = os.path.abspath(os.path.dirname(__file__))
+ return os.path.join(here, 'fake_dists', distdir)
+
def test_instantiation(self):
# check that useful attributes are here
name, version, distdir = self.sample_dist
- here = os.path.abspath(os.path.dirname(__file__))
- dist_path = os.path.join(here, 'fake_dists', distdir)
-
+ dist_path = self._get_dist_path(distdir)
dist = self.dist = self.cls(dist_path)
self.assertEqual(dist.path, dist_path)
self.assertEqual(dist.name, name)
@@ -96,6 +98,17 @@
self.assertIn(self.cls.__name__, repr(dist))
@requires_zlib
+ def test_str(self):
+ name, version, distdir = self.sample_dist
+ dist = self.cls(self._get_dist_path(distdir))
+ self.assertEqual(name, dist.name)
+ # Sanity test: dist.name is a unicode string,
+ # but str output contains no u prefix.
+ self.assertIsInstance(dist.name, str)
+ self.assertEqual(version, dist.version)
+ self.assertEqual(str(dist), self.expected_str_output)
+
+ @requires_zlib
def test_comparison(self):
# tests for __eq__ and __hash__
dist = self.cls(self.dirs[0])
@@ -123,6 +136,7 @@
cls = Distribution
sample_dist = 'choxie', '2.0.0.9', 'choxie-2.0.0.9.dist-info'
+ expected_str_output = 'choxie 2.0.0.9'
def setUp(self):
super(TestDistribution, self).setUp()
@@ -251,6 +265,7 @@
cls = EggInfoDistribution
sample_dist = 'bacon', '0.1', 'bacon-0.1.egg-info'
+ expected_str_output = 'bacon 0.1'
def setUp(self):
super(TestEggInfoDistribution, self).setUp()
@@ -316,7 +331,7 @@
found_dists = []
# Verify the fake dists have been found.
- dists = [dist for dist in get_distributions()]
+ dists = [dist for dist in get_distributions(use_egg_info=False)]
for dist in dists:
self.assertIsInstance(dist, Distribution)
if (dist.name in dict(fake_dists) and
@@ -367,10 +382,10 @@
# Verify that it does not find egg-info distributions, when not
# instructed to
- self.assertIsNone(get_distribution('bacon'))
- self.assertIsNone(get_distribution('cheese'))
- self.assertIsNone(get_distribution('strawberry'))
- self.assertIsNone(get_distribution('banana'))
+ self.assertIsNone(get_distribution('bacon', use_egg_info=False))
+ self.assertIsNone(get_distribution('cheese', use_egg_info=False))
+ self.assertIsNone(get_distribution('strawberry', use_egg_info=False))
+ self.assertIsNone(get_distribution('banana', use_egg_info=False))
# Now check that it works well in both situations, when egg-info
# is a file and directory respectively.
@@ -404,24 +419,29 @@
# Test for looking up distributions by what they provide
checkLists = lambda x, y: self.assertEqual(sorted(x), sorted(y))
- l = [dist.name for dist in provides_distribution('truffles')]
+ l = [dist.name for dist in provides_distribution('truffles',
+ use_egg_info=False)]
checkLists(l, ['choxie', 'towel-stuff'])
- l = [dist.name for dist in provides_distribution('truffles', '1.0')]
+ l = [dist.name for dist in provides_distribution('truffles', '1.0',
+ use_egg_info=False)]
checkLists(l, ['choxie'])
l = [dist.name for dist in provides_distribution('truffles', '1.0',
use_egg_info=True)]
checkLists(l, ['choxie', 'cheese'])
- l = [dist.name for dist in provides_distribution('truffles', '1.1.2')]
+ l = [dist.name for dist in provides_distribution('truffles', '1.1.2',
+ use_egg_info=False)]
checkLists(l, ['towel-stuff'])
- l = [dist.name for dist in provides_distribution('truffles', '1.1')]
+ l = [dist.name for dist in provides_distribution('truffles', '1.1',
+ use_egg_info=False)]
checkLists(l, ['towel-stuff'])
l = [dist.name for dist in provides_distribution('truffles',
- '!=1.1,<=2.0')]
+ '!=1.1,<=2.0',
+ use_egg_info=False)]
checkLists(l, ['choxie'])
l = [dist.name for dist in provides_distribution('truffles',
@@ -429,17 +449,20 @@
use_egg_info=True)]
checkLists(l, ['choxie', 'bacon', 'cheese'])
- l = [dist.name for dist in provides_distribution('truffles', '>1.0')]
+ l = [dist.name for dist in provides_distribution('truffles', '>1.0',
+ use_egg_info=False)]
checkLists(l, ['towel-stuff'])
- l = [dist.name for dist in provides_distribution('truffles', '>1.5')]
+ l = [dist.name for dist in provides_distribution('truffles', '>1.5',
+ use_egg_info=False)]
checkLists(l, [])
l = [dist.name for dist in provides_distribution('truffles', '>1.5',
use_egg_info=True)]
checkLists(l, ['bacon'])
- l = [dist.name for dist in provides_distribution('truffles', '>=1.0')]
+ l = [dist.name for dist in provides_distribution('truffles', '>=1.0',
+ use_egg_info=False)]
checkLists(l, ['choxie', 'towel-stuff'])
l = [dist.name for dist in provides_distribution('strawberry', '0.6',
@@ -471,28 +494,33 @@
# Test looking for distributions based on what they obsolete
checkLists = lambda x, y: self.assertEqual(sorted(x), sorted(y))
- l = [dist.name for dist in obsoletes_distribution('truffles', '1.0')]
+ l = [dist.name for dist in obsoletes_distribution('truffles', '1.0',
+ use_egg_info=False)]
checkLists(l, [])
l = [dist.name for dist in obsoletes_distribution('truffles', '1.0',
use_egg_info=True)]
checkLists(l, ['cheese', 'bacon'])
- l = [dist.name for dist in obsoletes_distribution('truffles', '0.8')]
+ l = [dist.name for dist in obsoletes_distribution('truffles', '0.8',
+ use_egg_info=False)]
checkLists(l, ['choxie'])
l = [dist.name for dist in obsoletes_distribution('truffles', '0.8',
use_egg_info=True)]
checkLists(l, ['choxie', 'cheese'])
- l = [dist.name for dist in obsoletes_distribution('truffles', '0.9.6')]
+ l = [dist.name for dist in obsoletes_distribution('truffles', '0.9.6',
+ use_egg_info=False)]
checkLists(l, ['choxie', 'towel-stuff'])
l = [dist.name for dist in obsoletes_distribution('truffles',
- '0.5.2.3')]
+ '0.5.2.3',
+ use_egg_info=False)]
checkLists(l, ['choxie', 'towel-stuff'])
- l = [dist.name for dist in obsoletes_distribution('truffles', '0.2')]
+ l = [dist.name for dist in obsoletes_distribution('truffles', '0.2',
+ use_egg_info=False)]
checkLists(l, ['towel-stuff'])
@requires_zlib
diff --git a/distutils2/tests/test_install.py b/distutils2/tests/test_install.py
--- a/distutils2/tests/test_install.py
+++ b/distutils2/tests/test_install.py
@@ -1,6 +1,7 @@
"""Tests for the distutils2.install module."""
import os
import logging
+
from tempfile import mkstemp
from distutils2 import install
@@ -57,7 +58,7 @@
def list_installed_files(self, **args):
if self._files:
- return self._real_files
+ return [(path, 'md5', 0) for path in self._real_files]
def get_install(self, **args):
return self.list_installed_files()
@@ -258,6 +259,25 @@
for key in expect:
self.assertEqual(expect[key], dict1[key])
+ def test_install_custom_dir(self):
+ dest = self.mkdtemp()
+
+ project_dir, dist = self.create_dist(
+ name='Spamlib', version='0.1',
+ data_files={'spamd': '{scripts}/spamd'})
+
+ dist.name = MagicMock(return_value='Spamlib')
+ dist.version = MagicMock(return_value='0.1')
+ dist.unpack = MagicMock(return_value=project_dir)
+
+ self.write_file([project_dir, 'setup.cfg'],
+ ("[metadata]\n"
+ "name = mypackage\n"
+ "version = 0.1.0\n"))
+
+ install.install_from_infos(dest, install=[dist])
+ self.assertEqual(len(os.listdir(dest)), 1)
+
def test_install_dists_rollback(self):
# if one of the distribution installation fails, call uninstall on all
# installed distributions.
@@ -312,7 +332,7 @@
# assert that the files have been removed
for dist in dists:
- for f in dist.list_installed_files():
+ for f, md5, size in dist.list_installed_files():
self.assertFalse(os.path.exists(f))
finally:
install.install_dists = old_install_dists
@@ -338,7 +358,7 @@
# assert that the files are in the same place
# assert that the files have been removed
for dist in remove:
- for f in dist.list_installed_files():
+ for f, md5, size in dist.list_installed_files():
self.assertTrue(os.path.exists(f))
dist._unlink_installed_files()
finally:
diff --git a/distutils2/tests/test_metadata.py b/distutils2/tests/test_metadata.py
--- a/distutils2/tests/test_metadata.py
+++ b/distutils2/tests/test_metadata.py
@@ -10,7 +10,7 @@
from distutils2.tests import unittest
from distutils2.tests.support import (LoggingCatcher, TempdirManager,
- EnvironRestorer)
+ EnvironRestorer, requires_docutils)
class MetadataTestCase(LoggingCatcher,
@@ -48,7 +48,7 @@
self.assertEqual(len(m.items()), 22)
m = Metadata(mapping=dict(name='Test', version='1.0'))
- self.assertEqual(len(m.items()), 11)
+ self.assertEqual(len(m.items()), 17)
d = dict(m.items())
self.assertRaises(TypeError, Metadata,
@@ -250,27 +250,32 @@
self.assertNotIn('Obsoletes', metadata)
metadata['Classifier'] = ['ok']
+ metadata.set_metadata_version()
self.assertEqual(metadata['Metadata-Version'], '1.1')
metadata = Metadata()
metadata['Download-URL'] = 'ok'
+ metadata.set_metadata_version()
self.assertEqual(metadata['Metadata-Version'], '1.1')
metadata = Metadata()
metadata['Obsoletes'] = 'ok'
+ metadata.set_metadata_version()
self.assertEqual(metadata['Metadata-Version'], '1.1')
del metadata['Obsoletes']
metadata['Obsoletes-Dist'] = 'ok'
+ metadata.set_metadata_version()
self.assertEqual(metadata['Metadata-Version'], '1.2')
-
- self.assertRaises(MetadataConflictError, metadata.set,
- 'Obsoletes', 'ok')
+ metadata.set('Obsoletes', 'ok')
+ self.assertRaises(MetadataConflictError,
+ metadata.set_metadata_version)
del metadata['Obsoletes']
del metadata['Obsoletes-Dist']
+ metadata.set_metadata_version()
metadata['Version'] = '1'
- self.assertEqual(metadata['Metadata-Version'], '1.0')
+ self.assertEqual(metadata['Metadata-Version'], '1.1')
# make sure the _best_version function works okay with
# non-conflicting fields from 1.1 and 1.2 (i.e. we want only the
@@ -279,18 +284,25 @@
metadata = Metadata()
metadata['Requires-Python'] = '3'
metadata['Classifier'] = ['Programming language :: Python :: 3']
+ metadata.set_metadata_version()
self.assertEqual(metadata['Metadata-Version'], '1.2')
PKG_INFO = os.path.join(os.path.dirname(__file__),
'SETUPTOOLS-PKG-INFO')
metadata = Metadata(PKG_INFO)
- self.assertEqual(metadata['Metadata-Version'], '1.0')
+ self.assertEqual(metadata['Metadata-Version'], '1.1')
PKG_INFO = os.path.join(os.path.dirname(__file__),
'SETUPTOOLS-PKG-INFO2')
metadata = Metadata(PKG_INFO)
self.assertEqual(metadata['Metadata-Version'], '1.1')
+ # make sure an empty list for Obsoletes and Requires-dist gets ignored
+ metadata['Obsoletes'] = []
+ metadata['Requires-dist'] = []
+ metadata.set_metadata_version()
+ self.assertEqual(metadata['Metadata-Version'], '1.1')
+
# Update the _fields dict directly to prevent 'Metadata-Version'
# from being updated by the _set_best_version() method.
metadata._fields['Metadata-Version'] = '1.618'
@@ -345,10 +357,21 @@
folded_desc = desc.replace('\n', '\n' + (7 * ' ') + '|')
self.assertIn(folded_desc, out.getvalue())
+ @requires_docutils
+ def test_description_invalid_rst(self):
+ # make sure bad rst is well handled in the description attribute
+ metadata = Metadata()
+ description = ':funkie:`str`' # mimic Sphinx-specific markup
+ metadata['description'] = description
+ missing, warnings = metadata.check(restructuredtext=True)
+ warning = warnings[0][1]
+ self.assertIn('funkie', warning)
+
def test_project_url(self):
metadata = Metadata()
metadata['Project-URL'] = [('one', 'http://ok')]
self.assertEqual(metadata['Project-URL'], [('one', 'http://ok')])
+ metadata.set_metadata_version()
self.assertEqual(metadata['Metadata-Version'], '1.2')
# make sure this particular field is handled properly when written
diff --git a/distutils2/tests/test_msvc9compiler.py b/distutils2/tests/test_msvc9compiler.py
--- a/distutils2/tests/test_msvc9compiler.py
+++ b/distutils2/tests/test_msvc9compiler.py
@@ -101,7 +101,7 @@
v = Reg.get_value(path, 'dragfullwindows')
self.assertIn(v, ('0', '1', '2'))
- import winreg
+ import _winreg as winreg
HKCU = winreg.HKEY_CURRENT_USER
keys = Reg.read_keys(HKCU, 'xxxx')
self.assertEqual(keys, None)
diff --git a/distutils2/tests/test_pypi_wrapper.py b/distutils2/tests/test_pypi_wrapper.py
new file mode 100644
--- /dev/null
+++ b/distutils2/tests/test_pypi_wrapper.py
@@ -0,0 +1,37 @@
+"""Tests for the distutils2.pypi.wrapper module."""
+
+
+from distutils2.tests import unittest
+from distutils2.pypi.wrapper import switch_index_if_fails
+
+
+class Index1(object):
+ def test(self):
+ raise Exception("boo")
+
+
+class Index2(object):
+ def test(self):
+ return 'OK'
+
+
+class Indexes(object):
+ _indexes = {'one': Index1(), 'two': Index2()}
+
+
+class TestPyPIWrapper(unittest.TestCase):
+
+ def test_wrapper(self):
+ index = Indexes._indexes['one']
+ func = switch_index_if_fails(getattr(index, 'test'), Indexes)
+ self.assertEqual(func(), 'OK')
+
+
+def test_suite():
+ suite = unittest.TestSuite()
+ suite.addTest(unittest.makeSuite(TestPyPIWrapper))
+ return suite
+
+
+if __name__ == '__main__':
+ unittest.main(defaultTest='test_suite')
diff --git a/distutils2/tests/test_run.py b/distutils2/tests/test_run.py
--- a/distutils2/tests/test_run.py
+++ b/distutils2/tests/test_run.py
@@ -2,13 +2,14 @@
import os
import sys
+import textwrap
from io import StringIO
from distutils2 import install
from distutils2.tests import unittest, support
from distutils2.run import main
-from distutils2.tests.support import assert_python_ok
+from distutils2.tests.support import assert_python_ok, assert_python_failure
# setup script that uses __file__
setup_using___file__ = """\
@@ -31,14 +32,7 @@
support.LoggingCatcher,
unittest.TestCase):
- def setUp(self):
- super(RunTestCase, self).setUp()
- self.old_argv = sys.argv, sys.argv[:]
-
- def tearDown(self):
- sys.argv = self.old_argv[0]
- sys.argv[:] = self.old_argv[1]
- super(RunTestCase, self).tearDown()
+ maxDiff = None
# TODO restore the tests removed six months ago and port them to pysetup
@@ -62,28 +56,32 @@
def get_pythonpath(self):
pythonpath = os.environ.get('PYTHONPATH')
- d2parent = os.path.dirname(os.path.dirname(__file__))
+ d2parent = os.path.dirname(os.path.dirname(__file__)) # XXX buggy
if pythonpath is not None:
pythonpath = os.pathsep.join((pythonpath, d2parent))
else:
pythonpath = d2parent
return pythonpath
+ def call_pysetup(self, *args):
+ _, out, err = assert_python_ok('-m', 'distutils2.run', *args,
+ PYTHONPATH=self.get_pythonpath())
+ return out, err
+
+ def call_pysetup_fail(self, *args):
+ _, out, err = assert_python_failure('-m', 'distutils2.run', *args,
+ PYTHONPATH=self.get_pythonpath())
+ return out, err
+
def test_show_help(self):
# smoke test, just makes sure some help is displayed
- status, out, err = assert_python_ok(
- '-m', 'distutils2.run', '--help',
- PYTHONPATH=self.get_pythonpath())
- self.assertEqual(status, 0)
+ out, err = self.call_pysetup('--help')
self.assertGreater(out, b'')
self.assertEqual(err, b'')
def test_list_commands(self):
- status, out, err = assert_python_ok(
- '-m', 'distutils2.run', 'run',
- '--list-commands', PYTHONPATH=self.get_pythonpath())
+ out, err = self.call_pysetup('run', '--list-commands')
# check that something is displayed
- self.assertEqual(status, 0)
self.assertGreater(out, b'')
self.assertEqual(err, b'')
@@ -94,7 +92,66 @@
self.assertTrue(build_position, out)
self.assertLess(check_position, build_position, out)
- # TODO test that custom commands don't break --list-commands
+ # TODO test that custom commands don't break --list-commands
+
+ def test_unknown_command_option(self):
+ out, err = self.call_pysetup_fail('run', 'build', '--unknown')
+ self.assertGreater(out, b'')
+ # sadly this message comes straight from the getopt module and can't be
+ # modified to use repr instead of str for the unknown option; to be
+ # changed when the command line parsers are replaced by something clean
+ self.assertEqual(err.splitlines(),
+ [b'error: option --unknown not recognized'])
+
+ def test_invalid_command(self):
+ out, err = self.call_pysetup_fail('run', 'com#mand')
+ self.assertGreater(out, b'')
+ self.assertEqual(err.splitlines(),
+ [b"error: invalid command name 'com#mand'"])
+
+ def test_unknown_command(self):
+ out, err = self.call_pysetup_fail('run', 'invalid_command')
+ self.assertGreater(out, b'')
+ self.assertEqual(err.splitlines(),
+ [b"error: command 'invalid_command' not recognized"])
+
+ def test_unknown_action(self):
+ out, err = self.call_pysetup_fail('invalid_action')
+ self.assertGreater(out, b'')
+ self.assertEqual(err.splitlines(),
+ [b"error: action 'invalid_action' not recognized"])
+
+ def test_setupcfg_parsing(self):
+ # #14733: pysetup used to parse setup.cfg too late
+ project_dir = self.mkdtemp()
+ os.chdir(project_dir)
+ custompy = textwrap.dedent(
+ """\
+ from distutils2.command.cmd import Command
+
+ class custom(Command):
+
+ user_options = []
+
+ def initialize_options(self):
+ pass
+
+ def finalize_options(self):
+ pass
+
+ def run(self):
+ print('custom: ok')
+ """)
+ setupcfg = textwrap.dedent(
+ """\
+ [global]
+ commands = custom.custom
+ """)
+ self.write_file('custom.py', custompy)
+ self.write_file('setup.cfg', setupcfg)
+
+ out, err = self.call_pysetup('run', 'custom')
+ self.assertEqual(out.splitlines(), [b'custom: ok'])
def test_suite():
diff --git a/distutils2/tests/test_util.py b/distutils2/tests/test_util.py
--- a/distutils2/tests/test_util.py
+++ b/distutils2/tests/test_util.py
@@ -19,7 +19,8 @@
get_compiler_versions, _MAC_OS_X_LD_VERSION, byte_compile, find_packages,
spawn, get_pypirc_path, generate_pypirc, read_pypirc, resolve_name, iglob,
RICH_GLOB, egginfo_to_distinfo, is_setuptools, is_distutils, is_packaging,
- get_install_method, cfg_to_args, generate_setup_py, encode_multipart)
+ get_install_method, cfg_to_args, generate_setup_py, encode_multipart,
+ parse_requires)
from distutils2.tests import support, unittest
from distutils2.tests.test_config import SETUP_CFG
@@ -377,6 +378,15 @@
self.assertEqual(sorted(res),
['pkg1', 'pkg1.pkg3', 'pkg1.pkg3.pkg6', 'pkg5'])
+ def test_parse_requires(self):
+ req_file = os.path.join(os.path.dirname(__file__), 'requires.txt')
+ expected_requires = ['setuptools', 'zope.browser', 'zope.component',
+ 'zope.configuration', 'zope.contenttype', 'zope.event',
+ 'zope.exceptions', 'zope.i18n', 'zope.interface',
+ 'zope.location', 'zope.proxy', 'zope.security']
+ requires = parse_requires(req_file)
+ self.assertEqual(requires, expected_requires)
+
def test_resolve_name(self):
# test raw module name
tmpdir = self.mkdtemp()
@@ -744,6 +754,31 @@
self.assertRaises(ValueError, iglob, pattern)
+PKG_INFO = '''\
+Metadata-Version: 1.1
+Name: hello
+Version: 0.1.1
+Summary: Hello World
+Home-page: https://example.com
+Author: John Doe
+Author-email: j.doe at example.com
+License: UNKNOWN
+Download-URL: https://example.com/tarball/master
+Description: UNKNOWN
+Platform: Any
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 2
+Classifier: Programming Language :: Python :: 2.7
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.2
+Classifier: Intended Audience :: Developers
+Classifier: Environment :: Console
+Provides: hello
+'''
+
+
class EggInfoToDistInfoTestCase(support.TempdirManager,
support.LoggingCatcher,
unittest.TestCase):
@@ -762,10 +797,14 @@
dirs = [egginfo]
files = ['hello.py', 'hello.pyc']
extra_metadata = ['dependency_links.txt', 'entry_points.txt',
- 'not-zip-safe', 'PKG-INFO', 'top_level.txt',
- 'SOURCES.txt']
+ 'not-zip-safe', ('PKG-INFO', PKG_INFO),
+ 'top_level.txt', 'SOURCES.txt']
for f in extra_metadata:
- files.append(os.path.join(egginfo, f))
+ if isinstance(f, tuple):
+ f, content = f
+ else:
+ content = 'XXX'
+ files.append((os.path.join(egginfo, f), content))
tempdir, record_file = self.build_dist_tree(files, dirs)
distinfo_path = os.path.join(tempdir, distinfo)
@@ -784,7 +823,7 @@
distinfo = 'hello-0.1.1-py3.3.dist-info'
egginfo = 'hello-0.1.1-py3.3.egg-info'
# egginfo is a file in distutils which contains the metadata
- files = ['hello.py', 'hello.pyc', egginfo]
+ files = ['hello.py', 'hello.pyc', (egginfo, PKG_INFO)]
tempdir, record_file = self.build_dist_tree(files, dirs=[])
distinfo_path = os.path.join(tempdir, distinfo)
@@ -792,6 +831,7 @@
metadata_file_paths = self.get_metadata_file_paths(distinfo_path)
egginfo_to_distinfo(record_file)
+
# test that directories and files get created
self.assertTrue(os.path.isdir(distinfo_path))
self.assertTrue(os.path.isfile(egginfo_path))
@@ -808,9 +848,14 @@
os.makedirs(path)
dir_paths.append(path)
for f in files:
+ if isinstance(f, (list, tuple)):
+ f, content = f
+ else:
+ content = ''
+
path = os.path.join(tempdir, f)
with open(path, 'w') as _f:
- _f.write(f)
+ _f.write(content)
file_paths.append(path)
with open(record_file_path, 'w') as record_file:
diff --git a/distutils2/tests/test_version.py b/distutils2/tests/test_version.py
--- a/distutils2/tests/test_version.py
+++ b/distutils2/tests/test_version.py
@@ -18,8 +18,8 @@
(V('1.2c4'), '1.2c4'),
(V('4.17rc2'), '4.17rc2'),
(V('1.2.3.4'), '1.2.3.4'),
- (V('1.2.3.4.0b3'), '1.2.3.4b3'),
- (V('1.2.0.0.0'), '1.2'),
+ (V('1.2.3.4.0b3', drop_trailing_zeros=True), '1.2.3.4b3'),
+ (V('1.2.0.0.0', drop_trailing_zeros=True), '1.2'),
(V('1.0.dev345'), '1.0.dev345'),
(V('1.0.post456.dev623'), '1.0.post456.dev623'))
@@ -249,6 +249,12 @@
for version in other_versions:
self.assertFalse(V(version).is_final)
+ def test_micro_predicate(self):
+ self.assertNotEqual(V('3.4.0'), V('3.4'))
+ predicate = VersionPredicate('zope.event (3.4.0)')
+ self.assertTrue(predicate.match('3.4.0'))
+ self.assertFalse(predicate.match('3.4.1'))
+
class VersionWhiteBoxTestCase(unittest.TestCase):
diff --git a/distutils2/util.py b/distutils2/util.py
--- a/distutils2/util.py
+++ b/distutils2/util.py
@@ -19,6 +19,7 @@
from distutils2.errors import (PackagingPlatformError, PackagingFileError,
PackagingExecError, InstallationException,
PackagingInternalError)
+from distutils2.metadata import Metadata
from distutils2._backport import shutil, sysconfig
from distutils2._backport.misc import cache_from_source
@@ -1152,6 +1153,69 @@
return record_path
+def parse_requires(req_path):
+ """Create a list of dependencies from a requires.txt file.
+
+ *req_path* must be the path to a setuptools-produced requires.txt file.
+ """
+
+ # reused from Distribute's pkg_resources
+ def yield_lines(strs):
+ """Yield non-empty/non-comment lines of a string or sequence"""
+ if isinstance(strs, str):
+ for s in strs.splitlines():
+ s = s.strip()
+ # skip blank lines/comments
+ if s and not s.startswith('#'):
+ yield s
+ else:
+ for ss in strs:
+ for s in yield_lines(ss):
+ yield s
+
+ _REQUIREMENT = re.compile(
+ r'(?P<name>[-A-Za-z0-9_.]+)\s*'
+ r'(?P<first>(?:<|<=|!=|==|>=|>)[-A-Za-z0-9_.]+)?\s*'
+ r'(?P<rest>(?:\s*,\s*(?:<|<=|!=|==|>=|>)[-A-Za-z0-9_.]+)*)\s*'
+ r'(?P<extras>\[.*\])?')
+
+ reqs = []
+ try:
+ with open(req_path, 'r') as fp:
+ requires = fp.read()
+ except IOError:
+ return None
+
+ for line in yield_lines(requires):
+ if line.startswith('['):
+ logger.warning('extensions in requires.txt are not supported')
+ break
+ else:
+ match = _REQUIREMENT.match(line.strip())
+ if not match:
+ # this happens when we encounter extras; since they
+ # are written at the end of the file we just exit
+ break
+ else:
+ if match.group('extras'):
+ # msg = ('extra requirements are not supported '
+ # '(used by %r %s)', self.name, self.version)
+ msg = 'extra requirements are not supported'
+ logger.warning(msg)
+ name = match.group('name')
+ version = None
+ if match.group('first'):
+ version = match.group('first')
+ if match.group('rest'):
+ version += match.group('rest')
+ version = version.replace(' ', '') # trim spaces
+ if version is None:
+ reqs.append(name)
+ else:
+ reqs.append('%s (%s)' % (name, version))
+ return reqs
+
+
def egginfo_to_distinfo(record_file, installer=_DEFAULT_INSTALLER,
requested=False, remove_egginfo=False):
"""Create files and directories required for PEP 376
@@ -1180,6 +1244,22 @@
metadata_path = distinfo['metadata_path']
logger.info('creating %s', metadata_path)
shutil.copy2(distinfo['metadata'], metadata_path)
+ # add requirements and output metadata
+ requires = None
+ req_path = os.path.join(distinfo_dir, 'requires.txt')
+ requires = parse_requires(req_path)
+
+ # adapting the metadata
+ metadata = Metadata(path=metadata_path)
+ if metadata['Provides'] != []:
+ metadata['Provides-Dist'] = metadata['Provides']
+ metadata['Provides'] = []
+
+ if requires is not None:
+ # create a metadata instance to handle the reqs injection
+ metadata['Requires-Dist'] = requires
+
+ metadata.write(metadata_path)
installer_path = distinfo['installer_path']
logger.info('creating %s', installer_path)
diff --git a/distutils2/version.py b/distutils2/version.py
--- a/distutils2/version.py
+++ b/distutils2/version.py
@@ -57,7 +57,8 @@
1.2a # release level must have a release serial
1.2.3b
"""
- def __init__(self, s, error_on_huge_major_num=True):
+ def __init__(self, s, error_on_huge_major_num=True,
+ drop_trailing_zeros=False):
"""Create a NormalizedVersion instance from a version string.
@param s {str} The version string.
@@ -74,8 +75,12 @@
and, e.g. downstream Linux package managers, will forever remove
the possibility of using a version number like "1.0" (i.e.
where the major number is less than that huge major number).
+ @param drop_trailing_zeros {bool} Whether to drop trailing zeros
+
+ from the returned list. Default True.
"""
self.is_final = True # by default, consider a version as final.
+ self.drop_trailing_zeros = drop_trailing_zeros
self._parse(s, error_on_huge_major_num)
@classmethod
@@ -93,7 +98,7 @@
parts = []
# main version
- block = self._parse_numdots(groups['version'], s, False, 2)
+ block = self._parse_numdots(groups['version'], s, 2)
extraversion = groups.get('extraversion')
if extraversion not in ('', None):
block += self._parse_numdots(extraversion[1:], s)
@@ -130,16 +135,13 @@
raise HugeMajorVersionNumError("huge major version number, %r, "
"which might cause future problems: %r" % (self.parts[0][0], s))
- def _parse_numdots(self, s, full_ver_str, drop_trailing_zeros=True,
- pad_zeros_length=0):
+ def _parse_numdots(self, s, full_ver_str, pad_zeros_length=0):
"""Parse 'N.N.N' sequences, return a list of ints.
@param s {str} 'N.N.N...' sequence to be parsed
@param full_ver_str {str} The full version string from which this
comes. Used for error strings.
- @param drop_trailing_zeros {bool} Whether to drop trailing zeros
- from the returned list. Default True.
- @param pad_zeros_length {int} The length to which to pad the
+ @param pad_zeros_length {int} The length to which to pad the
returned list with zeros, if necessary. Default 0.
"""
nums = []
@@ -148,7 +150,7 @@
raise IrrationalVersionError("cannot have leading zero in "
"version number segment: '%s' in %r" % (n, full_ver_str))
nums.append(int(n))
- if drop_trailing_zeros:
+ if self.drop_trailing_zeros:
while nums and nums[-1] == 0:
nums.pop()
while len(nums) < pad_zeros_length:
diff --git a/docs/Makefile b/docs/Makefile
deleted file mode 100644
--- a/docs/Makefile
+++ /dev/null
@@ -1,89 +0,0 @@
-# Makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line.
-SPHINXOPTS =
-SPHINXBUILD = sphinx-build
-PAPER =
-BUILDDIR = build
-
-# Internal variables.
-PAPEROPT_a4 = -D latex_paper_size=a4
-PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
-
-.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
-
-help:
- @echo "Please use \`make <target>' where <target> is one of"
- @echo " html to make standalone HTML files"
- @echo " dirhtml to make HTML files named index.html in directories"
- @echo " pickle to make pickle files"
- @echo " json to make JSON files"
- @echo " htmlhelp to make HTML files and a HTML help project"
- @echo " qthelp to make HTML files and a qthelp project"
- @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
- @echo " changes to make an overview of all changed/added/deprecated items"
- @echo " linkcheck to check all external links for integrity"
- @echo " doctest to run all doctests embedded in the documentation (if enabled)"
-
-clean:
- -rm -rf $(BUILDDIR)/*
-
-html:
- $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
- @echo
- @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
-
-dirhtml:
- $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
- @echo
- @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
-
-pickle:
- $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
- @echo
- @echo "Build finished; now you can process the pickle files."
-
-json:
- $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
- @echo
- @echo "Build finished; now you can process the JSON files."
-
-htmlhelp:
- $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
- @echo
- @echo "Build finished; now you can run HTML Help Workshop with the" \
- ".hhp project file in $(BUILDDIR)/htmlhelp."
-
-qthelp:
- $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
- @echo
- @echo "Build finished; now you can run "qcollectiongenerator" with the" \
- ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
- @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Distutils2.qhcp"
- @echo "To view the help file:"
- @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Distutils2.qhc"
-
-latex:
- $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
- @echo
- @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
- @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
- "run these through (pdf)latex."
-
-changes:
- $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
- @echo
- @echo "The overview file is in $(BUILDDIR)/changes."
-
-linkcheck:
- $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
- @echo
- @echo "Link check complete; look for any errors in the above output " \
- "or in $(BUILDDIR)/linkcheck/output.txt."
-
-doctest:
- $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
- @echo "Testing of doctests in the sources finished, look at the " \
- "results in $(BUILDDIR)/doctest/output.txt."
diff --git a/docs/design/configfile.rst b/docs/design/configfile.rst
deleted file mode 100644
--- a/docs/design/configfile.rst
+++ /dev/null
@@ -1,132 +0,0 @@
-.. _setup-config:
-
-************************************
-Writing the Setup Configuration File
-************************************
-
-Often, it's not possible to write down everything needed to build a distribution
-*a priori*: you may need to get some information from the user, or from the
-user's system, in order to proceed. As long as that information is fairly
-simple---a list of directories to search for C header files or libraries, for
-example---then providing a configuration file, :file:`setup.cfg`, for users to
-edit is a cheap and easy way to solicit it. Configuration files also let you
-provide default values for any command option, which the installer can then
-override either on the command line or by editing the config file.
-
-The setup configuration file is a useful middle-ground between the setup script
----which, ideally, would be opaque to installers [#]_---and the command line to
-the setup script, which is outside of your control and entirely up to the
-installer. In fact, :file:`setup.cfg` (and any other Distutils configuration
-files present on the target system) are processed after the contents of the
-setup script, but before the command line. This has several useful
-consequences:
-
-.. If you have more advanced needs, such as determining which extensions to
- build based on what capabilities are present on the target system, then you
- need the Distutils auto-configuration facility. This started to appear in
- Distutils 0.9 but, as of this writing, isn't mature or stable enough yet
- for real-world use.
-
-* installers can override some of what you put in :file:`setup.py` by editing
- :file:`setup.cfg`
-
-* you can provide non-standard defaults for options that are not easily set in
- :file:`setup.py`
-
-* installers can override anything in :file:`setup.cfg` using the command-line
- options to :file:`setup.py`
-
-The basic syntax of the configuration file is simple::
-
- [command]
- option=value
- ...
-
-where *command* is one of the Distutils commands (e.g. :command:`build_py`,
-:command:`install`), and *option* is one of the options that command supports.
-Any number of options can be supplied for each command, and any number of
-command sections can be included in the file. Blank lines are ignored, as are
-comments, which run from a ``'#'`` character until the end of the line. Long
-option values can be split across multiple lines simply by indenting the
-continuation lines.
-
-You can find out the list of options supported by a particular command with the
-universal :option:`--help` option, e.g. ::
-
- > python setup.py --help build_ext
- [...]
- Options for 'build_ext' command:
- --build-lib (-b) directory for compiled extension modules
- --build-temp (-t) directory for temporary files (build by-products)
- --inplace (-i) ignore build-lib and put compiled extensions into the
- source directory alongside your pure Python modules
- --include-dirs (-I) list of directories to search for header files
- --define (-D) C preprocessor macros to define
- --undef (-U) C preprocessor macros to undefine
- --swig-opts list of SWIG command-line options
- [...]
-
-.. XXX do we want to support ``setup.py --help metadata``?
-
-Note that an option spelled :option:`--foo-bar` on the command line is spelled
-:option:`foo_bar` in configuration files.
-
-For example, say you want your extensions to be built "in-place"---that is, you
-have an extension :mod:`pkg.ext`, and you want the compiled extension file
-(:file:`ext.so` on Unix, say) to be put in the same source directory as your
-pure Python modules :mod:`pkg.mod1` and :mod:`pkg.mod2`. You can always use the
-:option:`--inplace` option on the command line to ensure this::
-
- python setup.py build_ext --inplace
-
-But this requires that you always specify the :command:`build_ext` command
-explicitly, and remember to provide :option:`--inplace`. An easier way is to
-"set and forget" this option, by encoding it in :file:`setup.cfg`, the
-configuration file for this distribution::
-
- [build_ext]
- inplace=1
-
-This will affect all builds of this module distribution, whether or not you
-explicitly specify :command:`build_ext`. If you include :file:`setup.cfg` in
-your source distribution, it will also affect end-user builds---which is
-probably a bad idea for this option, since always building extensions in-place
-would break installation of the module distribution. In certain peculiar cases,
-though, modules are built right in their installation directory, so this is
-conceivably a useful ability. (Distributing extensions that expect to be built
-in their installation directory is almost always a bad idea, though.)
-
-Another example: certain commands take a lot of options that don't change from
-run to run; for example, :command:`bdist_rpm` needs to know everything required
-to generate a "spec" file for creating an RPM distribution. Some of this
-information comes from the setup script, and some is automatically generated by
-the Distutils (such as the list of files installed). But some of it has to be
-supplied as options to :command:`bdist_rpm`, which would be very tedious to do
-on the command line for every run. Hence, here is a snippet from the Distutils'
-own :file:`setup.cfg`::
-
- [bdist_rpm]
- release = 1
- packager = Greg Ward <gward at python.net>
- doc_files = CHANGES.txt
- README.txt
- USAGE.txt
- doc/
- examples/
-
-Note that the :option:`doc_files` option is simply a whitespace-separated string
-split across multiple lines for readability.
-
-
-.. seealso::
-
- :ref:`inst-config-syntax` in "Installing Python Modules"
- More information on the configuration files is available in the manual for
- system administrators.
-
-
-.. rubric:: Footnotes
-
-.. [#] This ideal probably won't be achieved until auto-configuration is fully
- supported by the Distutils.
-
diff --git a/docs/design/pep-0376.txt b/docs/design/pep-0376.txt
deleted file mode 100644
--- a/docs/design/pep-0376.txt
+++ /dev/null
@@ -1,698 +0,0 @@
-PEP: 376
-Title: Changing the .egg-info structure
-Version: $Revision: 75414 $
-Last-Modified: $Date: 2009-10-14 14:39:17 -0400 (Wed, 14 Oct 2009) $
-Author: Tarek Ziadé <tarek at ziade.org>
-Status: Draft
-Type: Standards Track
-Content-Type: text/x-rst
-Created: 22-Feb-2009
-Python-Version: 2.7, 3.2
-Post-History:
-
-
-Abstract
-========
-
-This PEP proposes various enhancements for Distutils:
-
-- A new format for the .egg-info structure.
-- Some APIs to read the metadata of a distribution.
-- A replacement PEP 262.
-- An uninstall feature.
-
-Definitions
-===========
-
-A **distribution** is a collection of files, which can be Python modules,
-extensions, or data. A distribution is managed by a special module called
-`setup.py` which contains a call to the `distutils.core.setup` function.
-The arguments passed to that function describe the distribution, like
-its `name`, its `version`, and so on.
-
-Distutils provides, among other things, **commands** that can be called
-through the shell using the `setup.py` script. An `sdist` command is provided
-for instance to create a source distribution archive. An `install` command
-is also provided to perform an installation of the distribution in the Python
-installation the script is invoked with::
-
- $ python setup.py install
-
-See the Distutils [#distutils]_ documentation for more information.
-
-Once installed, the elements are located in various places in the system, like:
-
-- In Python's site-packages (Python modules, Python modules organized into
- packages, Extensions, etc.)
-- In Python's `include` directory.
-- In Python's `bin` or `Script` directory.
-- Etc.
-
-Rationale
-=========
-
-There are two problems right now in the way distributions are installed in
-Python:
-
-- There are too many ways to do it.
-- There is no API to get the metadata of installed distributions.
-
-How distributions are installed
--------------------------------
-
-Right now, when a distribution is installed in Python, the elements it
-contains are installed in various directories.
-
-The pure Python code, for instance, is installed in the `purelib` directory
-which is located in the Python installation at ``lib/python2.6/site-packages``
-for example under Unix-like systems or Mac OS X, and in ``Lib\site-packages``
-under Windows. This is done with the Distutils `install` command, which calls
-various subcommands.
-
-The `install_egg_info` subcommand is called during this process in order to
-create an `.egg-info` file in the `purelib` directory.
-
-For example, for the `docutils` distribution, which contains one package an
-extra module and executable scripts, three elements are installed in
-`site-packages`:
-
-- `docutils`: The ``docutils`` package.
-- `roman.py`: An extra module used by `docutils`.
-- `docutils-0.5-py2.6.egg-info`: A file containing the distribution metadata
- as described in PEP 314 [#pep314]_. This file corresponds to the file
- called `PKG-INFO`, built by the `sdist` command.
-
-Some executable scripts, such as `rst2html.py`, are also be added in the
-`bin` directory of the Python installation.
-
-Another project called `setuptools` [#setuptools]_ has two other formats
-to install distributions, called `EggFormats` [#eggformats]_:
-
-- a self-contained `.egg` directory, that contains all the distribution files
- and the distribution metadata in a file called `PKG-INFO` in a subdirectory
- called `EGG-INFO`. `setuptools` creates other fils in that directory that can
- be considered as complementary metadata.
-
-- a `.egg-info` directory installed in `site-packages`, that contains the same
- files `EGG-INFO` has in the `.egg` format.
-
-The first format is automatically used when you install a distribution that
-uses the ``setuptools.setup`` function in its setup.py file, instead of
-the ``distutils.core.setup`` one.
-
-The `setuptools` project also provides an executable script called
-`easy_install` [#easyinstall]_ that installs all distributions, including
-distutils-based ones in self-contained `.egg` directories.
-
-If you want to have a standalone `.egg.info` directory distributions, e.g.
-the second `setuptools` format, you have to force it when you work
-with a setuptools-based distribution or with the `easy_install` script.
-You can force it by using the `-–single-version-externally-managed` option
-**or** the `--root` option.
-
-This option is used by :
-
-- the `pip` [#pip]_ installer
-- the Fedora packagers [#fedora]_.
-- the Debian packagers [#debian]_.
-
-Uninstall information
----------------------
-
-Distutils doesn't provide an `uninstall` command. If you want to uninstall
-a distribution, you have to be a power user and remove the various elements
-that were installed, and then look over the `.pth` file to clean them if
-necessary.
-
-And the process differs depending on the tools you have used to install the
-distribution and if the distribution's `setup.py` uses Distutils or
-Setuptools.
-
-Under some circumstances, you might not be able to know for sure that you
-have removed everything, or that you didn't break another distribution by
-removing a file that is shared among several distributions.
-
-But there's a common behavior: when you install a distribution, files are
-copied in your system. And it's possible to keep track of these files for
-later removal.
-
-What this PEP proposes
-----------------------
-
-To address those issues, this PEP proposes a few changes:
-
-- A new `.egg-info` structure using a directory, based on one format of
- the `EggFormats` standard from `setuptools`.
-- New APIs in `pkgutil` to be able to query the information of installed
- distributions.
-- A de-facto replacement for PEP 262
-- An uninstall function and an uninstall script in Distutils.
-
-
-.egg-info becomes a directory
-=============================
-
-As explained earlier, the `EggFormats` standard from `setuptools` proposes two
-formats to install the metadata information of a distribution:
-
-- A self-contained directory that can be zipped or left unzipped and contains
- the distribution files *and* an `.egg-info` directory containing the
- metadata.
-
-- A distinct `.egg-info` directory located in the site-packages directory,
- with the metadata inside.
-
-This PEP proposes to keep just one format and make it the standard way to
-install the metadata of a distribution : a distinct `.egg-info` directory
-located in the site-packages directory, containing the metadata.
-
-This `.egg-info` directory contains a `PKG-INFO` file built by the
-`write_pkg_file` method of the `Distribution` class in Distutils.
-
-This change does not impact Python itself because the metadata files are not
-used anywhere yet in the standard library besides Distutils.
-
-It does impact the `setuptools` and `pip` projects, but given the fact that
-they already work with a directory that contains a `PKG-INFO` file, the change
-will have no deep consequences.
-
-Let's take an example of the new format with the `docutils` distribution.
-The elements installed in `site-packages` are::
-
- - docutils/
- - roman.py
- - docutils-0.5.egg-info/
- PKG-INFO
-
-The syntax of the egg-info directory name is as follows::
-
- name + '-' + version + '.egg-info'
-
-The egg-info directory name is created using a new function called
-``egginfo_dirname(name, version)`` added to ``pkgutil``. ``name`` is
-converted to a standard distribution name by replacing any runs of
-non-alphanumeric characters with a single '-'. ``version`` is converted
-to a standard version string. Spaces become dots, and all other
-non-alphanumeric characters (except dots) become dashes, with runs of
-multiple dashes condensed to a single dash. Both attributes are then
-converted into their filename-escaped form, i.e. any '-' characters are
-replaced with '_' other than the one in 'egg-info' and the one
-separating the name from the version number.
-
-Examples::
-
- >>> egginfo_dirname('docutils', '0.5')
- 'docutils-0.5.egg-info'
-
- >>> egginfo_dirname('python-ldap', '2.5')
- 'python_ldap-2.5.egg-info'
-
- >>> egginfo_dirname('python-ldap', '2.5 a---5')
- 'python_ldap-2.5.a_5.egg-info'
-
-Adding a RECORD file in the .egg-info directory
-===============================================
-
-A `RECORD` file is added inside the `.egg-info` directory at installation
-time when installing a source distribution using the `install` command.
-Notice that when installing a binary distribution created with `bdist` command
-or a `bdist`-based command, the `RECORD` file will be installed as well since
-these commands use the `install` command to create a binary distributions.
-
-The `RECORD` file holds the list of installed files. These correspond
-to the files listed by the `record` option of the `install` command, and will
-be generated by default. This allows the implementation of an uninstallation
-feature, as explained later in this PEP. The `install` command also provides
-an option to prevent the `RECORD` file from being written and this option
-should be used when creating system packages.
-
-Third-party installation tools also should not overwrite or delete files
-that are not in a RECORD file without prompting or warning.
-
-This RECORD file is inspired from PEP 262 FILES [#pep262]_.
-
-The RECORD format
------------------
-
-The `RECORD` file is a CSV file, composed of records, one line per
-installed file. The ``csv`` module is used to read the file, with
-these options:
-
-- field delimiter : `,`
-- quoting char : `"`.
-- line terminator : ``os.linesep`` (so ``\r\n`` or ``\n``)
-
-Each record is composed of three elements.
-
-- the file's full **path**
-
- - if the installed file is located in the directory where the `.egg-info`
- directory of the package is located, it's a '/'-separated relative
- path, no matter what the target system is. This makes this information
- cross-compatible and allows simple installations to be relocatable.
-
- - if the installed file is located under ``sys.prefix`` or
- `sys.exec_prefix``, it's a it's a '/'-separated relative path prefixed
- by the `$PREFIX` or the `$EXEC_PREFIX` string. The `install` command
- decides which prefix to use depending on the files. For instance if
- it's an executable script defined in the `scripts` option of the
- setup script, `$EXEC_PREFIX` will be used. If `install` doesn't know
- which prefix to use, `$PREFIX` is preferred.
-
-- the **MD5** hash of the file, encoded in hex. Notice that `pyc` and `pyo`
- generated files don't have any hash because they are automatically produced
- from `py` files. So checking the hash of the corresponding `py` file is
- enough to decide if the file and its associated `pyc` or `pyo` files have
- changed.
-
-- the file's size in bytes
-
-The ``csv`` module is used to generate this file, so the field separator is
-",". Any "," characters found within a field is escaped automatically by ``csv``.
-
-When the file is read, the `U` option is used so the universal newline
-support (see PEP 278 [#pep278]_) is activated, avoiding any trouble
-reading a file produced on a platform that uses a different new line
-terminator.
-
-Example
--------
-
-Back to our `docutils` example, we now have::
-
- - docutils/
- - roman.py
- - docutils-0.5.egg-info/
- PKG-INFO
- RECORD
-
-And the RECORD file contains (extract)::
-
- docutils/__init__.py,b690274f621402dda63bf11ba5373bf2,9544
- docutils/core.py,9c4b84aff68aa55f2e9bf70481b94333,66188
- roman.py,a4b84aff68aa55f2e9bf70481b943D3,234
- $EXEC_PREFIX/bin/rst2html.py,a4b84aff68aa55f2e9bf70481b943D3,234
- docutils-0.5.egg-info/PKG-INFO,6fe57de576d749536082d8e205b77748,195
- docutils-0.5.egg-info/RECORD
-
-Notice that:
-
-- the `RECORD` file can't contain a hash of itself and is just mentioned here
-- `docutils` and `docutils-0.5.egg-info` are located in `site-packages` so the file
- paths are relative to it.
-
-Adding an INSTALLER file in the .egg-info directory
-===================================================
-
-The `install` command has a new option called `installer`. This option
-is the name of the tool used to invoke the installation. It's an normalized
-lower-case string matching `[a-z0-9_\-\.]`.
-
- $ python setup.py install --installer=pkg-system
-
-It defaults to `distutils` if not provided.
-
-When a distribution is installed, the INSTALLER file is generated in the
-`.egg-info` directory with this value, to keep track of **who** installed the
-distribution. The file is a single-line text file.
-
-Adding a REQUESTED file in the .egg-info directory
-==================================================
-
-If a distribution is installed by direct user request (the usual
-case), a file REQUESTED is added to the .egg-info directory of the
-installed distribution. The REQUESTED file may be empty, or may
-contain a marker comment line beginning with the "#" character.
-
-If an install tool installs a distribution automatically, as a
-dependency of another distribution, the REQUESTED file should not be
-created.
-
-The ``install`` command of distutils by default creates the REQUESTED
-file. It accepts --requested and --no-requested options to explicitly
-specify whether the file is created.
-
-If a package that was already installed on the system as a dependency
-is later installed by name, the distutils ``install`` command will
-create the REQUESTED file in the .egg-info directory of the existing
-installation.
-
-Rationale
----------
-
-Some install tools automatically detect unfulfilled dependencies and
-install them. These tools may also want to be able to alert the user
-if distributions are left on the system in an "orphan" state:
-installed as a dependency of another distribution, which has since
-been removed.
-
-In order to provide information about orphaned dependencies, knowing
-the dependency graph for installed distributions does not suffice (a
-package that is not required by any other package may be on the system
-because the user needs it directly). It is also necessary to know, for
-each installed package, one additional bit of information: whether it
-was installed "by request" or solely as a dependency.
-
-Each (un)install tool could of course record that bit in its own
-separate metadata cache, but this will break down if multiple tools
-are used to work with installed packages on the same system. If
-distutils takes care of this bit of metadata in a standard way,
-multiple tools can cooperate and correctly handle orphaned
-dependencies.
-
-(In contrast, it is not necessary for distutils to record or manage
-the full dependency graph for installed packages, because the list of
-installed packages and their dependency metadata, standardized in PEP
-345, allow any tool to independently calculate the dependency graph.)
-
-An (un)installer tool which works with dependencies could use the
-REQUESTED metadata for orphan detection as follows: an orphaned
-distribution is any installed distribution that doesn't have a
-REQUESTED file and is not required by any other installed
-distribution.
-
-The availability of the REQUESTED metadata of course does not obligate
-any tool to provide this orphan-detection feature, or to implement it
-in a certain way; for instance, distutils has no opinion about whether
-tools should automatically remove newly-orphaned dependencies at
-uninstall time.
-
-
-New APIs in pkgutil
-===================
-
-To use the `.egg-info` directory content, we need to add in the standard
-library a set of APIs. The best place to put these APIs is `pkgutil`.
-
-Query functions
----------------
-
-The new functions added in the ``pkgutil`` are :
-
-- ``get_distributions()`` -> iterator of ``Distribution`` instances.
-
- Provides an iterator that looks for ``.egg-info`` directories in
- ``sys.path`` and returns ``Distribution`` instances for
- each one of them.
-
-- ``get_distribution(name)`` -> ``Distribution`` or None.
-
- Scans all elements in ``sys.path`` and looks for all directories ending with
- ``.egg-info``. Returns a ``Distribution`` corresponding to the
- ``.egg-info`` directory that contains a PKG-INFO that matches `name`
- for the `name` metadata.
-
- Notice that there should be at most one result. The first result found
- is returned. If the directory is not found, returns None.
-
-- ``get_file_users(path)`` -> iterator of ``Distribution`` instances.
-
- Iterates over all distributions to find out which distributions uses ``path``.
- ``path`` can be a local absolute path or a relative '/'-separated path.
-
-Distribution class
-------------------
-
-A new class called ``Distribution`` is created with the path of the
-`.egg-info` directory provided to the constructor. It reads the metadata
-contained in `PKG-INFO` when it is instantiated.
-
-``Distribution(path)`` -> instance
-
- Creates a ``Distribution`` instance for the given ``path``.
-
-``Distribution`` provides the following attributes:
-
-- ``name``: The name of the distribution.
-
-- ``metadata``: A ``Metadata`` instance loaded with the
- distribution's PKG-INFO file.
-
-- ``requested``: A boolean that indicates whether the REQUESTED
- metadata file is present (in other words, whether the package was
- installed by user request).
-
-And following methods:
-
-- ``get_installed_files(local=False)`` -> iterator of (path, md5, size)
-
- Iterates over the `RECORD` entries and return a tuple ``(path, md5, size)``
- for each line. If ``local`` is ``True``, the path is transformed into a
- local absolute path. Otherwise the raw value from `RECORD` is returned.
-
- A local absolute path is an absolute path in which occurrences of '/'
- have been replaced by the system separator given by ``os.sep``.
-
-- ``uses(path)`` -> Boolean
-
- Returns ``True`` if ``path`` is listed in `RECORD`. ``path``
- can be a local absolute path or a relative '/'-separated path.
-
-- ``get_egginfo_file(path, binary=False)`` -> file object
-
- Returns a file located under the `.egg-info` directory.
-
- Returns a ``file`` instance for the file pointed by ``path``.
-
- ``path`` has to be a '/'-separated path relative to the `.egg-info`
- directory or an absolute path.
-
- If ``path`` is an absolute path and doesn't start with the `.egg-info`
- directory path, a ``DistutilsError`` is raised.
-
- If ``binary`` is ``True``, opens the file in read-only binary mode (`rb`),
- otherwise opens it in read-only mode (`r`).
-
-- ``get_egginfo_files(local=False)`` -> iterator of paths
-
- Iterates over the `RECORD` entries and return paths for each line if the path
- is pointing a file located in the `.egg-info` directory or one of its
- subdirectory.
-
- If ``local`` is ``True``, each path is transformed into a
- local absolute path. Otherwise the raw value from `RECORD` is returned.
-
-
-Notice that the API is organized in five classes that work with directories
-and Zip files (so it works with files included in Zip files, see PEP 273 for
-more details [#pep273]_). These classes are described in the documentation
-of the prototype implementation for interested readers [#prototype]_.
-
-Usage example
--------------
-
-Let's use some of the new APIs with our `docutils` example::
-
- >>> from pkgutil import get_distribution, get_file_users
- >>> dist = get_distribution('docutils')
- >>> dist.name
- 'docutils'
- >>> dist.metadata.version
- '0.5'
-
- >>> for path, hash, size in dist.get_installed_files()::
- ... print '%s %s %d' % (path, hash, size)
- ...
- docutils/__init__.py b690274f621402dda63bf11ba5373bf2 9544
- docutils/core.py 9c4b84aff68aa55f2e9bf70481b94333 66188
- roman.py a4b84aff68aa55f2e9bf70481b943D3 234
- /usr/local/bin/rst2html.py a4b84aff68aa55f2e9bf70481b943D3 234
- docutils-0.5.egg-info/PKG-INFO 6fe57de576d749536082d8e205b77748 195
- docutils-0.5.egg-info/RECORD None None
-
- >>> dist.uses('docutils/core.py')
- True
-
- >>> dist.uses('/usr/local/bin/rst2html.py')
- True
-
- >>> dist.get_egginfo_file('PKG-INFO')
- <open file at ...>
-
- >>> dist.requested
- True
-
-PEP 262 replacement
-===================
-
-In the past an attempt was made to create a installation database (see PEP 262
-[#pep262]_).
-
-Extract from PEP 262 Requirements:
-
- " We need a way to figure out what distributions, and what versions of
- those distributions, are installed on a system..."
-
-
-Since the APIs proposed in the current PEP provide everything needed to meet
-this requirement, PEP 376 replaces PEP 262 and becomes the official
-`installation database` standard.
-
-The new version of PEP 345 (XXX work in progress) extends the Metadata
-standard and fullfills the requirements described in PEP 262, like the
-`REQUIRES` section.
-
-Adding an Uninstall function
-============================
-
-Distutils already provides a very basic way to install a distribution, which
-is running the `install` command over the `setup.py` script of the
-distribution.
-
-Distutils will provide a very basic ``uninstall`` function, that is added
-in ``distutils.util`` and takes the name of the distribution to uninstall
-as its argument. ``uninstall`` uses the APIs described earlier and remove all
-unique files, as long as their hash didn't change. Then it removes empty
-directories left behind.
-
-``uninstall`` returns a list of uninstalled files::
-
- >>> from distutils.util import uninstall
- >>> uninstall('docutils')
- ['/opt/local/lib/python2.6/site-packages/docutils/core.py',
- ...
- '/opt/local/lib/python2.6/site-packages/docutils/__init__.py']
-
-If the distribution is not found, a ``DistutilsUninstallError`` is be raised.
-
-Filtering
----------
-
-To make it a reference API for third-party projects that wish to control
-how `uninstall` works, a second callable argument can be used. It's
-called for each file that is removed. If the callable returns `True`, the
-file is removed. If it returns False, it's left alone.
-
-Examples::
-
- >>> def _remove_and_log(path):
- ... logging.info('Removing %s' % path)
- ... return True
- ...
- >>> uninstall('docutils', _remove_and_log)
-
- >>> def _dry_run(path):
- ... logging.info('Removing %s (dry run)' % path)
- ... return False
- ...
- >>> uninstall('docutils', _dry_run)
-
-Of course, a third-party tool can use ``pkgutil`` APIs to implement
-its own uninstall feature.
-
-Installer marker
-----------------
-
-As explained earlier in this PEP, the `install` command adds an `INSTALLER`
-file in the `.egg-info` directory with the name of the installer.
-
-To avoid removing distributions that where installed by another packaging system,
-the ``uninstall`` function takes an extra argument ``installer`` which default
-to ``distutils``.
-
-When called, ``uninstall`` controls that the ``INSTALLER`` file matches
-this argument. If not, it raises a ``DistutilsUninstallError``::
-
- >>> uninstall('docutils')
- Traceback (most recent call last):
- ...
- DistutilsUninstallError: docutils was installed by 'cool-pkg-manager'
-
- >>> uninstall('docutils', installer='cool-pkg-manager')
-
-This allows a third-party application to use the ``uninstall`` function
-and strongly suggest that no other program remove a distribution it has
-previously installed. This is useful when a third-party program that relies
-on Distutils APIs does extra steps on the system at installation time,
-it has to undo at uninstallation time.
-
-Adding an Uninstall script
-==========================
-
-An `uninstall` script is added in Distutils. and is used like this::
-
- $ python -m distutils.uninstall packagename
-
-Notice that script doesn't control if the removal of a distribution breaks
-another distribution. Although it makes sure that all the files it removes
-are not used by any other distribution, by using the uninstall function.
-
-Also note that this uninstall script pays no attention to the
-REQUESTED metadata; that is provided only for use by external tools to
-provide more advanced dependency management.
-
-Backward compatibility and roadmap
-==================================
-
-These changes don't introduce any compatibility problems with the previous
-version of Distutils, and will also work with existing third-party tools.
-
-The plan is to include the functionality outlined in this PEP in distutils for
-Python 2.7 and Python 3.2. A backport of the new distutils for 2.5, 2.6, 3.0
-and 3.1 is provided so people can benefit from these new features.
-
-Distributions installed using existing, pre-standardization formats do not have
-the necessary metadata available for the new API, and thus will be
-ignored. Third-party tools may of course continue to support previous
-formats in addition to the new format, in order to ease the transition.
-
-
-References
-==========
-
-.. [#distutils]
- http://docs.python.org/distutils
-
-.. [#pep262]
- http://www.python.org/dev/peps/pep-0262
-
-.. [#pep314]
- http://www.python.org/dev/peps/pep-0314
-
-.. [#setuptools]
- http://peak.telecommunity.com/DevCenter/setuptools
-
-.. [#easyinstall]
- http://peak.telecommunity.com/DevCenter/EasyInstall
-
-.. [#pip]
- http://pypi.python.org/pypi/pip
-
-.. [#eggformats]
- http://peak.telecommunity.com/DevCenter/EggFormats
-
-.. [#pep273]
- http://www.python.org/dev/peps/pep-0273
-
-.. [#pep278]
- http://www.python.org/dev/peps/pep-0278
-
-.. [#fedora]
- http://fedoraproject.org/wiki/Packaging/Python/Eggs#Providing_Eggs_using_Setuptools
-
-.. [#debian]
- http://wiki.debian.org/DebianPython/NewPolicy
-
-.. [#prototype]
- http://bitbucket.org/tarek/pep376/
-
-Acknowledgements
-================
-
-Jim Fulton, Ian Bicking, Phillip Eby, and many people at Pycon and Distutils-SIG.
-
-Copyright
-=========
-
-This document has been placed in the public domain.
-
-
-
-..
- Local Variables:
- mode: indented-text
- indent-tabs-mode: nil
- sentence-end-double-space: t
- fill-column: 70
- coding: utf-8
- End:
diff --git a/docs/design/wiki.rst b/docs/design/wiki.rst
deleted file mode 100644
--- a/docs/design/wiki.rst
+++ /dev/null
@@ -1,637 +0,0 @@
-======================
-PyCon packaging sprint
-======================
-
-.. contents::
-
-We sprinted on Distutils2 at the US Pycon 2010 sessions. This is one
-of the results of that work.
-
-Distutils is used by both developers and packagers.
-
-:developers: People who write code in python. The code may be
- distributed as an sdist or a variety of binary versions. The
- developer presently uses setup.py to tell distutils how to build
- the sdist and binary packages.
-:packagers: People who package sdists into binary packages for a Linux
- distribution. (Is there an equivalent role for people who make
- Windows binary packages? Or do developers generally do that for
- their own packages?)
-
-----------------------
-Problems for packagers
-----------------------
-
-We identified specific problems packagers face when creating deb/rpm:
-
-The problem this document is intended to solve: **want to lay out files across the filesystem in a FHS-compliant way**
-
-Problems that are fixed simply by not using setuptools:
-
-- get rid of ez_setup.py
-
-- breakages using ez_setup => Some setup.py scripts import ez_setup.
- ez_setup requires a specific version of setuptools but doesn't
- actually need it -- lesser versions work fine.
-
-Problems that are out of scope, at least for now:
-
-- Requires that are for a specific version (or range) because of bugs
- (not API change/features) but the distro packages have backported
- the fixes needed to an earlier version:
-
-- differences between distribution names of packages e.g. "what are
- the packages of NumPy called?"
-
-- Egg version (specified in a Require section in setup.py) doesn't
- match the distro package version
- https://www.redhat.com/archives/fedora-python-devel-list/2008-June/msg00002.html
-
-We want to solve these issues for Linux distribution packages without
-negatively impacting Windows, OS X, or pure-python
-(i.e. easy_install/pip/virtualenv) installs.
-
-Example problem with current distutils
-======================================
-
-In
-http://docs.python.org/distutils/setupscript.html#installing-additional-files
-there is this example of supplying an initscript within a setup.py::
-
- setup(...,
- data_files=[('bitmaps', ['bm/b1.gif', 'bm/b2.gif']),
- ('config', ['cfg/data.cfg']),
- ('/etc/init.d', ['init-script'])]
- )
-
-This suffers from several problems:
-
-1. The file hardcodes "/etc/init.d" as the directory for installation
- of the initscript. However, this varies between different Linux
- distributions. The above example assumes SysV init, but isn't
- correct for systems using Upstart (the initscripts are likely to
- need to be different for this case). Even within systems using
- SysV init, the content of the script can vary between different
- distributions
-
-2. The FHS mandates that configuration files go below /etc, but on a
- Windows box that's meaningless.
-
-3. The file is a python script: if we want to extract data from it, we
- have to either run it, or somehow parse it; we would need to
- sandbox. We would prefer a declarative minilanguage for specifying
- this data.
-
-Similarly: documentation files, .h files (e.g. NumPy)
-
-We want a system that:
-
-1. is easy for developers, does not require an "install" or "build"
- phase during the edit/test development loop in a working copy
-
-2. supports both FHS-compliant scattering across the filesystem
- hierarchy, and Windows, and virtualenv-style trees.
-
------------------------
-Problems for Developers
------------------------
-
-Package/file lists in multiple places
-=====================================
-
-* MANIFEST
-* MANIFEST.in
-* setup.py::data_files
-* setup.py::package_data
-* setup.py::packages
-* setup.py::scripts
-
-Replace all of these with settings in ``setup.cfg`` to specify runtime
-files (python code, resource files) and files that belong in the sdist
-but are not wanted for runtime.
-
-No idea where Linux distros want files
-======================================
-
-Sometimes programmers want to do the right thing for people wanting to
-package their programs in Linux distributions, but they don't know
-where they belong. Making matters worse, the files can go in
-different places on different Linux distributions or on Windows and
-MacOS. Placing the files in the wrong place can lead to errors at
-runtime, for instance, if the file needs to be writable by the module
-but it's placed on a read-only filesystem.
-
-This PEP attempts to deal with this by categorizing files so
-developers can properly mark what properties their files need and
-using an API to access the files, abstracting the different file
-locations on different platforms.
-
-Hard to extend the build commands
-=================================
-
-* distutils documentation is very poor
-
-* distutils build commands are classes with special method names --
- why not simple functions?
-
-* how do you extend the data allowed to be set in entries setup()?
-
-* build commands sometimes need to act on the same arguments. No way
- to pass these between them right now.
-
-
------------------------------------
-Proposed solution for placing files
------------------------------------
-
-This solution attempts to make several pieces of building and
-installing better. It merges the many file lists into a single file,
-simplifies (or eliminates the need for) setup.py, and allows packagers
-to place resource files in locations appropriate to their
-distribution.
-
-This solution comes in three pieces:
-
-1. A ``resources`` section in ``setup.cfg`` that maps resource files
- to their categories (and optionally subdirectory prefixes within
- those categories)
-
-2. A ``sysconfig.cfg`` file at the system Python level that maps
- categories to a position on the filesystem
-
-3. A simple ``pkgutil.open()`` API to access resources from code
-
-Rationale
-=========
-
-1. The evidence (from ``__file__`` usage) is strong that package devs
- want to think in terms of paths within their local dev tree. They
- don't want to worry about categorizing or finding their static
- files elsewhere.
-
-2. Package devs are more likely to use an API that makes them think
- less and type less.
-
-3. Package devs are more likely to accept patches from packagers if
- that patch only touches a single .cfg file, rather than touching
- every single ``pkgutil.open()`` call throughout their code.
-
-Therefore, the ``pkgutil.open()`` call should accept a simple path
-relative to the package/distribution root. The ``resources`` section
-in ``setup.cfg`` uses globs to categorize those files:
-forward-thinking package devs can write this section, or packagers can
-do it for them and submit patches.
-
-
-"resources" section in setup.cfg
-================================
-
-The setup.py file has many sections that need to list files. We plan
-to remove those lists to ``setup.cfg``. The ``resources`` section of
-``setup.cfg`` replaces the current ``package_data``, ``data_files``,
-and ``extra_files`` options in ``setup.py``.
-
-There are three pieces of information that are needed for resource
-files:
-
-1. Position in the source tree
- (e.g. 'mailman/database/schemas/schema.cfg', 'mywidget/jquery.js')
-
-* Position when installed
- (e.g. '/etc/mailman/database/schemas/schema.cfg',
- '/usr/share/mywidget-1.1/javascript/jquery.js'). For simple
- virtualenv-style installations, this may well be the same as (1).
-
-* Key used when referencing the resource from code. Ideally, this
- could be the same as (1), but because of difficulties in finding
- "distribution root" at runtime from a ``pkgutil.open()`` call, it
- will instead have to be a combination of "module name" and "path
- relative to module", similar to what ``pkg_resources`` does.
-
-The information that the developer is concerned with:
-* Position in the source tree
-* Key used in referencing it
-
-The information the downstream packager (RPM/deb/sysadmin) cares about are:
-* Position when installed
-* Key used in referencing it
-
-Example
--------
-
-We have a source tree with the following files::
-
- mailman-1.0/
- README
- some.tpl
- some-new-semantic.sns
- mailman/
- database/
- mailman.db
- schemas/
- blah.schema
- etc/
- my.cnf
- foo/
- some/
- path/
- bar/
- my.cfg
- other.cfg
- developer-docs/
- index.txt
- api/
- toc.txt
-
-Here's where we want the files to end up in a typical Linux distribution:
-
-== ==================================== ===================================================================================================
-## Relative path in source tree Final full installed path
-== ==================================== ===================================================================================================
-1 mailman/database/schemas/blah.schema /var/mailman/schemas/blah.schema
-2 some.tpl /var/mailman/templates/some.tpl
-3 path/to/some.tpl /var/mailman/templates/path/to/some.tpl !
-4 mailman/database/mailman.db /var/mailman/database/mailman.db !
-5 developer-docs/index.txt /usr/share/doc/mailman/developer-docs/index.txt
-6 developer-docs/api/toc.txt /usr/share/doc/mailman/developer-docs/api/toc.txt
-7 README /usr/share/doc/mailman/README
-8 mailman/etc/my.cnf /etc/mailman/my.cnf
-9 mailman/foo/some/path/bar/my.cfg /etc/mailman/baz/some/path/bar/my.cfg AND
- /etc/mailman/hmm/some/path/bar/my.cfg +
- emit a warning
-10 mailman/foo/some/path/other.cfg /etc/mailman/some/path/other.cfg !
-11 some-new-semantic.sns /var/funky/mailman/some-new-semantic.sns
-== ==================================== ===================================================================================================
-
-The numbers in the above placements are referenced below.
-
-setup.cfg
-~~~~~~~~~
-
-The setup.cfg file allows the developer and/or packager to mark what
-categories the files belong to. These are drawn from the types of
-files that the FHS and GNU coding standards define::
-
- [resources]
- # path glob category placement from above table
-
- mailman/database/schemas/* = {appdata}/schemas # 1
- **/*.tpl = {appdata}/templates # 2, 3 # does NOT flatten folder structure in destination
- developer-docs/**/*.txt = {doc} # 5, 6
- README = {doc} # 7
- mailman/etc/* = {config} # 8
- mailman/foo/**/bar/*.cfg = {config}/baz # 9
- mailman/foo/**/*.cfg = {config}/hmm # 9, 10
- some-new-semantic.sns = {funky-crazy-category} # 11
-
-The glob definitions are relative paths that match files from the top
-of the source tree (the location of ``setup.cfg``). Forward slashes
-(only) are used as path separator.
-
-:"*": is a glob that matches any characters within a file or directory
-name
-:"**": is a recursive glob that matches any (or no) characters within a file
-or directory name as well as a forward slash (thus an arbitrarily deep
-number of directories)
-
-The "category" value both categorizes the files and allows for placing
-them in a more fine-grained subdirectory within a category. This value
-must begin with a {category}; raw absolute or relative paths are not
-allowed.
-
-The full Python 3 string interpolation language is not supported, only
-simple {category} substitutions. The {category} is looked up in a
-system-level Python ``sysconfig.cfg`` file, where operating system
-vendors and system administrators can define where in the filesystem
-various types of files are placed. The category paths will generally
-include a {distribution.name} variable, to isolate one package's files
-of a given type from other packages.
-
-As can be seen from the examples above, explicitly-matched directory
-prefixes are stripped from the relative path before it is appended to
-the category location. Glob matches are never stripped (to avoid
-flattening hierarchies and overwriting files). In the
-``mailman/foo/\*\*/\*.cfg`` example, ``mailman/foo`` is removed, but
-not any directories matched by the recursive glob: see entries 9 and
-10 in the example table.
-
-sysconfig.cfg
-~~~~~~~~~~~~~
-
-This is a system-wide Python configuration file (TODO: can be
-overridden by e.g. virtualenv) that defines where on the filesystem
-resources will actually be installed. A sample ``sysconfig.cfg`` can
-be found in the ``distutils2`` repository at
-``src/distutils2/_backport/sysconfig.cfg`` [3].
-
-Links
-
-.. [1] Filesystem Hierarchy Standard http://www.pathname.com/fhs/
-.. [2] Rationale from the FHS which makes the distinctions between parts of the filesystem: http://www.pathname.com/fhs/pub/fhs-2.3.html#THEFILESYSTEM
-.. [3] sample sysconfig.cfg: http://bitbucket.org/tarek/distutils2/src/tip/src/distutils2/_backport/sysconfig.cfg
-
-What happens?
-~~~~~~~~~~~~~
-
-As an example, ``mailman/database/schemas/blah.schema``:
-
-1. The file ``mailman/database/schemas/blah.schema`` in the source
- tree matches ``mailman/database/schemas/*`` within the
- ``resources`` stanza of the setup.cfg, which has right-hand side
- ``{appdata}/schemas``
-
-2. The ``*`` in the left-hand-side matches ``blah.schema``, and the
- initial ``mailman/database/schemas/`` is stripped, so the
- installation path for the file is mapped to
- ``{appdata}/schemas/blah.schema``
-
-3. The label ``appdata`` is listed in the ``sysconfig.cfg`` section
- for the ``posix_prefix`` installation scheme as installed to
- ``/usr/share/{distribution.name}``. This expands out to:
- ``/usr/share/mailman``
-
-4. The result is that the source file
- ``mailman/database/schemas/blah.schema`` is installed to
- ``/var/mailman/schemas/blah.schema``, and this mapping is recorded
- in a RESOURCES file in the installation metadata for the
- distribution.
-
-5. The source code can open the file at runtime via the API call
- ``pkgutil.open('mailman', 'database/schemas/blah.schema')`` (where
- the first argument is an importable Python package name, and the
- second is a path relative to the location of that package), and
- pkgutil will (using the RESOURCES mapping) open it from
- ``/var/mailman/schemas/blah.schema``.
-
-6. If the package is not installed, and thus has no RESOURCES mapping,
- ``pkgutil.open('mailman',
- 'database/schemas/blah.schema')``
-
-1. The file `mailman/database/schemas/blah.schema` in the source tree matches `mailman/database/schemas/*` within the data clause of the setup.cfg, so it is treated as having the label `{data}`.
-2. The clause specified a prefix path, so the installation path for the file is mapped to "schemas/blah.schema"
-3. The label "data" is listed in the [resource_variables] stanza as being installed to "/var/mailman"
-4. The result is that the source file "mailman/database/schemas/blah.schema" is installed within the rpm/deb to "/var/mailman/schemas/blah.schema"
-5. The source code can still open the file via an API using pkgutil.open('mailman', 'database/schemas/blah.schema') and have the underlying system open it from "/var/mailman/schemas/blah.schema".
-
-
-Advice to packagers for fixing file locations
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-There are two places where you might need to change things in order to
-customize the locations that files are installed into. The setup.cfg file can
-be patched if the files are miscategorized. For instance someone marks a help
-file that is used by the app at runtime as {doc} when it should be marked as
-{help}. These types of patches should be submitted to the upstream project.
-The resource_variables file can be changed to define different locations for
-all apps on a system. This should usually be done once in a systemwide file
-for the distribution. Changing this again may require the system packager to
-rebuild all their Python modules to change the file location. There is API in
-pkgutil to allow adding categories to the resource_variables file from
-a script that should be used instead of trying to edit the file with raw text
-processing.
-
-Open issues
-===========
-
-* setup.cfg is in the distribution, not in the module. Thus, in the unbuilt-egg
- case, how can we find the distro when all we have is a module name? It would
- be nice to not need an equivalent of ``setup.py develop``. Can we just walk up
- the folder hierarchy from the module until we find a setup.cfg? A setup.cfg is
- necessary if you use distutils2, is it not?
-
- -> information found in setup.cfg will be put in the *FILES* file upon
- installation in the egg-info directory.
- IOW in the unbuit-egg case, we would need to create that dir, then use
- pkgutil APIs.
-
-* If sysconfig.cfg lands in Python 2.7, what happens when we run distutils2 in
- 2.4?
-
- -> A backport of sysconfig.cfg is provided within the distutils2 distribution.
-
-* Our new glob-based [resources] section is much more compact (and consistent
- with other systems, like bash) than the explicit MANIFEST.in directives, but
- they don't offer some of the old features. Is it okay to lose exclude,
- global-exclude, and recursive-exclude? What do graft and prune do, and do we
- cover their behavior? I think we could probably use a [resource:exclude]
- section with additional exclude globs in it.
-
- -> let's list the use cases we don't cover, and see
-
-API
-===
-
-pkgutil.open
--------------
-
-Returns a file object for the resource.
-
-::
-
- pkgutil.open('STRING_NAME_FOR_PACKAGE', 'filename/with/path/relative/to/the/source/package/directory')
- Example:
- pkgutil.open('mailman', 'database/schemas/blah.schema')
- <open file '/usr/share/mailman/schemas/blah.schema', mode 'r' at 0x7f938e325d78>
-
-* First argument is the string name for a python package.
-* Second argument is the directory path relative to the python package's directory.
-* At install (or build) time we create a metadata file that maps from the source tree files to the files in their installed locations on the filesystem.
-* pkgutil.open() consults the metadata file to decide where to find the resource. If the metadata file is not found (as in a package before the egg is built), open() falls back to traversing the given relative path starting from the root of the calling package (using __name__).
-* pkgutil.open() calls from nested packages aren't a problem because, after all, we pass the desired 'module_name' to start from as the first arg.
-
-* ? Do we still need this? Default behavior: alongside the package files (if the real-installed-locations metadata file does not exist). Or if the package is installed without any resource_variables specified. ?</>?
-
-pkgutil.filename
------------------
-
-Returns a resource's filename with the full path.
-
-::
-
- pkgutil.filename('STRING_NAME_FOR_PACKAGE', 'filename/with/path/relative/to/the/source/package/directory')
- Example:
- pkgutil.filename('mailman', 'database/schemas/blah.schema')
- '/usr/share/mailman/schemas/blah.schema'
-
-pkgutil.add_category
----------------------
-
-Adds a new category to the resource variables filename.
-
-::
-
- pkgutil.add_category('CATEGORY', 'LOCATION')
- Example:
- pkgutil.add_category('lockdir', '{statedir}/lock')
-
-Using the API allows the parser to protect from adding duplicate categories.
-
-----
-Todo
-----
-
-These need to be worked in or discarded somehow
-
- * Differences between applications and packages
- - Applications sometimes want a private library (for instance to do their commandline parsing)
-
-Ideally, for every resource file, the developer (or the defaults) have classified with a "label" *TODO*: we don't have a default classifier right now: for instance::
-
- **/*.txt = doc
- **/*.png = data
- **/*.jpg = data
- **/*.gif = data
- **/*.cfg = config
-
-
-Similar to i18n: marking of strings for translatability: gives you an ID, and a default value
-Analagous to gettext: parse the source, figure out the resources
-
-[X] Per-distro (per site ?): label placement file, mapping labels to system locations *I think this is done*
-
-[X] What strings are valid as labels? only strings that are valid Python 2 identifiers: ([_A-Za-z][_A-Za-z0-9]*) TODO: doublecheck this! *Obsolete* We have gotten rid of the labels
-
-[X] So now, when it comes to building a deb/rpm, we have another file: "label placement" which maps from labels to rules about placement on the filesystem, written once by each linux distribution: *I think this is done*
-
-
-
-How Debian does a .install file
-===============================
-
-In `packagename.install`::
-
- etc/* etc
- usr/* usr
- Products/statusmessages/* usr/share/zope/Products/statusmessages3
-
-Each line has 2 parts:
-* A glob of the source path within the deb
-* Where it should land within the fakeroot (which corresponds to the final installed path)
-
-This gives the packager the opportunity to both move and rename things, and it's fairly concise.
-
-
-Building different packages from one source
-===========================================
-
-?? Do we want to do this??
-
-Use case
---------
-
-Split the docs into a separate sdist from the code so that people can download them separately.
-(Matthias)
-
-Another use case
-----------------
-
-Need to split submodule into its own binary package (essentially converting top-level to a namespace package).
-
-
-
-Alternate ways of specifying labels
------------------------------------
-Noufal's::
-
- [mailman]
- data = *.txt, README
- data.persistent = sqlite.db
-
-----------------------
-
-Tarek's::
-
- [files]
-
- data =
- mailman/database/schemas/*
- *.txt
- README
-
- data.persistent = sqlite.db
-
-----------------------
-
-Toshio's::
-
- [resources]
- *.jpg = data
-
-Alternative Label Idea
-======================
-
-labels for different resource types: images, manpages, script, config files etc, javascript, schema, sql, data files
-
-(those labels impose some other issues - what would one do to differences in statically servable on a webserver versus gtkbuilder can find it)
-
-pkg_resources already provides software with an API::
-
- pkg_resource.open(label='javascript', name='jquery.js')
-
-Then we have the ability for Linux distros to place the different labels in FHS-compliant (or whatever) locations on the filesystem, mapping each label to a fs path::
-
- pkg_resource.open(label='config', name=')
-
- pkg_resource.resource_stream(pkgname='mailman', label='config', victim='schema.cfg')
- pkg_resource.resource_stream('mailman', 'mailman.config', 'schema.cfg')
- pkg_resource.resource_stream('mailman', 'mailman.config', 'schema.cfg', label='config')
-
-analogy with logging:
-
-- with logging: developer sets up streams of data; sysadmin decides what to do with each log stream
-- with packaging: developer sets up streams of data; packaging system decides where to put each one
-
-developer:
-
-(1) everything's within my local working copy; look within it; want to be able to quickly hack on stuff without having to "install" somewhere, for fast edit/test loop
-(2) "setup.py sdist" has given us a zipfile, put it on pypi, someone uses buildout on it
-(3) as (2) but a distribution has moved things to FHS-compliant location
-
-
- pkgutil.open(pkgname='mailman.database.schemas', filename='schema.cfg') # <-- Does this work with our examples below?
-
- pkgutil.open(pkgname='mailman', label='data', filename='schemas/schema.cfg')
-
-(It won't be easy to get package devs to use this API; __file__ feels less magic than some strange call from pkgutil. The simpler the API call and the more "builtin" it looks, the better.)
-
-*TODO* Can we make sane defaults? For instance, can pkgname default to the pkgname or modulename that the call is being made from?
-
-*TODO* can we match things against a range of packages/paths
-
-(1) ./mailman/config/schema.cfg
-(2) .
-(3) /etc/mailman/database/schemas/schema.cfg
-
-mapping from labels to dirs::
-
- distro_dict = {
- 'config':'/etc',
- 'mandir':'/usr/share/mandir',
- }
-
-Another old syntax proposal
-===========================
-::
-
- [resources]
-
- # data are composed of two elements
- # 1. the path relative to the package
- # 2. an optional prefix path that will replace the explicit (non-glob) initial path from (1)
-
- data =
- mailman/database/schemas/* schemas/
- **/*.tpl templates/
-
- data.persistent =
- mailman/database/mailman.db database/
-
- doc =
- developer-docs/**/*.txt
- README
-
- config =
- mailman/etc/* . # all files in mailman/etc/* copied to
- mailman/foo/**/*.cfg foo # all .cfg files below mailman/foo/SOME/PATH/TO/FILE/ will get copied to foo/SOME/PATH/TO/FILE/
- mailman/foo/**/*.cfg
- mailman/foo/**/bar/*.cfg baz
diff --git a/docs/make.bat b/docs/make.bat
deleted file mode 100644
--- a/docs/make.bat
+++ /dev/null
@@ -1,113 +0,0 @@
- at ECHO OFF
-
-REM Command file for Sphinx documentation
-
-set SPHINXBUILD=sphinx-build
-set BUILDDIR=build
-set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source
-if NOT "%PAPER%" == "" (
- set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
-)
-
-if "%1" == "" goto help
-
-if "%1" == "help" (
- :help
- echo.Please use `make ^<target^>` where ^<target^> is one of
- echo. html to make standalone HTML files
- echo. dirhtml to make HTML files named index.html in directories
- echo. pickle to make pickle files
- echo. json to make JSON files
- echo. htmlhelp to make HTML files and a HTML help project
- echo. qthelp to make HTML files and a qthelp project
- echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
- echo. changes to make an overview over all changed/added/deprecated items
- echo. linkcheck to check all external links for integrity
- echo. doctest to run all doctests embedded in the documentation if enabled
- goto end
-)
-
-if "%1" == "clean" (
- for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
- del /q /s %BUILDDIR%\*
- goto end
-)
-
-if "%1" == "html" (
- %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
- echo.
- echo.Build finished. The HTML pages are in %BUILDDIR%/html.
- goto end
-)
-
-if "%1" == "dirhtml" (
- %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
- echo.
- echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
- goto end
-)
-
-if "%1" == "pickle" (
- %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
- echo.
- echo.Build finished; now you can process the pickle files.
- goto end
-)
-
-if "%1" == "json" (
- %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
- echo.
- echo.Build finished; now you can process the JSON files.
- goto end
-)
-
-if "%1" == "htmlhelp" (
- %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
- echo.
- echo.Build finished; now you can run HTML Help Workshop with the ^
-.hhp project file in %BUILDDIR%/htmlhelp.
- goto end
-)
-
-if "%1" == "qthelp" (
- %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
- echo.
- echo.Build finished; now you can run "qcollectiongenerator" with the ^
-.qhcp project file in %BUILDDIR%/qthelp, like this:
- echo.^> qcollectiongenerator %BUILDDIR%\qthelp\Distutils2.qhcp
- echo.To view the help file:
- echo.^> assistant -collectionFile %BUILDDIR%\qthelp\Distutils2.ghc
- goto end
-)
-
-if "%1" == "latex" (
- %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
- echo.
- echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
- goto end
-)
-
-if "%1" == "changes" (
- %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
- echo.
- echo.The overview file is in %BUILDDIR%/changes.
- goto end
-)
-
-if "%1" == "linkcheck" (
- %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
- echo.
- echo.Link check complete; look for any errors in the above output ^
-or in %BUILDDIR%/linkcheck/output.txt.
- goto end
-)
-
-if "%1" == "doctest" (
- %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
- echo.
- echo.Testing of doctests in the sources finished, look at the ^
-results in %BUILDDIR%/doctest/output.txt.
- goto end
-)
-
-:end
diff --git a/docs/source/_static/depgraph_big.png b/docs/source/_static/depgraph_big.png
deleted file mode 100644
Binary file docs/source/_static/depgraph_big.png has changed
diff --git a/docs/source/conf.py b/docs/source/conf.py
deleted file mode 100644
--- a/docs/source/conf.py
+++ /dev/null
@@ -1,199 +0,0 @@
-# -*- coding: utf-8 -*-
-#
-# Distutils2 documentation build configuration file, created by
-# sphinx-quickstart on Sun Feb 28 15:23:06 2010.
-#
-# This file is execfile()d with the current directory set to its containing
-# dir. It requires Sphinx 1.0.
-#
-# Note that not all possible configuration values are present in this
-# autogenerated file.
-#
-# All configuration values have a default; values that are commented out
-# serve to show the default.
-
-import os
-import sys
-import sphinx
-
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.append(os.path.abspath('.'))
-sys.path.append(os.path.abspath(os.path.join(__file__, '..', '..', '..')))
-
-# -- General configuration -----------------------------------------------------
-
-# Add any Sphinx extension module names here, as strings. They can be extensions
-# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc']
-
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
-
-# The suffix of source filenames.
-source_suffix = '.rst'
-
-# The encoding of source files.
-#source_encoding = 'utf-8'
-
-# The master toctree document.
-master_doc = 'index'
-
-# General information about the project.
-project = u'Distutils2'
-copyright = u'2010, Tarek Ziadé and contributors'
-
-# The version info for the project you're documenting, acts as replacement for
-# |version| and |release|, also used in various other places throughout the
-# built documents.
-#
-# The short X.Y version.
-version = '1.0a3'
-# The full version, including alpha/beta/rc tags.
-release = '1.0a3+'
-
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-#language = None
-
-# There are two options for replacing |today|: either, you set today to some
-# non-false value, then it is used:
-#today = ''
-# Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
-
-# List of documents that shouldn't be included in the build.
-#unused_docs = []
-
-# List of directories, relative to source directory, that shouldn't be searched
-# for source files.
-exclude_trees = []
-
-# The reST default role (used for this markup: `text`) to use for all documents.
-#default_role = None
-
-# If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
-
-# If true, the current module name will be prepended to all description
-# unit titles (such as .. function::).
-#add_module_names = True
-
-# If true, sectionauthor and moduleauthor directives will be shown in the
-# output. They are ignored by default.
-#show_authors = False
-
-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
-
-# A list of ignored prefixes for module index sorting.
-modindex_common_prefix = ['distutils2.', 'distutils2.command.']
-
-
-# -- Options for HTML output ---------------------------------------------------
-
-# The theme to use for HTML and HTML Help pages. Major themes that come with
-# Sphinx are currently 'default' and 'sphinxdoc'.
-html_theme = 'default'
-
-# Theme options are theme-specific and customize the look and feel of a theme
-# further. For a list of options available for each theme, see the
-# documentation.
-if sphinx.__version__[:3] >= '1.0':
- html_theme_options = {'collapsiblesidebar': True}
-
-# Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
-
-# The name for this set of Sphinx documents. If None, it defaults to
-# "<project> v<release> documentation".
-html_title = 'Distutils2'
-
-# A shorter title for the navigation bar. Default is the same as html_title.
-#html_short_title = None
-
-# The name of an image file (relative to this directory) to place at the top
-# of the sidebar.
-#html_logo = None
-
-# The name of an image file (within the static path) to use as favicon of the
-# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
-# pixels large.
-#html_favicon = None
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
-
-# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
-# using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
-
-# If true, SmartyPants will be used to convert quotes and dashes to
-# typographically correct entities.
-#html_use_smartypants = True
-
-# Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
-
-# Additional templates that should be rendered to pages, maps page names to
-# template names.
-#html_additional_pages = {}
-
-# If false, no module index is generated.
-#html_use_modindex = True
-
-# If false, no index is generated.
-#html_use_index = True
-
-# If true, the index is split into individual pages for each letter.
-#html_split_index = False
-
-# If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
-
-# If true, an OpenSearch description file will be output, and all pages will
-# contain a <link> tag referring to it. The value of this option must be the
-# base URL from which the finished HTML is served.
-#html_use_opensearch = ''
-
-# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = ''
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = 'Distutils2doc'
-
-
-# -- Options for LaTeX output --------------------------------------------------
-
-# The paper size ('letter' or 'a4').
-#latex_paper_size = 'letter'
-
-# The font size ('10pt', '11pt' or '12pt').
-#latex_font_size = '10pt'
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title, author, documentclass [howto/manual]).
-latex_documents = [
- ('index', 'Distutils2.tex', u'Distutils2 Documentation',
- u'Tarek Ziadé and contributors', 'manual'),
-]
-
-# The name of an image file (relative to this directory) to place at the top of
-# the title page.
-#latex_logo = None
-
-# For "manual" documents, if this is true, then toplevel headings are parts,
-# not chapters.
-#latex_use_parts = False
-
-# Additional stuff for the LaTeX preamble.
-#latex_preamble = ''
-
-# Documents to append as an appendix to all manuals.
-#latex_appendices = []
-
-# If false, no module index is generated.
-#latex_use_modindex = True
diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst
deleted file mode 100644
--- a/docs/source/contributing.rst
+++ /dev/null
@@ -1,27 +0,0 @@
-==========================
-Contributing to Distutils2
-==========================
-
-----------------
-Reporting Issues
-----------------
-
-When using, testing or developping distutils2, you may encounter issues. Please report to the following sections to know how these issues should be reported.
-
-Please keep in mind that this guide is intended to ease the triage and fixing processes by giving the maximum information to the developers. It should not be viewed as mandatory, only advisory ;).
-
-
-- Go to http://bugs.python.org/ (you'll need a Python Bugs account), then "Issues" > "Create ticket".
-- **Title**: write in a short summary of the issue. You may prefix the issue title with “component:”, where component can be something like installer, sdist, setup.cfg, etc., or add it at the end of your title if the normal flow of the sentence allows it. This will ease up later searches.
-- **Components**: choose "Distutils2"
-- **Version**: choose "3rd party"
-- **Body**: explain how to reproduce the bug: What you want to do, what code you write, what happens, what should happen, how to fix it (if you have an idea).
- * You should always test with the tip of the main repository, not releases.
- * Mention the versions of Python you tested with. d2 supports 2.4 to 2.7.
- * If relevant, mention the version of your operating system (for example with issues related to C extensions).
- * When referencing commits, be careful to use the universal changeset identifiers (12 characters, for instance c3cf81fc64db), not the local sequential numbers (for example 925) that are not shared among clones.
- * Try to be as concise as possible, but not too much.
- * If useful, paste tracebacks.
- * If useful, attach setup.cfg or other files (binary files like archives are not very convenient, better to stick to text).
-
-Issues related to PyPI are reported via email to the **catalog-sig at python.org** mailing list, not within bugs.python.org.
diff --git a/docs/source/devresources.rst b/docs/source/devresources.rst
deleted file mode 100644
--- a/docs/source/devresources.rst
+++ /dev/null
@@ -1,49 +0,0 @@
-===================
-Developer Resources
-===================
-
-
-Source code
-~~~~~~~~~~~
-
-* Main repo: http://hg.python.org/distutils2
-* For contributors at: http://bitbucket.org/tarek/distutils2
-
-Dependencies
-~~~~~~~~~~~~
-
-* unittest2
-* If your operating system splits core python and a python-dev (or -devel)
- packages, install the dev package too: It contains header files needed by
- tests.
-
-Issue Tracker
-~~~~~~~~~~~~~
-
-Using the `distutils2` component at the `python.org bug tracker <http://bugs.python.org/issue?%40sort0=activity&%40sortdir0=on&%40sort1=&%40group0=priority&%40group1=&%40columns=title,id,activity,status&%40filter=components,status&status=1&components=25&%40pagesize=50&%40startwith=0>`_,
-
-Mailing List
-~~~~~~~~~~~~
-
-http://groups.google.com/group/the-fellowship-of-the-packaging
-
-more general discussion at distutils-sig at python.org
-
-IRC Channel
-~~~~~~~~~~~
-
-#distutils on irc.freenode.net
-
-Documentation
-~~~~~~~~~~~~~
-
-This documentation is present in the docs/source directory of the above source
-code.
-
-Additional useful information available at:
-
-* `Hitchhikers guide to packaging <http://guide.python-distribute.org>`_
-
-
-
-
diff --git a/docs/source/distutils/apiref.rst b/docs/source/distutils/apiref.rst
deleted file mode 100644
--- a/docs/source/distutils/apiref.rst
+++ /dev/null
@@ -1,2010 +0,0 @@
-.. _api-reference:
-
-*************
-API Reference
-*************
-
-
-:mod:`distutils2.core` --- Core Distutils functionality
-=======================================================
-
-.. module:: distutils2.core
- :synopsis: The core Distutils functionality
-
-
-The :mod:`distutils2.core` module is the only module that needs to be installed
-to use the Distutils. It provides the :func:`setup` (which is called from the
-setup script). Indirectly provides the :class:`distutils2.dist.Distribution` and
-:class:`distutils2.cmd.Command` class.
-
-
-.. function:: setup(arguments)
-
- The basic do-everything function that does most everything you could ever ask
- for from a Distutils method.
-
- The setup function takes a large number of arguments. These are laid out in
- the following table.
-
- +--------------------+--------------------------------+-------------------------------------------------------------+
- | argument name | value | type |
- +====================+================================+=============================================================+
- | *name* | The name of the package | a string |
- +--------------------+--------------------------------+-------------------------------------------------------------+
- | *version* | The version number of the | See :mod:`distutils2.version` |
- | | package | |
- +--------------------+--------------------------------+-------------------------------------------------------------+
- | *summary* | A single line describing the | a string |
- | | package | |
- +--------------------+--------------------------------+-------------------------------------------------------------+
- | *description* | Longer description of the | a string |
- | | package | |
- +--------------------+--------------------------------+-------------------------------------------------------------+
- | *author* | The name of the package author | a string |
- +--------------------+--------------------------------+-------------------------------------------------------------+
- | *author_email* | The email address of the | a string |
- | | package author | |
- +--------------------+--------------------------------+-------------------------------------------------------------+
- | *maintainer* | The name of the current | a string |
- | | maintainer, if different from | |
- | | the author | |
- +--------------------+--------------------------------+-------------------------------------------------------------+
- | *maintainer_email* | The email address of the | |
- | | current maintainer, if | |
- | | different from the author | |
- +--------------------+--------------------------------+-------------------------------------------------------------+
- | *home_page* | A URL for the package | a URL |
- | | (homepage) | |
- +--------------------+--------------------------------+-------------------------------------------------------------+
- | *download_url* | A URL to download the package | a URL |
- +--------------------+--------------------------------+-------------------------------------------------------------+
- | *packages* | A list of Python packages that | a list of strings |
- | | distutils will manipulate | |
- +--------------------+--------------------------------+-------------------------------------------------------------+
- | *py_modules* | A list of Python modules that | a list of strings |
- | | distutils will manipulate | |
- +--------------------+--------------------------------+-------------------------------------------------------------+
- | *scripts* | A list of standalone script | a list of strings |
- | | files to be built and | |
- | | installed | |
- +--------------------+--------------------------------+-------------------------------------------------------------+
- | *ext_modules* | A list of Python extensions to | A list of instances of |
- | | be built | :class:`distutils2.extension.Extension` |
- +--------------------+--------------------------------+-------------------------------------------------------------+
- | *classifiers* | A list of categories for the | The list of available |
- | | package | categorizations is at |
- | | | http://pypi.python.org/pypi?:action=list_classifiers. |
- +--------------------+--------------------------------+-------------------------------------------------------------+
- | *distclass* | the :class:`Distribution` | A subclass of |
- | | class to use | :class:`distutils2.dist.Distribution` |
- +--------------------+--------------------------------+-------------------------------------------------------------+
- | *script_name* | The name of the setup.py | a string |
- | | script - defaults to | |
- | | ``sys.argv[0]`` | |
- +--------------------+--------------------------------+-------------------------------------------------------------+
- | *script_args* | Arguments to supply to the | a list of strings |
- | | setup script | |
- +--------------------+--------------------------------+-------------------------------------------------------------+
- | *options* | default options for the setup | a string |
- | | script | |
- +--------------------+--------------------------------+-------------------------------------------------------------+
- | *license* | The license for the package | a string |
- +--------------------+--------------------------------+-------------------------------------------------------------+
- | *keywords* | Descriptive metadata, see | |
- | | :PEP:`314` | |
- +--------------------+--------------------------------+-------------------------------------------------------------+
- | *platforms* | | |
- +--------------------+--------------------------------+-------------------------------------------------------------+
- | *cmdclass* | A mapping of command names to | a dictionary |
- | | :class:`Command` subclasses | |
- +--------------------+--------------------------------+-------------------------------------------------------------+
- | *data_files* | A list of data files to | a list |
- | | install | |
- +--------------------+--------------------------------+-------------------------------------------------------------+
- | *package_dir* | A mapping of package to | a dictionary |
- | | directory names | |
- +--------------------+--------------------------------+-------------------------------------------------------------+
- | *extra_path* | Information about an | a string, 1-tuple or 2-tuple |
- | | intervening directory the | |
- | | install directory and the | |
- | | actual installation directory. | |
- | | | |
- | | If the value is a string is is | |
- | | treated as a comma-separated | |
- | | tuple. | |
- | | | |
- | | If the value is a 2-tuple, | |
- | | the first element is the | |
- | | ``.pth`` file and the second | |
- | | is the name of the intervening | |
- | | directory. | |
- | | | |
- | | If the value is a 1-tuple that | |
- | | element is both the name of | |
- | | the ``.pth`` file and the | |
- | | intervening directory. | |
- +--------------------+--------------------------------+-------------------------------------------------------------+
-
-
-
-.. function:: run_setup(script_name[, script_args=None, stop_after='run'])
-
- Run a setup script in a somewhat controlled environment, and return the
- :class:`distutils2.dist.Distribution` instance that drives things. This is
- useful if you need to find out the distribution metadata (passed as keyword
- args from *script* to :func:`setup`), or the contents of the config files or
- command line.
-
- *script_name* is a file that will be run with :func:`execfile`
- ``sys.argv[0]`` will be replaced with *script* for the duration of the call.
- *script_args* is a list of strings; if supplied, ``sys.argv[1:]`` will be
- replaced by *script_args* for the duration of the call.
-
- *stop_after* tells :func:`setup` when to stop processing; possible values:
-
- +---------------+---------------------------------------------+
- | value | description |
- +===============+=============================================+
- | *init* | Stop after the :class:`Distribution` |
- | | instance has been created and populated |
- | | with the keyword arguments to :func:`setup` |
- +---------------+---------------------------------------------+
- | *config* | Stop after config files have been parsed |
- | | (and their data stored in the |
- | | :class:`Distribution` instance) |
- +---------------+---------------------------------------------+
- | *commandline* | Stop after the command line |
- | | (``sys.argv[1:]`` or *script_args*) have |
- | | been parsed (and the data stored in the |
- | | :class:`Distribution` instance.) |
- +---------------+---------------------------------------------+
- | *run* | Stop after all commands have been run (the |
- | | same as if :func:`setup` had been called in |
- | | the usual way). This is the default value. |
- +---------------+---------------------------------------------+
-
-In addition, the :mod:`distutils2.core` module exposed a number of classes that
-live elsewhere.
-
-* :class:`~distutils.extension.Extension` from :mod:`distutils2.extension`
-
-* :class:`~distutils.command.cmd.Command` from :mod:`distutils2.command.cmd`
-
-* :class:`~distutils.dist.Distribution` from :mod:`distutils2.dist`
-
-A short description of each of these follows, but see the relevant module for
-the full reference.
-
-
-.. class:: Extension
-
- The Extension class describes a single C or C++extension module in a setup
- script. It accepts the following keyword arguments in its constructor
-
- +------------------------+--------------------------------+---------------------------+
- | argument name | value | type |
- +========================+================================+===========================+
- | *name* | the full name of the | string |
- | | extension, including any | |
- | | packages --- i.e. *not* a | |
- | | filename or pathname, but | |
- | | Python dotted name | |
- +------------------------+--------------------------------+---------------------------+
- | *sources* | list of source filenames, | string |
- | | relative to the distribution | |
- | | root (where the setup script | |
- | | lives), in Unix form (slash- | |
- | | separated) for portability. | |
- | | Source files may be C, C++, | |
- | | SWIG (.i), platform-specific | |
- | | resource files, or whatever | |
- | | else is recognized by the | |
- | | :command:`build_ext` command | |
- | | as source for a Python | |
- | | extension. | |
- +------------------------+--------------------------------+---------------------------+
- | *include_dirs* | list of directories to search | string |
- | | for C/C++ header files (in | |
- | | Unix form for portability) | |
- +------------------------+--------------------------------+---------------------------+
- | *define_macros* | list of macros to define; each | (string, string) tuple or |
- | | macro is defined using a | (name, ``None``) |
- | | 2-tuple ``(name, value)``, | |
- | | where *value* is | |
- | | either the string to define it | |
- | | to or ``None`` to define it | |
- | | without a particular value | |
- | | (equivalent of ``#define FOO`` | |
- | | in source or :option:`-DFOO` | |
- | | on Unix C compiler command | |
- | | line) | |
- +------------------------+--------------------------------+---------------------------+
- | *undef_macros* | list of macros to undefine | string |
- | | explicitly | |
- +------------------------+--------------------------------+---------------------------+
- | *library_dirs* | list of directories to search | string |
- | | for C/C++ libraries at link | |
- | | time | |
- +------------------------+--------------------------------+---------------------------+
- | *libraries* | list of library names (not | string |
- | | filenames or paths) to link | |
- | | against | |
- +------------------------+--------------------------------+---------------------------+
- | *runtime_library_dirs* | list of directories to search | string |
- | | for C/C++ libraries at run | |
- | | time (for shared extensions, | |
- | | this is when the extension is | |
- | | loaded) | |
- +------------------------+--------------------------------+---------------------------+
- | *extra_objects* | list of extra files to link | string |
- | | with (e.g. object files not | |
- | | implied by 'sources', static | |
- | | library that must be | |
- | | explicitly specified, binary | |
- | | resource files, etc.) | |
- +------------------------+--------------------------------+---------------------------+
- | *extra_compile_args* | any extra platform- and | string |
- | | compiler-specific information | |
- | | to use when compiling the | |
- | | source files in 'sources'. For | |
- | | platforms and compilers where | |
- | | a command line makes sense, | |
- | | this is typically a list of | |
- | | command-line arguments, but | |
- | | for other platforms it could | |
- | | be anything. | |
- +------------------------+--------------------------------+---------------------------+
- | *extra_link_args* | any extra platform- and | string |
- | | compiler-specific information | |
- | | to use when linking object | |
- | | files together to create the | |
- | | extension (or to create a new | |
- | | static Python interpreter). | |
- | | Similar interpretation as for | |
- | | 'extra_compile_args'. | |
- +------------------------+--------------------------------+---------------------------+
- | *export_symbols* | list of symbols to be exported | string |
- | | from a shared extension. Not | |
- | | used on all platforms, and not | |
- | | generally necessary for Python | |
- | | extensions, which typically | |
- | | export exactly one symbol: | |
- | | ``init`` + extension_name. | |
- +------------------------+--------------------------------+---------------------------+
- | *depends* | list of files that the | string |
- | | extension depends on | |
- +------------------------+--------------------------------+---------------------------+
- | *language* | extension language (i.e. | string |
- | | ``'c'``, ``'c++'``, | |
- | | ``'objc'``). Will be detected | |
- | | from the source extensions if | |
- | | not provided. | |
- +------------------------+--------------------------------+---------------------------+
-
-
-.. class:: Distribution
-
- A :class:`Distribution` describes how to build, install and package up a
- Python software package.
-
- See the :func:`setup` function for a list of keyword arguments accepted by
- the Distribution constructor. :func:`setup` creates a Distribution instance.
-
-
-.. class:: Command
-
- A :class:`Command` class (or rather, an instance of one of its subclasses)
- implement a single distutils command.
-
-
-:mod:`distutils2.ccompiler` --- CCompiler base class
-====================================================
-
-.. module:: distutils2.ccompiler
- :synopsis: Abstract CCompiler class
-
-
-This module provides the abstract base class for the :class:`CCompiler`
-classes. A :class:`CCompiler` instance can be used for all the compile and
-link steps needed to build a single project. Methods are provided to set
-options for the compiler --- macro definitions, include directories, link path,
-libraries and the like.
-
-This module provides the following functions.
-
-
-.. function:: gen_lib_options(compiler, library_dirs, runtime_library_dirs, libraries)
-
- Generate linker options for searching library directories and linking with
- specific libraries. *libraries* and *library_dirs* are, respectively, lists
- of library names (not filenames!) and search directories. Returns a list of
- command-line options suitable for use with some compiler (depending on the
- two format strings passed in).
-
-
-.. function:: gen_preprocess_options(macros, include_dirs)
-
- Generate C preprocessor options (:option:`-D`, :option:`-U`, :option:`-I`) as
- used by at least two types of compilers: the typical Unix compiler and Visual
- C++. *macros* is the usual thing, a list of 1- or 2-tuples, where ``(name,)``
- means undefine (:option:`-U`) macro *name*, and ``(name, value)`` means
- define (:option:`-D`) macro *name* to *value*. *include_dirs* is just a list
- of directory names to be added to the header file search path (:option:`-I`).
- Returns a list of command-line options suitable for either Unix compilers or
- Visual C++.
-
-
-.. function:: get_default_compiler(osname, platform)
-
- Determine the default compiler to use for the given platform.
-
- *osname* should be one of the standard Python OS names (i.e. the ones
- returned by ``os.name``) and *platform* the common value returned by
- ``sys.platform`` for the platform in question.
-
- The default values are ``os.name`` and ``sys.platform``.
-
-
-.. function:: new_compiler(plat=None, compiler=None, verbose=0, dry_run=0, force=0)
-
- Factory function to generate an instance of some CCompiler subclass for the
- supplied platform/compiler combination. *plat* defaults to ``os.name`` (e.g.
- ``'posix'``, ``'nt'``), and *compiler* defaults to the default compiler for
- that platform. Currently only ``'posix'`` and ``'nt'`` are supported, and the
- default compilers are "traditional Unix interface" (:class:`UnixCCompiler`
- class) and Visual C++ (:class:`MSVCCompiler` class). Note that it's perfectly
- possible to ask for a Unix compiler object under Windows, and a Microsoft
- compiler object under Unix---if you supply a value for *compiler*, *plat* is
- ignored.
-
- .. % Is the posix/nt only thing still true? Mac OS X seems to work, and
- .. % returns a UnixCCompiler instance. How to document this... hmm.
-
-
-.. function:: show_compilers()
-
- Print list of available compilers (used by the :option:`--help-compiler`
- options to :command:`build`, :command:`build_ext`, :command:`build_clib`).
-
-
-.. class:: CCompiler([verbose=0, dry_run=0, force=0])
-
- The abstract base class :class:`CCompiler` defines the interface that must be
- implemented by real compiler classes. The class also has some utility
- methods used by several compiler classes.
-
- The basic idea behind a compiler abstraction class is that each instance can
- be used for all the compile/link steps in building a single project. Thus,
- attributes common to all of those compile and link steps --- include
- directories, macros to define, libraries to link against, etc. --- are
- attributes of the compiler instance. To allow for variability in how
- individual files are treated, most of those attributes may be varied on a
- per-compilation or per-link basis.
-
- The constructor for each subclass creates an instance of the Compiler object.
- Flags are *verbose* (show verbose output), *dry_run* (don't actually execute
- the steps) and *force* (rebuild everything, regardless of dependencies). All
- of these flags default to ``0`` (off). Note that you probably don't want to
- instantiate :class:`CCompiler` or one of its subclasses directly - use the
- :func:`distutils2.CCompiler.new_compiler` factory function instead.
-
- The following methods allow you to manually alter compiler options for the
- instance of the Compiler class.
-
-
- .. method:: CCompiler.add_include_dir(dir)
-
- Add *dir* to the list of directories that will be searched for header
- files. The compiler is instructed to search directories in the order in
- which they are supplied by successive calls to :meth:`add_include_dir`.
-
-
- .. method:: CCompiler.set_include_dirs(dirs)
-
- Set the list of directories that will be searched to *dirs* (a list of
- strings). Overrides any preceding calls to :meth:`add_include_dir`;
- subsequent calls to :meth:`add_include_dir` add to the list passed to
- :meth:`set_include_dirs`. This does not affect any list of standard
- include directories that the compiler may search by default.
-
-
- .. method:: CCompiler.add_library(libname)
-
- Add *libname* to the list of libraries that will be included in all links
- driven by this compiler object. Note that *libname* should *not* be the
- name of a file containing a library, but the name of the library itself:
- the actual filename will be inferred by the linker, the compiler, or the
- compiler class (depending on the platform).
-
- The linker will be instructed to link against libraries in the order they
- were supplied to :meth:`add_library` and/or :meth:`set_libraries`. It is
- perfectly valid to duplicate library names; the linker will be instructed
- to link against libraries as many times as they are mentioned.
-
-
- .. method:: CCompiler.set_libraries(libnames)
-
- Set the list of libraries to be included in all links driven by this
- compiler object to *libnames* (a list of strings). This does not affect
- any standard system libraries that the linker may include by default.
-
-
- .. method:: CCompiler.add_library_dir(dir)
-
- Add *dir* to the list of directories that will be searched for libraries
- specified to :meth:`add_library` and :meth:`set_libraries`. The linker
- will be instructed to search for libraries in the order they are supplied
- to :meth:`add_library_dir` and/or :meth:`set_library_dirs`.
-
-
- .. method:: CCompiler.set_library_dirs(dirs)
-
- Set the list of library search directories to *dirs* (a list of strings).
- This does not affect any standard library search path that the linker may
- search by default.
-
-
- .. method:: CCompiler.add_runtime_library_dir(dir)
-
- Add *dir* to the list of directories that will be searched for shared
- libraries at runtime.
-
-
- .. method:: CCompiler.set_runtime_library_dirs(dirs)
-
- Set the list of directories to search for shared libraries at runtime to
- *dirs* (a list of strings). This does not affect any standard search path
- that the runtime linker may search by default.
-
-
- .. method:: CCompiler.define_macro(name[, value=None])
-
- Define a preprocessor macro for all compilations driven by this compiler
- object. The optional parameter *value* should be a string; if it is not
- supplied, then the macro will be defined without an explicit value and the
- exact outcome depends on the compiler used (XXX true? does ANSI say
- anything about this?)
-
-
- .. method:: CCompiler.undefine_macro(name)
-
- Undefine a preprocessor macro for all compilations driven by this compiler
- object. If the same macro is defined by :meth:`define_macro` and
- undefined by :meth:`undefine_macro` the last call takes precedence
- (including multiple redefinitions or undefinitions). If the macro is
- redefined/undefined on a per-compilation basis (i.e. in the call to
- :meth:`compile`), then that takes precedence.
-
-
- .. method:: CCompiler.add_link_object(object)
-
- Add *object* to the list of object files (or analogues, such as explicitly
- named library files or the output of "resource compilers") to be included
- in every link driven by this compiler object.
-
-
- .. method:: CCompiler.set_link_objects(objects)
-
- Set the list of object files (or analogues) to be included in every link
- to *objects*. This does not affect any standard object files that the
- linker may include by default (such as system libraries).
-
- The following methods implement methods for autodetection of compiler
- options, providing some functionality similar to GNU :program:`autoconf`.
-
-
- .. method:: CCompiler.detect_language(sources)
-
- Detect the language of a given file, or list of files. Uses the instance
- attributes :attr:`language_map` (a dictionary), and :attr:`language_order`
- (a list) to do the job.
-
-
- .. method:: CCompiler.find_library_file(dirs, lib[, debug=0])
-
- Search the specified list of directories for a static or shared library file
- *lib* and return the full path to that file. If *debug* is true, look for a
- debugging version (if that makes sense on the current platform). Return
- ``None`` if *lib* wasn't found in any of the specified directories.
-
-
- .. method:: CCompiler.has_function(funcname [, includes=None, include_dirs=None, libraries=None, library_dirs=None])
-
- Return a boolean indicating whether *funcname* is supported on the current
- platform. The optional arguments can be used to augment the compilation
- environment by providing additional include files and paths and libraries and
- paths.
-
-
- .. method:: CCompiler.library_dir_option(dir)
-
- Return the compiler option to add *dir* to the list of directories searched for
- libraries.
-
-
- .. method:: CCompiler.library_option(lib)
-
- Return the compiler option to add *dir* to the list of libraries linked into the
- shared library or executable.
-
-
- .. method:: CCompiler.runtime_library_dir_option(dir)
-
- Return the compiler option to add *dir* to the list of directories searched for
- runtime libraries.
-
-
- .. method:: CCompiler.set_executables(**args)
-
- Define the executables (and options for them) that will be run to perform the
- various stages of compilation. The exact set of executables that may be
- specified here depends on the compiler class (via the 'executables' class
- attribute), but most will have:
-
- +--------------+------------------------------------------+
- | attribute | description |
- +==============+==========================================+
- | *compiler* | the C/C++ compiler |
- +--------------+------------------------------------------+
- | *linker_so* | linker used to create shared objects and |
- | | libraries |
- +--------------+------------------------------------------+
- | *linker_exe* | linker used to create binary executables |
- +--------------+------------------------------------------+
- | *archiver* | static library creator |
- +--------------+------------------------------------------+
-
- On platforms with a command line (Unix, DOS/Windows), each of these is a string
- that will be split into executable name and (optional) list of arguments.
- (Splitting the string is done similarly to how Unix shells operate: words are
- delimited by spaces, but quotes and backslashes can override this. See
- :func:`distutils2.util.split_quoted`.)
-
- The following methods invoke stages in the build process.
-
-
- .. method:: CCompiler.compile(sources[, output_dir=None, macros=None, include_dirs=None, debug=0, extra_preargs=None, extra_postargs=None, depends=None])
-
- Compile one or more source files. Generates object files (e.g. transforms a
- :file:`.c` file to a :file:`.o` file.)
-
- *sources* must be a list of filenames, most likely C/C++ files, but in reality
- anything that can be handled by a particular compiler and compiler class (e.g.
- :class:`MSVCCompiler` can handle resource files in *sources*). Return a list of
- object filenames, one per source filename in *sources*. Depending on the
- implementation, not all source files will necessarily be compiled, but all
- corresponding object filenames will be returned.
-
- If *output_dir* is given, object files will be put under it, while retaining
- their original path component. That is, :file:`foo/bar.c` normally compiles to
- :file:`foo/bar.o` (for a Unix implementation); if *output_dir* is *build*, then
- it would compile to :file:`build/foo/bar.o`.
-
- *macros*, if given, must be a list of macro definitions. A macro definition is
- either a ``(name, value)`` 2-tuple or a ``(name,)`` 1-tuple. The former defines
- a macro; if the value is ``None``, the macro is defined without an explicit
- value. The 1-tuple case undefines a macro. Later
- definitions/redefinitions/undefinitions take precedence.
-
- *include_dirs*, if given, must be a list of strings, the directories to add to
- the default include file search path for this compilation only.
-
- *debug* is a boolean; if true, the compiler will be instructed to output debug
- symbols in (or alongside) the object file(s).
-
- *extra_preargs* and *extra_postargs* are implementation-dependent. On platforms
- that have the notion of a command line (e.g. Unix, DOS/Windows), they are most
- likely lists of strings: extra command-line arguments to prepend/append to the
- compiler command line. On other platforms, consult the implementation class
- documentation. In any event, they are intended as an escape hatch for those
- occasions when the abstract compiler framework doesn't cut the mustard.
-
- *depends*, if given, is a list of filenames that all targets depend on. If a
- source file is older than any file in depends, then the source file will be
- recompiled. This supports dependency tracking, but only at a coarse
- granularity.
-
- Raises :exc:`CompileError` on failure.
-
-
- .. method:: CCompiler.create_static_lib(objects, output_libname[, output_dir=None, debug=0, target_lang=None])
-
- Link a bunch of stuff together to create a static library file. The "bunch of
- stuff" consists of the list of object files supplied as *objects*, the extra
- object files supplied to :meth:`add_link_object` and/or
- :meth:`set_link_objects`, the libraries supplied to :meth:`add_library` and/or
- :meth:`set_libraries`, and the libraries supplied as *libraries* (if any).
-
- *output_libname* should be a library name, not a filename; the filename will be
- inferred from the library name. *output_dir* is the directory where the library
- file will be put. XXX defaults to what?
-
- *debug* is a boolean; if true, debugging information will be included in the
- library (note that on most platforms, it is the compile step where this matters:
- the *debug* flag is included here just for consistency).
-
- *target_lang* is the target language for which the given objects are being
- compiled. This allows specific linkage time treatment of certain languages.
-
- Raises :exc:`LibError` on failure.
-
-
- .. method:: CCompiler.link(target_desc, objects, output_filename[, output_dir=None, libraries=None, library_dirs=None, runtime_library_dirs=None, export_symbols=None, debug=0, extra_preargs=None, extra_postargs=None, build_temp=None, target_lang=None])
-
- Link a bunch of stuff together to create an executable or shared library file.
-
- The "bunch of stuff" consists of the list of object files supplied as *objects*.
- *output_filename* should be a filename. If *output_dir* is supplied,
- *output_filename* is relative to it (i.e. *output_filename* can provide
- directory components if needed).
-
- *libraries* is a list of libraries to link against. These are library names,
- not filenames, since they're translated into filenames in a platform-specific
- way (e.g. *foo* becomes :file:`libfoo.a` on Unix and :file:`foo.lib` on
- DOS/Windows). However, they can include a directory component, which means the
- linker will look in that specific directory rather than searching all the normal
- locations.
-
- *library_dirs*, if supplied, should be a list of directories to search for
- libraries that were specified as bare library names (i.e. no directory
- component). These are on top of the system default and those supplied to
- :meth:`add_library_dir` and/or :meth:`set_library_dirs`. *runtime_library_dirs*
- is a list of directories that will be embedded into the shared library and used
- to search for other shared libraries that \*it\* depends on at run-time. (This
- may only be relevant on Unix.)
-
- *export_symbols* is a list of symbols that the shared library will export.
- (This appears to be relevant only on Windows.)
-
- *debug* is as for :meth:`compile` and :meth:`create_static_lib`, with the
- slight distinction that it actually matters on most platforms (as opposed to
- :meth:`create_static_lib`, which includes a *debug* flag mostly for form's
- sake).
-
- *extra_preargs* and *extra_postargs* are as for :meth:`compile` (except of
- course that they supply command-line arguments for the particular linker being
- used).
-
- *target_lang* is the target language for which the given objects are being
- compiled. This allows specific linkage time treatment of certain languages.
-
- Raises :exc:`LinkError` on failure.
-
-
- .. method:: CCompiler.link_executable(objects, output_progname[, output_dir=None, libraries=None, library_dirs=None, runtime_library_dirs=None, debug=0, extra_preargs=None, extra_postargs=None, target_lang=None])
-
- Link an executable. *output_progname* is the name of the file executable, while
- *objects* are a list of object filenames to link in. Other arguments are as for
- the :meth:`link` method.
-
-
- .. method:: CCompiler.link_shared_lib(objects, output_libname[, output_dir=None, libraries=None, library_dirs=None, runtime_library_dirs=None, export_symbols=None, debug=0, extra_preargs=None, extra_postargs=None, build_temp=None, target_lang=None])
-
- Link a shared library. *output_libname* is the name of the output library,
- while *objects* is a list of object filenames to link in. Other arguments are
- as for the :meth:`link` method.
-
-
- .. method:: CCompiler.link_shared_object(objects, output_filename[, output_dir=None, libraries=None, library_dirs=None, runtime_library_dirs=None, export_symbols=None, debug=0, extra_preargs=None, extra_postargs=None, build_temp=None, target_lang=None])
-
- Link a shared object. *output_filename* is the name of the shared object that
- will be created, while *objects* is a list of object filenames to link in.
- Other arguments are as for the :meth:`link` method.
-
-
- .. method:: CCompiler.preprocess(source[, output_file=None, macros=None, include_dirs=None, extra_preargs=None, extra_postargs=None])
-
- Preprocess a single C/C++ source file, named in *source*. Output will be written
- to file named *output_file*, or *stdout* if *output_file* not supplied.
- *macros* is a list of macro definitions as for :meth:`compile`, which will
- augment the macros set with :meth:`define_macro` and :meth:`undefine_macro`.
- *include_dirs* is a list of directory names that will be added to the default
- list, in the same way as :meth:`add_include_dir`.
-
- Raises :exc:`PreprocessError` on failure.
-
- The following utility methods are defined by the :class:`CCompiler` class, for
- use by the various concrete subclasses.
-
-
- .. method:: CCompiler.executable_filename(basename[, strip_dir=0, output_dir=''])
-
- Returns the filename of the executable for the given *basename*. Typically for
- non-Windows platforms this is the same as the basename, while Windows will get
- a :file:`.exe` added.
-
-
- .. method:: CCompiler.library_filename(libname[, lib_type='static', strip_dir=0, output_dir=''])
-
- Returns the filename for the given library name on the current platform. On Unix
- a library with *lib_type* of ``'static'`` will typically be of the form
- :file:`liblibname.a`, while a *lib_type* of ``'dynamic'`` will be of the form
- :file:`liblibname.so`.
-
-
- .. method:: CCompiler.object_filenames(source_filenames[, strip_dir=0, output_dir=''])
-
- Returns the name of the object files for the given source files.
- *source_filenames* should be a list of filenames.
-
-
- .. method:: CCompiler.shared_object_filename(basename[, strip_dir=0, output_dir=''])
-
- Returns the name of a shared object file for the given file name *basename*.
-
-
- .. method:: CCompiler.execute(func, args[, msg=None, level=1])
-
- Invokes :func:`distutils2.util.execute` This method invokes a Python function
- *func* with the given arguments *args*, after logging and taking into account
- the *dry_run* flag. XXX see also.
-
-
- .. method:: CCompiler.spawn(cmd)
-
- Invokes :func:`distutils2.util.spawn`. This invokes an external process to run
- the given command. XXX see also.
-
-
- .. method:: CCompiler.mkpath(name[, mode=511])
-
- Invokes :func:`distutils2.dir_util.mkpath`. This creates a directory and any
- missing ancestor directories. XXX see also.
-
-
- .. method:: CCompiler.move_file(src, dst)
-
- Invokes :meth:`distutils2.file_util.move_file`. Renames *src* to *dst*. XXX see
- also.
-
-
- .. method:: CCompiler.announce(msg[, level=1])
-
- Write a message using :func:`distutils2.log.debug`. XXX see also.
-
-
- .. method:: CCompiler.warn(msg)
-
- Write a warning message *msg* to standard error.
-
-
- .. method:: CCompiler.debug_print(msg)
-
- If the *debug* flag is set on this :class:`CCompiler` instance, print *msg* to
- standard output, otherwise do nothing.
-
-.. % \subsection{Compiler-specific modules}
-.. %
-.. % The following modules implement concrete subclasses of the abstract
-.. % \class{CCompiler} class. They should not be instantiated directly, but should
-.. % be created using \function{distutils.ccompiler.new_compiler()} factory
-.. % function.
-
-
-:mod:`distutils2.unixccompiler` --- Unix C Compiler
-===================================================
-
-.. module:: distutils2.unixccompiler
- :synopsis: UNIX C Compiler
-
-
-This module provides the :class:`UnixCCompiler` class, a subclass of
-:class:`CCompiler` that handles the typical Unix-style command-line C compiler:
-
-* macros defined with :option:`-Dname[=value]`
-
-* macros undefined with :option:`-Uname`
-
-* include search directories specified with :option:`-Idir`
-
-* libraries specified with :option:`-llib`
-
-* library search directories specified with :option:`-Ldir`
-
-* compile handled by :program:`cc` (or similar) executable with :option:`-c`
- option: compiles :file:`.c` to :file:`.o`
-
-* link static library handled by :program:`ar` command (possibly with
- :program:`ranlib`)
-
-* link shared library handled by :program:`cc` :option:`-shared`
-
-
-:mod:`distutils2.msvccompiler` --- Microsoft Compiler
-=====================================================
-
-.. module:: distutils2.msvccompiler
- :synopsis: Microsoft Compiler
-
-
-This module provides :class:`MSVCCompiler`, an implementation of the abstract
-:class:`CCompiler` class for Microsoft Visual Studio. Typically, extension
-modules need to be compiled with the same compiler that was used to compile
-Python. For Python 2.3 and earlier, the compiler was Visual Studio 6. For Python
-2.4 and 2.5, the compiler is Visual Studio .NET 2003. The AMD64 and Itanium
-binaries are created using the Platform SDK.
-
-:class:`MSVCCompiler` will normally choose the right compiler, linker etc. on
-its own. To override this choice, the environment variables *DISTUTILS_USE_SDK*
-and *MSSdk* must be both set. *MSSdk* indicates that the current environment has
-been setup by the SDK's ``SetEnv.Cmd`` script, or that the environment variables
-had been registered when the SDK was installed; *DISTUTILS_USE_SDK* indicates
-that the distutils user has made an explicit choice to override the compiler
-selection by :class:`MSVCCompiler`.
-
-
-:mod:`distutils2.bcppcompiler` --- Borland Compiler
-===================================================
-
-.. module:: distutils2.bcppcompiler
-
-
-This module provides :class:`BorlandCCompiler`, an subclass of the abstract
-:class:`CCompiler` class for the Borland C++ compiler.
-
-
-:mod:`distutils2.cygwincompiler` --- Cygwin Compiler
-====================================================
-
-.. module:: distutils2.cygwinccompiler
-
-
-This module provides the :class:`CygwinCCompiler` class, a subclass of
-:class:`UnixCCompiler` that handles the Cygwin port of the GNU C compiler to
-Windows. It also contains the Mingw32CCompiler class which handles the mingw32
-port of GCC (same as cygwin in no-cygwin mode).
-
-
-:mod:`distutils2.emxccompiler` --- OS/2 EMX Compiler
-====================================================
-
-.. module:: distutils2.emxccompiler
- :synopsis: OS/2 EMX Compiler support
-
-
-This module provides the EMXCCompiler class, a subclass of
-:class:`UnixCCompiler` that handles the EMX port of the GNU C compiler to OS/2.
-
-
-:mod:`distutils2.archive_util` --- Archiving utilities
-======================================================
-
-.. module:: distutils2.archive_util
- :synopsis: Utility functions for creating archive files (tarballs, zip files, ...)
-
-
-This module provides a few functions for creating archive files, such as
-tarballs or zipfiles.
-
-
-.. function:: make_archive(base_name, format[, root_dir=None, base_dir=None, verbose=0, dry_run=0])
-
- Create an archive file (e.g. ``zip`` or ``tar``). *base_name* is the name of
- the file to create, minus any format-specific extension; *format* is the
- archive format: one of ``zip``, ``tar``, ``ztar``, or ``gztar``. *root_dir*
- is a directory that will be the root directory of the archive; i.e. we
- typically
- ``chdir`` into *root_dir* before creating the archive. *base_dir* is the
- directory where we start archiving from; i.e. *base_dir* will be the common
- prefix of all files and directories in the archive. *root_dir* and *base_dir*
- both default to the current directory. Returns the name of the archive file.
-
- .. XXX This should be changed to support bz2 files.
-
-
-.. function:: make_tarball(base_name, base_dir[, compress='gzip', verbose=0, dry_run=0])
-
- 'Create an (optional compressed) archive as a tar file from all files in and
- under *base_dir*. *compress* must be ``'gzip'`` (the default), ``'compress'``,
- ``'bzip2'``, or ``None``. Both :program:`tar` and the compression utility named
- by *compress* must be on the default program search path, so this is probably
- Unix-specific. The output tar file will be named :file:`base_dir.tar`,
- possibly plus the appropriate compression extension (:file:`.gz`, :file:`.bz2`
- or :file:`.Z`). Return the output filename.
-
- .. TODO update to reflect use of the :mod:`tarfile` module.
-
-
-.. function:: make_zipfile(base_name, base_dir[, verbose=0, dry_run=0])
-
- Create a zip file from all files in and under *base_dir*. The output zip file
- will be named *base_name* + :file:`.zip`. Uses either the :mod:`zipfile` Python
- module (if available) or the InfoZIP :file:`zip` utility (if installed and
- found on the default search path). If neither tool is available, raises
- :exc:`DistutilsExecError`. Returns the name of the output zip file.
-
-
-:mod:`distutils2.dep_util` --- Dependency checking
-==================================================
-
-.. module:: distutils2.dep_util
- :synopsis: Utility functions for simple dependency checking
-
-
-This module provides functions for performing simple, timestamp-based
-dependency of files and groups of files; also, functions based entirely on such
-timestamp dependency analysis.
-
-
-.. function:: newer(source, target)
-
- Return true if *source* exists and is more recently modified than *target*,
- or if *source* exists and *target* doesn't. Return false if both exist and
- *target* is the same age or newer than *source*. Raise
- :exc:`DistutilsFileError` if *source* does not exist.
-
-
-.. function:: newer_pairwise(sources, targets)
-
- Walk two filename lists in parallel, testing if each source is newer than its
- corresponding target. Return a pair of lists (*sources*, *targets*) where
- source is newer than target, according to the semantics of :func:`newer`
-
- .. % % equivalent to a listcomp...
-
-
-.. function:: newer_group(sources, target[, missing='error'])
-
- Return true if *target* is out-of-date with respect to any file listed in
- *sources*. In other words, if *target* exists and is newer than every file
- in *sources*, return false; otherwise return true. *missing* controls what
- we do when a source file is missing; the default (``'error'``) is to blow up
- with an :exc:`OSError` from inside :func:`os.stat`; if it is ``'ignore'``, we
- silently drop any missing source files; if it is ``'newer'``, any missing
- source files make us assume that *target* is out-of-date (this is handy in
- "dry-run" mode: it'll make you pretend to carry out commands that wouldn't
- work because inputs are missing, but that doesn't matter because you're not
- actually going to run the commands).
-
-
-:mod:`distutils2.dir_util` --- Directory tree operations
-========================================================
-
-.. module:: distutils2.dir_util
- :synopsis: Utility functions for operating on directories and directory trees
-
-
-This module provides functions for operating on directories and trees of
-directories.
-
-
-.. function:: mkpath(name[, mode=0777, verbose=0, dry_run=0])
-
- Create a directory and any missing ancestor directories. If the directory
- already exists (or if *name* is the empty string, which means the current
- directory, which of course exists), then do nothing. Raise
- :exc:`DistutilsFileError` if unable to create some directory along the way
- (e.g. some sub-path exists, but is a file rather than a directory). If
- *verbose* is true, print a one-line summary of each mkdir to stdout. Return
- the list of directories actually created.
-
-
-.. function:: create_tree(base_dir, files[, mode=0777, verbose=0, dry_run=0])
-
- Create all the empty directories under *base_dir* needed to put *files*
- there. *base_dir* is just the a name of a directory which doesn't necessarily
- exist yet; *files* is a list of filenames to be interpreted relative to
- *base_dir*. *base_dir* + the directory portion of every file in *files* will
- be created if it doesn't already exist. *mode*, *verbose* and *dry_run*
- flags are as for :func:`mkpath`.
-
-
-.. function:: copy_tree(src, dst[, preserve_mode=1, preserve_times=1, preserve_symlinks=0, update=0, verbose=0, dry_run=0])
-
- Copy an entire directory tree *src* to a new location *dst*. Both *src* and
- *dst* must be directory names. If *src* is not a directory, raise
- :exc:`DistutilsFileError`. If *dst* does not exist, it is created with
- :func:`mkpath`. The end result of the copy is that every file in *src* is
- copied to *dst*, and directories under *src* are recursively copied to
- *dst*. Return the list of files that were copied or might have been copied,
- using their output name. The return value is unaffected by *update* or
- *dry_run*: it is simply the list of all files under *src*, with the names
- changed to be under *dst*.
-
- *preserve_mode* and *preserve_times* are the same as for :func:`copy_file`
- in :mod:`distutils2.file_util`; note that they only apply to regular files,
- not to directories. If *preserve_symlinks* is true, symlinks will be copied
- as symlinks (on platforms that support them!); otherwise (the default), the
- destination of the symlink will be copied. *update* and *verbose* are the
- same as for :func:`copy_file`.
-
-
-.. function:: remove_tree(directory[, verbose=0, dry_run=0])
-
- Recursively remove *directory* and all files and directories underneath it.
- Any errors are ignored (apart from being reported to ``sys.stdout`` if
- *verbose* is true).
-
-.. XXX Some of this could be replaced with the shutil module?
-
-
-:mod:`distutils2.file_util` --- Single file operations
-======================================================
-
-.. module:: distutils2.file_util
- :synopsis: Utility functions for operating on single files
-
-
-This module contains some utility functions for operating on individual files.
-
-
-.. function:: copy_file(src, dst[, preserve_mode=1, preserve_times=1, update=0, link=None, verbose=0, dry_run=0])
-
- Copy file *src* to *dst*. If *dst* is a directory, then *src* is copied there
- with the same name; otherwise, it must be a filename. (If the file exists, it
- will be ruthlessly clobbered.) If *preserve_mode* is true (the default), the
- file's mode (type and permission bits, or whatever is analogous on the
- current platform) is copied. If *preserve_times* is true (the default), the
- last-modified and last-access times are copied as well. If *update* is true,
- *src* will only be copied if *dst* does not exist, or if *dst* does exist but
- is older than *src*.
-
- *link* allows you to make hard links (using :func:`os.link`) or symbolic
- links (using :func:`os.symlink`) instead of copying: set it to ``'hard'`` or
- ``'sym'``; if it is ``None`` (the default), files are copied. Don't set
- *link* on systems that don't support it: :func:`copy_file` doesn't check if
- hard or symbolic linking is available. It uses :func:`_copy_file_contents`
- to copy file contents.
-
- Return a tuple ``(dest_name, copied)``: *dest_name* is the actual name of
- the output file, and *copied* is true if the file was copied (or would have
- been copied, if *dry_run* true).
-
- .. % XXX if the destination file already exists, we clobber it if
- .. % copying, but blow up if linking. Hmmm. And I don't know what
- .. % macostools.copyfile() does. Should definitely be consistent, and
- .. % should probably blow up if destination exists and we would be
- .. % changing it (i.e. it's not already a hard/soft link to src OR
- .. % (not update) and (src newer than dst)).
-
-
-.. function:: move_file(src, dst[, verbose, dry_run])
-
- Move file *src* to *dst*. If *dst* is a directory, the file will be moved
- into it with the same name; otherwise, *src* is just renamed to *dst*.
- Returns the new full name of the file.
-
- .. warning::
-
- Handles cross-device moves on Unix using :func:`copy_file`. What about
- other systems?
-
-
-.. function:: write_file(filename, contents)
-
- Create a file called *filename* and write *contents* (a sequence of strings
- without line terminators) to it.
-
-:mod:`distutils2.metadata` --- Metadata handling
-================================================================
-
-.. module:: distutils2.metadata
-
-.. FIXME CPython/stdlib docs don't use autoclass, write doc manually here
-
-.. autoclass:: distutils2.metadata.Metadata
- :members:
-
-:mod:`distutils2.util` --- Miscellaneous other utility functions
-================================================================
-
-.. module:: distutils2.util
- :synopsis: Miscellaneous other utility functions
-
-
-This module contains other assorted bits and pieces that don't fit into any
-other utility module.
-
-
-.. function:: get_platform()
-
- Return a string that identifies the current platform. This is used mainly to
- distinguish platform-specific build directories and platform-specific built
- distributions. Typically includes the OS name and version and the
- architecture (as supplied by 'os.uname()'), although the exact information
- included depends on the OS; e.g. for IRIX the architecture isn't particularly
- important (IRIX only runs on SGI hardware), but for Linux the kernel version
- isn't particularly important.
-
- Examples of returned values:
-
- * ``linux-i586``
- * ``linux-alpha``
- * ``solaris-2.6-sun4u``
- * ``irix-5.3``
- * ``irix64-6.2``
-
- For non-POSIX platforms, currently just returns ``sys.platform``.
-
- For Mac OS X systems the OS version reflects the minimal version on which
- binaries will run (that is, the value of ``MACOSX_DEPLOYMENT_TARGET``
- during the build of Python), not the OS version of the current system.
-
- For universal binary builds on Mac OS X the architecture value reflects
- the univeral binary status instead of the architecture of the current
- processor. For 32-bit universal binaries the architecture is ``fat``,
- for 64-bit universal binaries the architecture is ``fat64``, and
- for 4-way universal binaries the architecture is ``universal``. Starting
- from Python 2.7 and Python 3.2 the architecture ``fat3`` is used for
- a 3-way universal build (ppc, i386, x86_64) and ``intel`` is used for
- a univeral build with the i386 and x86_64 architectures
-
- Examples of returned values on Mac OS X:
-
- * ``macosx-10.3-ppc``
-
- * ``macosx-10.3-fat``
-
- * ``macosx-10.5-universal``
-
- * ``macosx-10.6-intel``
-
- .. XXX reinvention of platform module?
-
-
-.. function:: convert_path(pathname)
-
- Return 'pathname' as a name that will work on the native filesystem, i.e.
- split it on '/' and put it back together again using the current directory
- separator. Needed because filenames in the setup script are always supplied
- in Unix style, and have to be converted to the local convention before we
- can actually use them in the filesystem. Raises :exc:`ValueError` on
- non-Unix-ish systems if *pathname* either starts or ends with a slash.
-
-
-.. function:: change_root(new_root, pathname)
-
- Return *pathname* with *new_root* prepended. If *pathname* is relative, this
- is equivalent to ``os.path.join(new_root,pathname)`` Otherwise, it requires
- making *pathname* relative and then joining the two, which is tricky on
- DOS/Windows.
-
-
-.. function:: check_environ()
-
- Ensure that 'os.environ' has all the environment variables we guarantee that
- users can use in config files, command-line options, etc. Currently this
- includes:
-
- * :envvar:`HOME` - user's home directory (Unix only)
- * :envvar:`PLAT` - description of the current platform, including hardware
- and OS (see :func:`get_platform`)
-
-
-.. function:: subst_vars(s, local_vars)
-
- Perform shell/Perl-style variable substitution on *s*. Every occurrence of
- ``$`` followed by a name is considered a variable, and variable is
- substituted by the value found in the *local_vars* dictionary, or in
- ``os.environ`` if it's not in *local_vars*. *os.environ* is first
- checked/augmented to guarantee that it contains certain values: see
- :func:`check_environ`. Raise :exc:`ValueError` for any variables not found
- in either *local_vars* or ``os.environ``.
-
- Note that this is not a fully-fledged string interpolation function. A valid
- ``$variable`` can consist only of upper and lower case letters, numbers and
- an underscore. No { } or ( ) style quoting is available.
-
-
-.. function:: split_quoted(s)
-
- Split a string up according to Unix shell-like rules for quotes and
- backslashes. In short: words are delimited by spaces, as long as those spaces
- are not escaped by a backslash, or inside a quoted string. Single and double
- quotes are equivalent, and the quote characters can be backslash-escaped.
- The backslash is stripped from any two-character escape sequence, leaving
- only the escaped character. The quote characters are stripped from any
- quoted string. Returns a list of words.
-
- .. % Should probably be moved into the standard library.
-
-
-.. function:: execute(func, args[, msg=None, verbose=0, dry_run=0])
-
- Perform some action that affects the outside world (for instance, writing to
- the filesystem). Such actions are special because they are disabled by the
- *dry_run* flag. This method takes care of all that bureaucracy for you;
- all you have to do is supply the function to call and an argument tuple for
- it (to embody the "external action" being performed), and an optional message
- to print.
-
-
-.. function:: strtobool(val)
-
- Convert a string representation of truth to true (1) or false (0).
-
- True values are ``y``, ``yes``, ``t``, ``true``, ``on`` and ``1``; false
- values are ``n``, ``no``, ``f``, ``false``, ``off`` and ``0``. Raises
- :exc:`ValueError` if *val* is anything else.
-
-.. TODO Add :term: markup to bytecode when merging into the stdlib
-
-.. function:: byte_compile(py_files[, optimize=0, force=0, prefix=None, base_dir=None, verbose=1, dry_run=0, direct=None])
-
- Byte-compile a collection of Python source files to either :file:`.pyc` or
- :file:`.pyo` files in the same directory. *py_files* is a list of files to
- compile; any files that don't end in :file:`.py` are silently skipped.
- *optimize* must be one of the following:
-
- * ``0`` - don't optimize (generate :file:`.pyc`)
- * ``1`` - normal optimization (like ``python -O``)
- * ``2`` - extra optimization (like ``python -OO``)
-
- If *force* is true, all files are recompiled regardless of timestamps.
-
- The source filename encoded in each bytecode file defaults to the filenames
- listed in *py_files*; you can modify these with *prefix* and *basedir*.
- *prefix* is a string that will be stripped off of each source filename, and
- *base_dir* is a directory name that will be prepended (after *prefix* is
- stripped). You can supply either or both (or neither) of *prefix* and
- *base_dir*, as you wish.
-
- If *dry_run* is true, doesn't actually do anything that would affect the
- filesystem.
-
- Byte-compilation is either done directly in this interpreter process with the
- standard :mod:`py_compile` module, or indirectly by writing a temporary
- script and executing it. Normally, you should let :func:`byte_compile`
- figure out to use direct compilation or not (see the source for details).
- The *direct* flag is used by the script generated in indirect mode; unless
- you know what you're doing, leave it set to ``None``.
-
-
-.. function:: rfc822_escape(header)
-
- Return a version of *header* escaped for inclusion in an :rfc:`822` header, by
- ensuring there are 8 spaces space after each newline. Note that it does no
- other modification of the string.
-
- .. % this _can_ be replaced
-
-.. % \subsection{Distutils objects}
-
-
-:mod:`distutils2.dist` --- The Distribution class
-=================================================
-
-.. module:: distutils2.dist
- :synopsis: Provides the Distribution class, which represents the module
- distribution being built/installed/distributed
-
-
-This module provides the :class:`Distribution` class, which represents the
-module distribution being built/installed/distributed.
-
-
-:mod:`distutils2.extension` --- The Extension class
-===================================================
-
-.. module:: distutils2.extension
- :synopsis: Provides the Extension class, used to describe C/C++ extension
- modules in setup scripts
-
-
-This module provides the :class:`Extension` class, used to describe C/C++
-extension modules in setup scripts.
-
-.. % \subsection{Ungrouped modules}
-.. % The following haven't been moved into a more appropriate section yet.
-
-
-:mod:`distutils2.debug` --- Distutils debug mode
-================================================
-
-.. module:: distutils2.debug
- :synopsis: Provides the debug flag for distutils
-
-
-This module provides the DEBUG flag.
-
-
-:mod:`distutils2.errors` --- Distutils exceptions
-=================================================
-
-.. module:: distutils2.errors
- :synopsis: Provides standard distutils exceptions
-
-
-Provides exceptions used by the Distutils modules. Note that Distutils modules
-may raise standard exceptions; in particular, SystemExit is usually raised for
-errors that are obviously the end-user's fault (e.g. bad command-line arguments).
-
-This module is safe to use in ``from ... import *`` mode; it only exports
-symbols whose names start with ``Distutils`` and end with ``Error``.
-
-
-:mod:`distutils2.fancy_getopt` --- Wrapper around the standard getopt module
-============================================================================
-
-.. module:: distutils2.fancy_getopt
- :synopsis: Additional getopt functionality
-
-
-This module provides a wrapper around the standard :mod:`getopt` module that
-provides the following additional features:
-
-* short and long options are tied together
-
-* options have help strings, so :func:`fancy_getopt` could potentially create a
- complete usage summary
-
-* options set attributes of a passed-in object
-
-* boolean options can have "negative aliases" --- e.g. if :option:`--quiet` is
- the "negative alias" of :option:`--verbose`, then :option:`--quiet` on the
- command line sets *verbose* to false.
-
-.. XXX Should be replaced with :mod:`argparse`.
-
-
-.. function:: fancy_getopt(options, negative_opt, object, args)
-
- Wrapper function. *options* is a list of ``(long_option, short_option,
- help_string)`` 3-tuples as described in the constructor for
- :class:`FancyGetopt`. *negative_opt* should be a dictionary mapping option names
- to option names, both the key and value should be in the *options* list.
- *object* is an object which will be used to store values (see the :meth:`getopt`
- method of the :class:`FancyGetopt` class). *args* is the argument list. Will use
- ``sys.argv[1:]`` if you pass ``None`` as *args*.
-
-
-.. function:: wrap_text(text, width)
-
- Wraps *text* to less than *width* wide.
-
- .. XXX Should be replaced with :mod:`textwrap` (which is available in Python
- 2.3 and later).
-
-
-.. class:: FancyGetopt([option_table=None])
-
- The option_table is a list of 3-tuples: ``(long_option, short_option,
- help_string)``
-
- If an option takes an argument, its *long_option* should have ``'='`` appended;
- *short_option* should just be a single character, no ``':'`` in any case.
- *short_option* should be ``None`` if a *long_option* doesn't have a
- corresponding *short_option*. All option tuples must have long options.
-
-The :class:`FancyGetopt` class provides the following methods:
-
-
-.. method:: FancyGetopt.getopt([args=None, object=None])
-
- Parse command-line options in args. Store as attributes on *object*.
-
- If *args* is ``None`` or not supplied, uses ``sys.argv[1:]``. If *object* is
- ``None`` or not supplied, creates a new :class:`OptionDummy` instance, stores
- option values there, and returns a tuple ``(args, object)``. If *object* is
- supplied, it is modified in place and :func:`getopt` just returns *args*; in
- both cases, the returned *args* is a modified copy of the passed-in *args* list,
- which is left untouched.
-
- .. % and args returned are?
-
-
-.. method:: FancyGetopt.get_option_order()
-
- Returns the list of ``(option, value)`` tuples processed by the previous run of
- :meth:`getopt` Raises :exc:`RuntimeError` if :meth:`getopt` hasn't been called
- yet.
-
-
-.. method:: FancyGetopt.generate_help([header=None])
-
- Generate help text (a list of strings, one per suggested line of output) from
- the option table for this :class:`FancyGetopt` object.
-
- If supplied, prints the supplied *header* at the top of the help.
-
-
-:mod:`distutils2.filelist` --- The FileList class
-=================================================
-
-.. module:: distutils2.filelist
- :synopsis: The FileList class, used for poking about the file system and
- building lists of files.
-
-
-This module provides the :class:`FileList` class, used for poking about the
-filesystem and building lists of files.
-
-.. TODO move to util
-
-
-:mod:`distutils2.log` --- Simple PEP 282-style logging
-======================================================
-
-.. module:: distutils2.log
- :synopsis: A simple logging mechanism, 282-style
-
-
-.. XXX Should be replaced with standard :mod:`logging` module.
-
-
-
-:mod:`distutils2.spawn` --- Spawn a sub-process
-===============================================
-
-.. module:: distutils2.spawn
- :synopsis: Provides the spawn() function
-
-
-This module provides the :func:`spawn` function, a front-end to various
-platform-specific functions for launching another program in a sub-process.
-Also provides :func:`find_executable` to search the path for a given executable
-name.
-
-
-:mod:`distutils2.sysconfig` --- System configuration information
-================================================================
-
-.. module:: distutils2.sysconfig
- :synopsis: Low-level access to configuration information of the Python interpreter.
-.. moduleauthor:: Fred L. Drake, Jr. <fdrake at acm.org>
-.. moduleauthor:: Greg Ward <gward at python.net>
-.. sectionauthor:: Fred L. Drake, Jr. <fdrake at acm.org>
-
-
-The :mod:`distutils2.sysconfig` module provides access to Python's low-level
-configuration information. The specific configuration variables available
-depend heavily on the platform and configuration. The specific variables depend
-on the build process for the specific version of Python being run; the variables
-are those found in the :file:`Makefile` and configuration header that are
-installed with Python on Unix systems. The configuration header is called
-:file:`pyconfig.h` for Python versions starting with 2.2, and :file:`config.h`
-for earlier versions of Python.
-
-Some additional functions are provided which perform some useful manipulations
-for other parts of the :mod:`distutils2` package.
-
-
-.. data:: PREFIX
-
- The result of ``os.path.normpath(sys.prefix)``.
-
-
-.. data:: EXEC_PREFIX
-
- The result of ``os.path.normpath(sys.exec_prefix)``.
-
-
-.. function:: get_config_var(name)
-
- Return the value of a single variable. This is equivalent to
- ``get_config_vars().get(name)``.
-
-
-.. function:: get_config_vars(...)
-
- Return a set of variable definitions. If there are no arguments, this returns a
- dictionary mapping names of configuration variables to values. If arguments are
- provided, they should be strings, and the return value will be a sequence giving
- the associated values. If a given name does not have a corresponding value,
- ``None`` will be included for that variable.
-
-
-.. function:: get_config_h_filename()
-
- Return the full path name of the configuration header. For Unix, this will be
- the header generated by the :program:`configure` script; for other platforms the
- header will have been supplied directly by the Python source distribution. The
- file is a platform-specific text file.
-
-
-.. function:: get_makefile_filename()
-
- Return the full path name of the :file:`Makefile` used to build Python. For
- Unix, this will be a file generated by the :program:`configure` script; the
- meaning for other platforms will vary. The file is a platform-specific text
- file, if it exists. This function is only useful on POSIX platforms.
-
-
-.. function:: get_python_inc([plat_specific[, prefix]])
-
- Return the directory for either the general or platform-dependent C include
- files. If *plat_specific* is true, the platform-dependent include directory is
- returned; if false or omitted, the platform-independent directory is returned.
- If *prefix* is given, it is used as either the prefix instead of
- :const:`PREFIX`, or as the exec-prefix instead of :const:`EXEC_PREFIX` if
- *plat_specific* is true.
-
-
-.. function:: get_python_lib([plat_specific[, standard_lib[, prefix]]])
-
- Return the directory for either the general or platform-dependent library
- installation. If *plat_specific* is true, the platform-dependent include
- directory is returned; if false or omitted, the platform-independent directory
- is returned. If *prefix* is given, it is used as either the prefix instead of
- :const:`PREFIX`, or as the exec-prefix instead of :const:`EXEC_PREFIX` if
- *plat_specific* is true. If *standard_lib* is true, the directory for the
- standard library is returned rather than the directory for the installation of
- third-party extensions.
-
-The following function is only intended for use within the :mod:`distutils2`
-package.
-
-
-.. function:: customize_compiler(compiler)
-
- Do any platform-specific customization of a
- :class:`distutils2.ccompiler.CCompiler` instance.
-
- This function is only needed on Unix at this time, but should be called
- consistently to support forward-compatibility. It inserts the information that
- varies across Unix flavors and is stored in Python's :file:`Makefile`. This
- information includes the selected compiler, compiler and linker options, and the
- extension used by the linker for shared objects.
-
-This function is even more special-purpose, and should only be used from
-Python's own build procedures.
-
-
-.. function:: set_python_build()
-
- Inform the :mod:`distutils2.sysconfig` module that it is being used as part of
- the build process for Python. This changes a lot of relative locations for
- files, allowing them to be located in the build area rather than in an installed
- Python.
-
-
-:mod:`distutils2.text_file` --- The TextFile class
-==================================================
-
-.. module:: distutils2.text_file
- :synopsis: provides the TextFile class, a simple interface to text files
-
-
-This module provides the :class:`TextFile` class, which gives an interface to
-text files that (optionally) takes care of stripping comments, ignoring blank
-lines, and joining lines with backslashes.
-
-
-.. class:: TextFile([filename=None, file=None, **options])
-
- This class provides a file-like object that takes care of all the things you
- commonly want to do when processing a text file that has some line-by-line
- syntax: strip comments (as long as ``#`` is your comment character), skip blank
- lines, join adjacent lines by escaping the newline (i.e. backslash at end of
- line), strip leading and/or trailing whitespace. All of these are optional and
- independently controllable.
-
- The class provides a :meth:`warn` method so you can generate warning messages
- that report physical line number, even if the logical line in question spans
- multiple physical lines. Also provides :meth:`unreadline` for implementing
- line-at-a-time lookahead.
-
- :class:`TextFile` instances are create with either *filename*, *file*, or both.
- :exc:`RuntimeError` is raised if both are ``None``. *filename* should be a
- string, and *file* a file object (or something that provides :meth:`readline`
- and :meth:`close` methods). It is recommended that you supply at least
- *filename*, so that :class:`TextFile` can include it in warning messages. If
- *file* is not supplied, :class:`TextFile` creates its own using the
- :func:`open` built-in function.
-
- The options are all boolean, and affect the values returned by :meth:`readline`
-
- +------------------+--------------------------------+---------+
- | option name | description | default |
- +==================+================================+=========+
- | *strip_comments* | strip from ``'#'`` to end-of- | true |
- | | line, as well as any | |
- | | whitespace leading up to the | |
- | | ``'#'``\ ---unless it is | |
- | | escaped by a backslash | |
- +------------------+--------------------------------+---------+
- | *lstrip_ws* | strip leading whitespace from | false |
- | | each line before returning it | |
- +------------------+--------------------------------+---------+
- | *rstrip_ws* | strip trailing whitespace | true |
- | | (including line terminator!) | |
- | | from each line before | |
- | | returning it. | |
- +------------------+--------------------------------+---------+
- | *skip_blanks* | skip lines that are empty | true |
- | | \*after\* stripping comments | |
- | | and whitespace. (If both | |
- | | lstrip_ws and rstrip_ws are | |
- | | false, then some lines may | |
- | | consist of solely whitespace: | |
- | | these will \*not\* be skipped, | |
- | | even if *skip_blanks* is | |
- | | true.) | |
- +------------------+--------------------------------+---------+
- | *join_lines* | if a backslash is the last | false |
- | | non-newline character on a | |
- | | line after stripping comments | |
- | | and whitespace, join the | |
- | | following line to it to form | |
- | | one logical line; if N | |
- | | consecutive lines end with a | |
- | | backslash, then N+1 physical | |
- | | lines will be joined to form | |
- | | one logical line. | |
- +------------------+--------------------------------+---------+
- | *collapse_join* | strip leading whitespace from | false |
- | | lines that are joined to their | |
- | | predecessor; only matters if | |
- | | ``(join_lines and not | |
- | | lstrip_ws)`` | |
- +------------------+--------------------------------+---------+
-
- Note that since *rstrip_ws* can strip the trailing newline, the semantics of
- :meth:`readline` must differ from those of the built-in file object's
- :meth:`readline` method! In particular, :meth:`readline` returns ``None`` for
- end-of-file: an empty string might just be a blank line (or an all-whitespace
- line), if *rstrip_ws* is true but *skip_blanks* is not.
-
-
- .. method:: TextFile.open(filename)
-
- Open a new file *filename*. This overrides any *file* or *filename*
- constructor arguments.
-
-
- .. method:: TextFile.close()
-
- Close the current file and forget everything we know about it (including the
- filename and the current line number).
-
-
- .. method:: TextFile.warn(msg[,line=None])
-
- Print (to stderr) a warning message tied to the current logical line in the
- current file. If the current logical line in the file spans multiple physical
- lines, the warning refers to the whole range, such as ``"lines 3-5"``. If
- *line* is supplied, it overrides the current line number; it may be a list or
- tuple to indicate a range of physical lines, or an integer for a single
- physical line.
-
-
- .. method:: TextFile.readline()
-
- Read and return a single logical line from the current file (or from an internal
- buffer if lines have previously been "unread" with :meth:`unreadline`). If the
- *join_lines* option is true, this may involve reading multiple physical lines
- concatenated into a single string. Updates the current line number, so calling
- :meth:`warn` after :meth:`readline` emits a warning about the physical line(s)
- just read. Returns ``None`` on end-of-file, since the empty string can occur
- if *rstrip_ws* is true but *strip_blanks* is not.
-
-
- .. method:: TextFile.readlines()
-
- Read and return the list of all logical lines remaining in the current file.
- This updates the current line number to the last line of the file.
-
-
- .. method:: TextFile.unreadline(line)
-
- Push *line* (a string) onto an internal buffer that will be checked by future
- :meth:`readline` calls. Handy for implementing a parser with line-at-a-time
- lookahead. Note that lines that are "unread" with :meth:`unreadline` are not
- subsequently re-cleansed (whitespace stripped, or whatever) when read with
- :meth:`readline`. If multiple calls are made to :meth:`unreadline` before a call
- to :meth:`readline`, the lines will be returned most in most recent first order.
-
-
-:mod:`distutils2.version` --- Version number classes
-====================================================
-
-.. module:: distutils2.version
- :synopsis: implements classes that represent module version numbers.
-
-
-.. % todo
-.. % \section{Distutils Commands}
-.. %
-.. % This part of Distutils implements the various Distutils commands, such
-.. % as \code{build}, \code{install} \&c. Each command is implemented as a
-.. % separate module, with the command name as the name of the module.
-
-
-:mod:`distutils2.cmd` --- Abstract base class for Distutils commands
-====================================================================
-
-.. module:: distutils2.cmd
- :synopsis: This module provides the abstract base class Command. This class
- is subclassed by the modules in the distutils.command subpackage.
-
-
-This module supplies the abstract base class :class:`Command`.
-
-
-.. class:: Command(dist)
-
- Abstract base class for defining command classes, the "worker bees" of the
- Distutils. A useful analogy for command classes is to think of them as
- subroutines with local variables called *options*. The options are declared
- in :meth:`initialize_options` and defined (given their final values) in
- :meth:`finalize_options`, both of which must be defined by every command
- class. The distinction between the two is necessary because option values
- might come from the outside world (command line, config file, ...), and any
- options dependent on other options must be computed after these outside
- influences have been processed --- hence :meth:`finalize_options`. The body
- of the subroutine, where it does all its work based on the values of its
- options, is the :meth:`run` method, which must also be implemented by every
- command class.
-
- The class constructor takes a single argument *dist*, a :class:`Distribution`
- instance.
-
-
-.. % todo
-
-:mod:`distutils2.command.check` --- Check the metadata of a package
-===================================================================
-
-.. module:: distutils2.command.check
- :synopsis: Check the metadata of a package
-
-
-The ``check`` command performs some tests on the metadata of a package.
-For example, it verifies that all required metadata are provided as
-the arguments passed to the :func:`setup` function.
-
-.. % todo
-
-Creating a new Distutils command
-================================
-
-This section outlines the steps to create a new Distutils command.
-
-A new command lives in a module in the :mod:`distutils2.command` package. There
-is a sample template in that directory called :file:`command_template`. Copy
-this file to a new module with the same name as the new command you're
-implementing. This module should implement a class with the same name as the
-module (and the command). So, for instance, to create the command
-``peel_banana`` (so that users can run ``setup.py peel_banana``), you'd copy
-:file:`command_template` to :file:`distutils2/command/peel_banana.py`, then edit
-it so that it's implementing the class :class:`peel_banana`, a subclass of
-:class:`distutils2.cmd.Command`.
-
-Subclasses of :class:`Command` must define the following methods.
-
-.. method:: Command.initialize_options()
-
- Set default values for all the options that this command supports. Note that
- these defaults may be overridden by other commands, by the setup script, by
- config files, or by the command line. Thus, this is not the place to code
- dependencies between options; generally, :meth:`initialize_options`
- implementations are just a bunch of ``self.foo = None`` assignments.
-
-
-.. method:: Command.finalize_options()
-
- Set final values for all the options that this command supports. This is
- always called as late as possible, i.e. after any option assignments from the
- command line or from other commands have been done. Thus, this is the place
- to to code option dependencies: if *foo* depends on *bar*, then it is safe to
- set *foo* from *bar* as long as *foo* still has the same value it was
- assigned in :meth:`initialize_options`.
-
-
-.. method:: Command.run()
-
- A command's raison d'etre: carry out the action it exists to perform,
- controlled by the options initialized in :meth:`initialize_options`,
- customized by other commands, the setup script, the command line, and config
- files, and finalized in :meth:`finalize_options`. All terminal output and
- filesystem interaction should be done by :meth:`run`.
-
-
-.. attribute:: Command.sub_commands
-
- *sub_commands* formalizes the notion of a "family" of commands,
- e.g. ``install`` as the parent with sub-commands ``install_lib``,
- ``install_headers``, etc. The parent of a family of commands defines
- *sub_commands* as a class attribute; it's a list of 2-tuples ``(command_name,
- predicate)``, with *command_name* a string and *predicate* a function, a
- string or ``None``. *predicate* is a method of the parent command that
- determines whether the corresponding command is applicable in the current
- situation. (E.g. ``install_headers`` is only applicable if we have any C
- header files to install.) If *predicate* is ``None``, that command is always
- applicable.
-
- *sub_commands* is usually defined at the *end* of a class, because
- predicates can be methods of the class, so they must already have been
- defined. The canonical example is the :command:`install` command.
-
-
-:mod:`distutils2.command` --- Individual Distutils commands
-===========================================================
-
-.. module:: distutils2.command
- :synopsis: This subpackage contains one module for each standard Distutils command.
-
-
-.. % \subsubsection{Individual Distutils commands}
-.. % todo
-
-
-:mod:`distutils2.command.bdist` --- Build a binary installer
-============================================================
-
-.. module:: distutils2.command.bdist
- :synopsis: Build a binary installer for a package
-
-
-.. % todo
-
-
-:mod:`distutils2.command.bdist_dumb` --- Build a "dumb" installer
-=================================================================
-
-.. module:: distutils2.command.bdist_dumb
- :synopsis: Build a "dumb" installer - a simple archive of files
-
-
-.. % todo
-
-
-:mod:`distutils2.command.bdist_msi` --- Build a Microsoft Installer binary package
-==================================================================================
-
-.. module:: distutils2.command.bdist_msi
- :synopsis: Build a binary distribution as a Windows MSI file
-
-.. class:: bdist_msi(Command)
-
- Builds a `Windows Installer`_ (.msi) binary package.
-
- .. _Windows Installer: http://msdn.microsoft.com/en-us/library/cc185688(VS.85).aspx
-
- In most cases, the ``bdist_msi`` installer is a better choice than the
- ``bdist_wininst`` installer, because it provides better support for
- Win64 platforms, allows administrators to perform non-interactive
- installations, and allows installation through group policies.
-
-
-:mod:`distutils2.command.bdist_wininst` --- Build a Windows installer
-=====================================================================
-
-.. module:: distutils2.command.bdist_wininst
- :synopsis: Build a Windows installer
-
-
-.. % todo
-
-
-:mod:`distutils2.command.sdist` --- Build a source distribution
-===============================================================
-
-.. module:: distutils2.command.sdist
- :synopsis: Build a source distribution
-
-
-.. % todo
-
-
-:mod:`distutils2.command.build` --- Build all files of a package
-================================================================
-
-.. module:: distutils2.command.build
- :synopsis: Build all files of a package
-
-
-.. % todo
-
-
-:mod:`distutils2.command.build_clib` --- Build any C libraries in a package
-===========================================================================
-
-.. module:: distutils2.command.build_clib
- :synopsis: Build any C libraries in a package
-
-
-.. % todo
-
-
-:mod:`distutils2.command.build_ext` --- Build any extensions in a package
-=========================================================================
-
-.. module:: distutils2.command.build_ext
- :synopsis: Build any extensions in a package
-
-
-.. % todo
-
-
-:mod:`distutils2.command.build_py` --- Build the .py/.pyc files of a package
-============================================================================
-
-.. module:: distutils2.command.build_py
- :synopsis: Build the .py/.pyc files of a package
-
-
-.. class:: build_py(Command)
-
-
-:mod:`distutils2.command.build_scripts` --- Build the scripts of a package
-==========================================================================
-
-.. module:: distutils2.command.build_scripts
- :synopsis: Build the scripts of a package
-
-
-.. % todo
-
-
-:mod:`distutils2.command.clean` --- Clean a package build area
-==============================================================
-
-.. module:: distutils2.command.clean
- :synopsis: Clean a package build area
-
-
-.. % todo
-
-
-:mod:`distutils2.command.config` --- Perform package configuration
-==================================================================
-
-.. module:: distutils2.command.config
- :synopsis: Perform package configuration
-
-
-.. % todo
-
-
-:mod:`distutils2.command.install` --- Install a package
-=======================================================
-
-.. module:: distutils2.command.install
- :synopsis: Install a package
-
-
-.. % todo
-
-
-:mod:`distutils2.command.install_data` --- Install data files from a package
-============================================================================
-
-.. module:: distutils2.command.install_data
- :synopsis: Install data files from a package
-
-
-.. % todo
-
-
-:mod:`distutils2.command.install_headers` --- Install C/C++ header files from a package
-=======================================================================================
-
-.. module:: distutils2.command.install_headers
- :synopsis: Install C/C++ header files from a package
-
-
-.. % todo
-
-
-:mod:`distutils2.command.install_lib` --- Install library files from a package
-==============================================================================
-
-.. module:: distutils2.command.install_lib
- :synopsis: Install library files from a package
-
-
-.. % todo
-
-
-:mod:`distutils2.command.install_scripts` --- Install script files from a package
-=================================================================================
-
-.. module:: distutils2.command.install_scripts
- :synopsis: Install script files from a package
-
-
-.. % todo
-
-
-:mod:`distutils2.command.register` --- Register a module with the Python Package Index
-======================================================================================
-
-.. module:: distutils2.command.register
- :synopsis: Register a module with the Python Package Index
-
-
-The ``register`` command registers the package with the Python Package Index.
-This is described in more detail in :PEP:`301`.
-
-.. % todo
diff --git a/docs/source/distutils/builtdist.rst b/docs/source/distutils/builtdist.rst
deleted file mode 100644
--- a/docs/source/distutils/builtdist.rst
+++ /dev/null
@@ -1,454 +0,0 @@
-.. _built-dist:
-
-****************************
-Creating Built Distributions
-****************************
-
-A "built distribution" is what you're probably used to thinking of either as a
-"binary package" or an "installer" (depending on your background). It's not
-necessarily binary, though, because it might contain only Python source code
-and/or byte-code; and we don't call it a package, because that word is already
-spoken for in Python. (And "installer" is a term specific to the world of
-mainstream desktop systems.)
-
-A built distribution is how you make life as easy as possible for installers of
-your module distribution: for users of RPM-based Linux systems, it's a binary
-RPM; for Windows users, it's an executable installer; for Debian-based Linux
-users, it's a Debian package; and so forth. Obviously, no one person will be
-able to create built distributions for every platform under the sun, so the
-Distutils are designed to enable module developers to concentrate on their
-specialty---writing code and creating source distributions---while an
-intermediary species called *packagers* springs up to turn source distributions
-into built distributions for as many platforms as there are packagers.
-
-Of course, the module developer could be his own packager; or the packager could
-be a volunteer "out there" somewhere who has access to a platform which the
-original developer does not; or it could be software periodically grabbing new
-source distributions and turning them into built distributions for as many
-platforms as the software has access to. Regardless of who they are, a packager
-uses the setup script and the :command:`bdist` command family to generate built
-distributions.
-
-As a simple example, if I run the following command in the Distutils source
-tree::
-
- python setup.py bdist
-
-then the Distutils builds my module distribution (the Distutils itself in this
-case), does a "fake" installation (also in the :file:`build` directory), and
-creates the default type of built distribution for my platform. The default
-format for built distributions is a "dumb" tar file on Unix, and a simple
-executable installer on Windows. (That tar file is considered "dumb" because it
-has to be unpacked in a specific location to work.)
-
-Thus, the above command on a Unix system creates
-:file:`Distutils-1.0.{plat}.tar.gz`; unpacking this tarball from the right place
-installs the Distutils just as though you had downloaded the source distribution
-and run ``python setup.py install``. (The "right place" is either the root of
-the filesystem or Python's :file:`{prefix}` directory, depending on the options
-given to the :command:`bdist_dumb` command; the default is to make dumb
-distributions relative to :file:`{prefix}`.)
-
-Obviously, for pure Python distributions, this isn't any simpler than just
-running ``python setup.py install``\ ---but for non-pure distributions, which
-include extensions that would need to be compiled, it can mean the difference
-between someone being able to use your extensions or not. And creating "smart"
-built distributions, such as an RPM package or an executable installer for
-Windows, is far more convenient for users even if your distribution doesn't
-include any extensions.
-
-The :command:`bdist` command has a :option:`--formats` option, similar to the
-:command:`sdist` command, which you can use to select the types of built
-distribution to generate: for example, ::
-
- python setup.py bdist --format=zip
-
-would, when run on a Unix system, create :file:`Distutils-1.0.{plat}.zip`\
----again, this archive would be unpacked from the root directory to install the
-Distutils.
-
-The available formats for built distributions are:
-
-+-------------+------------------------------+---------+
-| Format | Description | Notes |
-+=============+==============================+=========+
-| ``gztar`` | gzipped tar file | (1),(3) |
-| | (:file:`.tar.gz`) | |
-+-------------+------------------------------+---------+
-| ``ztar`` | compressed tar file | \(3) |
-| | (:file:`.tar.Z`) | |
-+-------------+------------------------------+---------+
-| ``tar`` | tar file (:file:`.tar`) | \(3) |
-+-------------+------------------------------+---------+
-| ``zip`` | zip file (:file:`.zip`) | (2),(4) |
-+-------------+------------------------------+---------+
-| ``rpm`` | RPM | \(5) |
-+-------------+------------------------------+---------+
-| ``pkgtool`` | Solaris :program:`pkgtool` | |
-+-------------+------------------------------+---------+
-| ``sdux`` | HP-UX :program:`swinstall` | |
-+-------------+------------------------------+---------+
-| ``rpm`` | RPM | \(5) |
-+-------------+------------------------------+---------+
-| ``wininst`` | self-extracting ZIP file for | \(4) |
-| | Windows | |
-+-------------+------------------------------+---------+
-| ``msi`` | Microsoft Installer. | |
-+-------------+------------------------------+---------+
-
-
-Notes:
-
-(1)
- default on Unix
-
-(2)
- default on Windows
-
-(3)
- requires external utilities: :program:`tar` and possibly one of :program:`gzip`,
- :program:`bzip2`, or :program:`compress`
-
-(4)
- requires either external :program:`zip` utility or :mod:`zipfile` module (part
- of the standard Python library since Python 1.6)
-
-(5)
- requires external :program:`rpm` utility, version 3.0.4 or better (use ``rpm
- --version`` to find out which version you have)
-
-You don't have to use the :command:`bdist` command with the :option:`--formats`
-option; you can also use the command that directly implements the format you're
-interested in. Some of these :command:`bdist` "sub-commands" actually generate
-several similar formats; for instance, the :command:`bdist_dumb` command
-generates all the "dumb" archive formats (``tar``, ``ztar``, ``gztar``, and
-``zip``), and :command:`bdist_rpm` generates both binary and source RPMs. The
-:command:`bdist` sub-commands, and the formats generated by each, are:
-
-+--------------------------+-----------------------+
-| Command | Formats |
-+==========================+=======================+
-| :command:`bdist_dumb` | tar, ztar, gztar, zip |
-+--------------------------+-----------------------+
-| :command:`bdist_rpm` | rpm, srpm |
-+--------------------------+-----------------------+
-| :command:`bdist_wininst` | wininst |
-+--------------------------+-----------------------+
-| :command:`bdist_msi` | msi |
-+--------------------------+-----------------------+
-
-The following sections give details on the individual :command:`bdist_\*`
-commands.
-
-
-.. _creating-dumb:
-
-Creating dumb built distributions
-=================================
-
-.. XXX Need to document absolute vs. prefix-relative packages here, but first
- I have to implement it!
-
-
-.. _creating-rpms:
-
-Creating RPM packages
-=====================
-
-The RPM format is used by many popular Linux distributions, including Red Hat,
-SuSE, and Mandrake. If one of these (or any of the other RPM-based Linux
-distributions) is your usual environment, creating RPM packages for other users
-of that same distribution is trivial. Depending on the complexity of your module
-distribution and differences between Linux distributions, you may also be able
-to create RPMs that work on different RPM-based distributions.
-
-The usual way to create an RPM of your module distribution is to run the
-:command:`bdist_rpm` command::
-
- python setup.py bdist_rpm
-
-or the :command:`bdist` command with the :option:`--format` option::
-
- python setup.py bdist --formats=rpm
-
-The former allows you to specify RPM-specific options; the latter allows you to
-easily specify multiple formats in one run. If you need to do both, you can
-explicitly specify multiple :command:`bdist_\*` commands and their options::
-
- python setup.py bdist_rpm --packager="John Doe <jdoe at example.org>" \
- bdist_wininst --target-version="2.0"
-
-Creating RPM packages is driven by a :file:`.spec` file, much as using the
-Distutils is driven by the setup script. To make your life easier, the
-:command:`bdist_rpm` command normally creates a :file:`.spec` file based on the
-information you supply in the setup script, on the command line, and in any
-Distutils configuration files. Various options and sections in the
-:file:`.spec` file are derived from options in the setup script as follows:
-
-+------------------------------------------+----------------------------------------------+
-| RPM :file:`.spec` file option or section | Distutils setup script option |
-+==========================================+==============================================+
-| Name | :option:`name` |
-+------------------------------------------+----------------------------------------------+
-| Summary (in preamble) | :option:`description` |
-+------------------------------------------+----------------------------------------------+
-| Version | :option:`version` |
-+------------------------------------------+----------------------------------------------+
-| Vendor | :option:`author` and :option:`author_email`, |
-| | or --- & :option:`maintainer` and |
-| | :option:`maintainer_email` |
-+------------------------------------------+----------------------------------------------+
-| Copyright | :option:`license` |
-+------------------------------------------+----------------------------------------------+
-| Url | :option:`url` |
-+------------------------------------------+----------------------------------------------+
-| %description (section) | :option:`long_description` |
-+------------------------------------------+----------------------------------------------+
-
-Additionally, there are many options in :file:`.spec` files that don't have
-corresponding options in the setup script. Most of these are handled through
-options to the :command:`bdist_rpm` command as follows:
-
-+-------------------------------+-----------------------------+-------------------------+
-| RPM :file:`.spec` file option | :command:`bdist_rpm` option | default value |
-| or section | | |
-+===============================+=============================+=========================+
-| Release | :option:`release` | "1" |
-+-------------------------------+-----------------------------+-------------------------+
-| Group | :option:`group` | "Development/Libraries" |
-+-------------------------------+-----------------------------+-------------------------+
-| Vendor | :option:`vendor` | (see above) |
-+-------------------------------+-----------------------------+-------------------------+
-| Packager | :option:`packager` | (none) |
-+-------------------------------+-----------------------------+-------------------------+
-| Provides | :option:`provides` | (none) |
-+-------------------------------+-----------------------------+-------------------------+
-| Requires | :option:`requires` | (none) |
-+-------------------------------+-----------------------------+-------------------------+
-| Conflicts | :option:`conflicts` | (none) |
-+-------------------------------+-----------------------------+-------------------------+
-| Obsoletes | :option:`obsoletes` | (none) |
-+-------------------------------+-----------------------------+-------------------------+
-| Distribution | :option:`distribution_name` | (none) |
-+-------------------------------+-----------------------------+-------------------------+
-| BuildRequires | :option:`build_requires` | (none) |
-+-------------------------------+-----------------------------+-------------------------+
-| Icon | :option:`icon` | (none) |
-+-------------------------------+-----------------------------+-------------------------+
-
-Obviously, supplying even a few of these options on the command line would be
-tedious and error-prone, so it's usually best to put them in the setup
-configuration file, :file:`setup.cfg`\ ---see section :ref:`setup-config`. If
-you distribute or package many Python module distributions, you might want to
-put options that apply to all of them in your personal Distutils configuration
-file (:file:`~/.pydistutils.cfg`). If you want to temporarily disable
-this file, you can pass the --no-user-cfg option to setup.py.
-
-There are three steps to building a binary RPM package, all of which are
-handled automatically by the Distutils:
-
-#. create a :file:`.spec` file, which describes the package (analogous to the
- Distutils setup script; in fact, much of the information in the setup script
- winds up in the :file:`.spec` file)
-
-#. create the source RPM
-
-#. create the "binary" RPM (which may or may not contain binary code, depending
- on whether your module distribution contains Python extensions)
-
-Normally, RPM bundles the last two steps together; when you use the Distutils,
-all three steps are typically bundled together.
-
-If you wish, you can separate these three steps. You can use the
-:option:`--spec-only` option to make :command:`bdist_rpm` just create the
-:file:`.spec` file and exit; in this case, the :file:`.spec` file will be
-written to the "distribution directory"---normally :file:`dist/`, but
-customizable with the :option:`--dist-dir` option. (Normally, the :file:`.spec`
-file winds up deep in the "build tree," in a temporary directory created by
-:command:`bdist_rpm`.)
-
-.. % \XXX{this isn't implemented yet---is it needed?!}
-.. % You can also specify a custom \file{.spec} file with the
-.. % \longprogramopt{spec-file} option; used in conjunction with
-.. % \longprogramopt{spec-only}, this gives you an opportunity to customize
-.. % the \file{.spec} file manually:
-.. %
-.. % \ begin{verbatim}
-.. % > python setup.py bdist_rpm --spec-only
-.. % # ...edit dist/FooBar-1.0.spec
-.. % > python setup.py bdist_rpm --spec-file=dist/FooBar-1.0.spec
-.. % \ end{verbatim}
-.. %
-.. % (Although a better way to do this is probably to override the standard
-.. % \command{bdist\_rpm} command with one that writes whatever else you want
-.. % to the \file{.spec} file.)
-
-
-.. _creating-wininst:
-
-Creating Windows Installers
-===========================
-
-Executable installers are the natural format for binary distributions on
-Windows. They display a nice graphical user interface, display some information
-about the module distribution to be installed taken from the metadata in the
-setup script, let the user select a few options, and start or cancel the
-installation.
-
-Since the metadata is taken from the setup script, creating Windows installers
-is usually as easy as running::
-
- python setup.py bdist_wininst
-
-or the :command:`bdist` command with the :option:`--formats` option::
-
- python setup.py bdist --formats=wininst
-
-If you have a pure module distribution (only containing pure Python modules and
-packages), the resulting installer will be version independent and have a name
-like :file:`foo-1.0.win32.exe`. These installers can even be created on Unix
-platforms or Mac OS X.
-
-If you have a non-pure distribution, the extensions can only be created on a
-Windows platform, and will be Python version dependent. The installer filename
-will reflect this and now has the form :file:`foo-1.0.win32-py2.0.exe`. You
-have to create a separate installer for every Python version you want to
-support.
-
-.. TODO Add :term: markup to bytecode when merging into the stdlib
-
-The installer will try to compile pure modules into bytecode after installation
-on the target system in normal and optimizing mode. If you don't want this to
-happen for some reason, you can run the :command:`bdist_wininst` command with
-the :option:`--no-target-compile` and/or the :option:`--no-target-optimize`
-option.
-
-By default the installer will display the cool "Python Powered" logo when it is
-run, but you can also supply your own 152x261 bitmap which must be a Windows
-:file:`.bmp` file with the :option:`--bitmap` option.
-
-The installer will also display a large title on the desktop background window
-when it is run, which is constructed from the name of your distribution and the
-version number. This can be changed to another text by using the
-:option:`--title` option.
-
-The installer file will be written to the "distribution directory" --- normally
-:file:`dist/`, but customizable with the :option:`--dist-dir` option.
-
-.. _cross-compile-windows:
-
-Cross-compiling on Windows
-==========================
-
-Starting with Python 2.6, distutils is capable of cross-compiling between
-Windows platforms. In practice, this means that with the correct tools
-installed, you can use a 32bit version of Windows to create 64bit extensions
-and vice-versa.
-
-To build for an alternate platform, specify the :option:`--plat-name` option
-to the build command. Valid values are currently 'win32', 'win-amd64' and
-'win-ia64'. For example, on a 32bit version of Windows, you could execute::
-
- python setup.py build --plat-name=win-amd64
-
-to build a 64bit version of your extension. The Windows Installers also
-support this option, so the command::
-
- python setup.py build --plat-name=win-amd64 bdist_wininst
-
-would create a 64bit installation executable on your 32bit version of Windows.
-
-To cross-compile, you must download the Python source code and cross-compile
-Python itself for the platform you are targetting - it is not possible from a
-binary installtion of Python (as the .lib etc file for other platforms are
-not included.) In practice, this means the user of a 32 bit operating
-system will need to use Visual Studio 2008 to open the
-:file:`PCBuild/PCbuild.sln` solution in the Python source tree and build the
-"x64" configuration of the 'pythoncore' project before cross-compiling
-extensions is possible.
-
-Note that by default, Visual Studio 2008 does not install 64bit compilers or
-tools. You may need to reexecute the Visual Studio setup process and select
-these tools (using Control Panel->[Add/Remove] Programs is a convenient way to
-check or modify your existing install.)
-
-.. _postinstallation-script:
-
-The Postinstallation script
----------------------------
-
-Starting with Python 2.3, a postinstallation script can be specified with the
-:option:`--install-script` option. The basename of the script must be
-specified, and the script filename must also be listed in the scripts argument
-to the setup function.
-
-This script will be run at installation time on the target system after all the
-files have been copied, with ``argv[1]`` set to :option:`-install`, and again at
-uninstallation time before the files are removed with ``argv[1]`` set to
-:option:`-remove`.
-
-The installation script runs embedded in the windows installer, every output
-(``sys.stdout``, ``sys.stderr``) is redirected into a buffer and will be
-displayed in the GUI after the script has finished.
-
-Some functions especially useful in this context are available as additional
-built-in functions in the installation script.
-
-
-.. function:: directory_created(path)
- file_created(path)
-
- These functions should be called when a directory or file is created by the
- postinstall script at installation time. It will register *path* with the
- uninstaller, so that it will be removed when the distribution is uninstalled.
- To be safe, directories are only removed if they are empty.
-
-
-.. function:: get_special_folder_path(csidl_string)
-
- This function can be used to retrieve special folder locations on Windows like
- the Start Menu or the Desktop. It returns the full path to the folder.
- *csidl_string* must be one of the following strings::
-
- "CSIDL_APPDATA"
-
- "CSIDL_COMMON_STARTMENU"
- "CSIDL_STARTMENU"
-
- "CSIDL_COMMON_DESKTOPDIRECTORY"
- "CSIDL_DESKTOPDIRECTORY"
-
- "CSIDL_COMMON_STARTUP"
- "CSIDL_STARTUP"
-
- "CSIDL_COMMON_PROGRAMS"
- "CSIDL_PROGRAMS"
-
- "CSIDL_FONTS"
-
- If the folder cannot be retrieved, :exc:`OSError` is raised.
-
- Which folders are available depends on the exact Windows version, and probably
- also the configuration. For details refer to Microsoft's documentation of the
- c:function:`SHGetSpecialFolderPath` function.
-
-
-.. function:: create_shortcut(target, description, filename[, arguments[, workdir[, iconpath[, iconindex]]]])
-
- This function creates a shortcut. *target* is the path to the program to be
- started by the shortcut. *description* is the description of the shortcut.
- *filename* is the title of the shortcut that the user will see. *arguments*
- specifies the command-line arguments, if any. *workdir* is the working directory
- for the program. *iconpath* is the file containing the icon for the shortcut,
- and *iconindex* is the index of the icon in the file *iconpath*. Again, for
- details consult the Microsoft documentation for the :class:`IShellLink`
- interface.
-
-
-Vista User Access Control (UAC)
-===============================
-
-Starting with Python 2.6, bdist_wininst supports a :option:`--user-access-control`
-option. The default is 'none' (meaning no UAC handling is done), and other
-valid values are 'auto' (meaning prompt for UAC elevation if Python was
-installed for all users) and 'force' (meaning always prompt for elevation).
diff --git a/docs/source/distutils/commandhooks.rst b/docs/source/distutils/commandhooks.rst
deleted file mode 100644
--- a/docs/source/distutils/commandhooks.rst
+++ /dev/null
@@ -1,31 +0,0 @@
-=============
-Command hooks
-=============
-
-Distutils2 provides a way of extending its commands by the use of pre- and
-post- command hooks. The hooks are simple Python functions (or any callable
-objects) and are specified in the config file using their full qualified names.
-The pre-hooks are run after the command is finalized (its options are
-processed), but before it is run. The post-hooks are run after the command
-itself. Both types of hooks receive an instance of the command object.
-
-Sample usage of hooks
-=====================
-
-Firstly, you need to make sure your hook is present in the path. This is usually
-done by dropping them to the same folder where `setup.py` file lives ::
-
- # file: myhooks.py
- def my_install_hook(install_cmd):
- print "Oh la la! Someone is installing my project!"
-
-Then, you need to point to it in your `setup.cfg` file, under the appropriate
-command section ::
-
- [install]
- pre-hook.project = myhooks.my_install_hook
-
-The hooks defined in different config files (system-wide, user-wide and
-package-wide) do not override each other as long as they are specified with
-different aliases (additional names after the dot). The alias in the example
-above is ``project``.
diff --git a/docs/source/distutils/commandref.rst b/docs/source/distutils/commandref.rst
deleted file mode 100644
--- a/docs/source/distutils/commandref.rst
+++ /dev/null
@@ -1,60 +0,0 @@
-.. _reference:
-
-*****************
-Command Reference
-*****************
-
-.. % \section{Building modules: the \protect\command{build} command family}
-.. % \label{build-cmds}
-.. % \subsubsection{\protect\command{build}}
-.. % \label{build-cmd}
-.. % \subsubsection{\protect\command{build\_py}}
-.. % \label{build-py-cmd}
-.. % \subsubsection{\protect\command{build\_ext}}
-.. % \label{build-ext-cmd}
-.. % \subsubsection{\protect\command{build\_clib}}
-.. % \label{build-clib-cmd}
-
-
-.. _install-cmd:
-
-Installing modules: the :command:`install` command family
-=========================================================
-
-The install command ensures that the build commands have been run and then runs
-the subcommands :command:`install_lib`, :command:`install_data` and
-:command:`install_scripts`.
-
-.. % \subsubsection{\protect\command{install\_lib}}
-.. % \label{install-lib-cmd}
-
-
-.. _install-data-cmd:
-
-:command:`install_data`
------------------------
-
-This command installs all data files provided with the distribution.
-
-
-.. _install-scripts-cmd:
-
-:command:`install_scripts`
---------------------------
-
-This command installs all (Python) scripts in the distribution.
-
-.. % \subsection{Cleaning up: the \protect\command{clean} command}
-.. % \label{clean-cmd}
-
-
-.. % \section{Creating a built distribution: the
-.. % \protect\command{bdist} command family}
-.. % \label{bdist-cmds}
-
-.. % \subsection{\protect\command{bdist}}
-.. % \subsection{\protect\command{bdist\_dumb}}
-.. % \subsection{\protect\command{bdist\_rpm}}
-.. % \subsection{\protect\command{bdist\_wininst}}
-
-
diff --git a/docs/source/distutils/configfile.rst b/docs/source/distutils/configfile.rst
deleted file mode 100644
--- a/docs/source/distutils/configfile.rst
+++ /dev/null
@@ -1,131 +0,0 @@
-.. _setup-config:
-
-************************************
-Writing the Setup Configuration File
-************************************
-
-Often, it's not possible to write down everything needed to build a distribution
-*a priori*: you may need to get some information from the user, or from the
-user's system, in order to proceed. As long as that information is fairly
-simple---a list of directories to search for C header files or libraries, for
-example---then providing a configuration file, :file:`setup.cfg`, for users to
-edit is a cheap and easy way to solicit it. Configuration files also let you
-provide default values for any command option, which the installer can then
-override either on the command line or by editing the config file.
-
-The setup configuration file is a useful middle-ground between the setup script
----which, ideally, would be opaque to installers [#]_---and the command line to
-the setup script, which is outside of your control and entirely up to the
-installer. In fact, :file:`setup.cfg` (and any other Distutils configuration
-files present on the target system) are processed after the contents of the
-setup script, but before the command line. This has several useful
-consequences:
-
-.. If you have more advanced needs, such as determining which extensions to
- build based on what capabilities are present on the target system, then you
- need the Distutils auto-configuration facility. This started to appear in
- Distutils 0.9 but, as of this writing, isn't mature or stable enough yet
- for real-world use.
-
-* installers can override some of what you put in :file:`setup.py` by editing
- :file:`setup.cfg`
-
-* you can provide non-standard defaults for options that are not easily set in
- :file:`setup.py`
-
-* installers can override anything in :file:`setup.cfg` using the command-line
- options to :file:`setup.py`
-
-The basic syntax of the configuration file is simple::
-
- [command]
- option = value
- ...
-
-where *command* is one of the Distutils commands (e.g. :command:`build_py`,
-:command:`install`), and *option* is one of the options that command supports.
-Any number of options can be supplied for each command, and any number of
-command sections can be included in the file. Blank lines are ignored, as are
-comments, which run from a ``'#'`` character until the end of the line. Long
-option values can be split across multiple lines simply by indenting the
-continuation lines.
-
-You can find out the list of options supported by a particular command with the
-universal :option:`--help` option, e.g. ::
-
- > python setup.py --help build_ext
- [...]
- Options for 'build_ext' command:
- --build-lib (-b) directory for compiled extension modules
- --build-temp (-t) directory for temporary files (build by-products)
- --inplace (-i) ignore build-lib and put compiled extensions into the
- source directory alongside your pure Python modules
- --include-dirs (-I) list of directories to search for header files
- --define (-D) C preprocessor macros to define
- --undef (-U) C preprocessor macros to undefine
- --swig-opts list of SWIG command-line options
- [...]
-
-.. XXX do we want to support ``setup.py --help metadata``?
-
-Note that an option spelled :option:`--foo-bar` on the command line is spelled
-:option:`foo_bar` in configuration files.
-
-For example, say you want your extensions to be built "in-place"---that is, you
-have an extension :mod:`pkg.ext`, and you want the compiled extension file
-(:file:`ext.so` on Unix, say) to be put in the same source directory as your
-pure Python modules :mod:`pkg.mod1` and :mod:`pkg.mod2`. You can always use the
-:option:`--inplace` option on the command line to ensure this::
-
- python setup.py build_ext --inplace
-
-But this requires that you always specify the :command:`build_ext` command
-explicitly, and remember to provide :option:`--inplace`. An easier way is to
-"set and forget" this option, by encoding it in :file:`setup.cfg`, the
-configuration file for this distribution::
-
- [build_ext]
- inplace = 1
-
-This will affect all builds of this module distribution, whether or not you
-explicitly specify :command:`build_ext`. If you include :file:`setup.cfg` in
-your source distribution, it will also affect end-user builds---which is
-probably a bad idea for this option, since always building extensions in-place
-would break installation of the module distribution. In certain peculiar cases,
-though, modules are built right in their installation directory, so this is
-conceivably a useful ability. (Distributing extensions that expect to be built
-in their installation directory is almost always a bad idea, though.)
-
-Another example: certain commands take a lot of options that don't change from
-run to run; for example, :command:`bdist_rpm` needs to know everything required
-to generate a "spec" file for creating an RPM distribution. Some of this
-information comes from the setup script, and some is automatically generated by
-the Distutils (such as the list of files installed). But some of it has to be
-supplied as options to :command:`bdist_rpm`, which would be very tedious to do
-on the command line for every run. Hence, here is a snippet from the Distutils'
-own :file:`setup.cfg`::
-
- [bdist_rpm]
- release = 1
- packager = Greg Ward <gward at python.net>
- doc_files = CHANGES.txt
- README.txt
- USAGE.txt
- doc/
- examples/
-
-Note that the :option:`doc_files` option is simply a whitespace-separated string
-split across multiple lines for readability.
-
-
-.. seealso::
-
- :ref:`inst-config-syntax` in "Installing Python Projects"
- More information on the configuration files is available in the manual for
- system administrators.
-
-
-.. rubric:: Footnotes
-
-.. [#] This ideal probably won't be achieved until auto-configuration is fully
- supported by the Distutils.
diff --git a/docs/source/distutils/examples.rst b/docs/source/distutils/examples.rst
deleted file mode 100644
--- a/docs/source/distutils/examples.rst
+++ /dev/null
@@ -1,332 +0,0 @@
-.. _examples:
-
-********
-Examples
-********
-
-This chapter provides a number of basic examples to help get started with
-Distutils2.
-
-
-.. _pure-mod:
-
-Pure Python distribution (by module)
-====================================
-
-If you're just distributing a couple of modules, especially if they don't live
-in a particular package, you can specify them individually using the
-:option:`py_modules` option in the setup script.
-
-In the simplest case, you'll have two files to worry about: a setup script and
-the single module you're distributing, :file:`foo.py` in this example::
-
- <root>/
- setup.py
- foo.py
-
-(In all diagrams in this section, *<root>* will refer to the distribution root
-directory.) A minimal setup script to describe this situation would be::
-
- from distutils2.core import setup
- setup(name='foo',
- version='1.0',
- py_modules=['foo'])
-
-Note that the name of the distribution is specified independently with the
-:option:`name` option, and there's no rule that says it has to be the same as
-the name of the sole module in the distribution (although that's probably a good
-convention to follow). However, the distribution name is used to generate
-filenames, so you should stick to letters, digits, underscores, and hyphens.
-
-Since :option:`py_modules` is a list, you can of course specify multiple
-modules, e.g. if you're distributing modules :mod:`foo` and :mod:`bar`, your
-setup might look like this::
-
- <root>/
- setup.py
- foo.py
- bar.py
-
-and the setup script might be ::
-
- from distutils2.core import setup
- setup(name='foobar',
- version='1.0',
- py_modules=['foo', 'bar'])
-
-You can put module source files into another directory, but if you have enough
-modules to do that, it's probably easier to specify modules by package rather
-than listing them individually.
-
-
-.. _pure-pkg:
-
-Pure Python distribution (by package)
-=====================================
-
-If you have more than a couple of modules to distribute, especially if they are
-in multiple packages, it's probably easier to specify whole packages rather than
-individual modules. This works even if your modules are not in a package; you
-can just tell the Distutils to process modules from the root package, and that
-works the same as any other package (except that you don't have to have an
-:file:`__init__.py` file).
-
-The setup script from the last example could also be written as ::
-
- from distutils2.core import setup
- setup(name='foobar',
- version='1.0',
- packages=[''])
-
-(The empty string stands for the root package.)
-
-If those two files are moved into a subdirectory, but remain in the root
-package, e.g.::
-
- <root>/
- setup.py
- src/
- foo.py
- bar.py
-
-then you would still specify the root package, but you have to tell the
-Distutils where source files in the root package live::
-
- from distutils2.core import setup
- setup(name='foobar',
- version='1.0',
- package_dir={'': 'src'},
- packages=[''])
-
-More typically, though, you will want to distribute multiple modules in the same
-package (or in sub-packages). For example, if the :mod:`foo` and :mod:`bar`
-modules belong in package :mod:`foobar`, one way to lay out your source tree is
-
-::
-
- <root>/
- setup.py
- foobar/
- __init__.py
- foo.py
- bar.py
-
-This is in fact the default layout expected by the Distutils, and the one that
-requires the least work to describe in your setup script::
-
- from distutils2.core import setup
- setup(name='foobar',
- version='1.0',
- packages=['foobar'])
-
-If you want to put modules in directories not named for their package, then you
-need to use the :option:`package_dir` option again. For example, if the
-:file:`src` directory holds modules in the :mod:`foobar` package::
-
- <root>/
- setup.py
- src/
- __init__.py
- foo.py
- bar.py
-
-an appropriate setup script would be ::
-
- from distutils2.core import setup
- setup(name='foobar',
- version='1.0',
- package_dir={'foobar': 'src'},
- packages=['foobar'])
-
-Or, you might put modules from your main package right in the distribution
-root::
-
- <root>/
- setup.py
- __init__.py
- foo.py
- bar.py
-
-in which case your setup script would be ::
-
- from distutils2.core import setup
- setup(name='foobar',
- version='1.0',
- package_dir={'foobar': ''},
- packages=['foobar'])
-
-(The empty string also stands for the current directory.)
-
-If you have sub-packages, they must be explicitly listed in :option:`packages`,
-but any entries in :option:`package_dir` automatically extend to sub-packages.
-(In other words, the Distutils does *not* scan your source tree, trying to
-figure out which directories correspond to Python packages by looking for
-:file:`__init__.py` files.) Thus, if the default layout grows a sub-package::
-
- <root>/
- setup.py
- foobar/
- __init__.py
- foo.py
- bar.py
- subfoo/
- __init__.py
- blah.py
-
-then the corresponding setup script would be ::
-
- from distutils2.core import setup
- setup(name='foobar',
- version='1.0',
- packages=['foobar', 'foobar.subfoo'])
-
-(Again, the empty string in :option:`package_dir` stands for the current
-directory.)
-
-
-.. _single-ext:
-
-Single extension module
-=======================
-
-Extension modules are specified using the :option:`ext_modules` option.
-:option:`package_dir` has no effect on where extension source files are found;
-it only affects the source for pure Python modules. The simplest case, a
-single extension module in a single C source file, is::
-
- <root>/
- setup.py
- foo.c
-
-If the :mod:`foo` extension belongs in the root package, the setup script for
-this could be ::
-
- from distutils2.core import setup, Extension
- setup(name='foobar',
- version='1.0',
- ext_modules=[Extension('foo', ['foo.c'])])
-
-If the extension actually belongs in a package, say :mod:`foopkg`, then
-
-With exactly the same source tree layout, this extension can be put in the
-:mod:`foopkg` package simply by changing the name of the extension::
-
- from distutils2.core import setup, Extension
- setup(name='foobar',
- version='1.0',
- packages=['foopkg'],
- ext_modules=[Extension('foopkg.foo', ['foo.c'])])
-
-
-Checking metadata
-=================
-
-The ``check`` command allows you to verify if your project's metadata
-meets the minimum requirements to build a distribution.
-
-To run it, just call it using your :file:`setup.py` script. If something is
-missing, ``check`` will display a warning.
-
-Let's take an example with a simple script::
-
- from distutils2.core import setup
-
- setup(name='foobar')
-
-Running the ``check`` command will display some warnings::
-
- $ python setup.py check
- running check
- warning: check: missing required metadata: version, home_page
- warning: check: missing metadata: either (author and author_email) or
- (maintainer and maintainer_email) must be supplied
-
-
-If you use the reStructuredText syntax in the ``long_description`` field and
-`Docutils <http://docutils.sourceforge.net/>`_ is installed you can check if
-the syntax is fine with the ``check`` command, using the ``restructuredtext``
-option.
-
-For example, if the :file:`setup.py` script is changed like this::
-
- from distutils2.core import setup
-
- desc = """\
- Welcome to foobar!
- ===============
-
- This is the description of the ``foobar`` project.
- """
-
- setup(name='foobar',
- version='1.0',
- author=u'Tarek Ziadé',
- author_email='tarek at ziade.org',
- summary='Foobar utilities'
- description=desc,
- home_page='http://example.com')
-
-Where the long description is broken, ``check`` will be able to detect it
-by using the :mod:`docutils` parser::
-
- $ python setup.py check --restructuredtext
- running check
- warning: check: Title underline too short. (line 2)
- warning: check: Could not finish the parsing.
-
-
-.. _reading-metadata:
-
-Reading the metadata
-====================
-
-The :func:`distutils2.core.setup` function provides a command-line interface
-that allows you to query the metadata fields of a project through the
-:file:`setup.py` script of a given project::
-
- $ python setup.py --name
- foobar
-
-This call reads the ``name`` metadata by running the
-:func:`distutils2.core.setup` function. When a source or binary
-distribution is created with Distutils, the metadata fields are written
-in a static file called :file:`PKG-INFO`. When a Distutils-based project is
-installed in Python, the :file:`PKG-INFO` file is copied alongside the modules
-and packages of the distribution under :file:`NAME-VERSION-pyX.X.egg-info`,
-where ``NAME`` is the name of the project, ``VERSION`` its version as defined
-in the Metadata, and ``pyX.X`` the major and minor version of Python like
-``2.7`` or ``3.2``.
-
-You can read back this static file, by using the
-:class:`distutils2.dist.Metadata` class and its
-:func:`read_pkg_file` method::
-
- >>> from distutils2.metadata import Metadata
- >>> metadata = Metadata()
- >>> metadata.read_pkg_file(open('distribute-0.6.8-py2.7.egg-info'))
- >>> metadata.name
- 'distribute'
- >>> metadata.version
- '0.6.8'
- >>> metadata.description
- 'Easily download, build, install, upgrade, and uninstall Python packages'
-
-Notice that the class can also be instantiated with a metadata file path to
-loads its values::
-
- >>> pkg_info_path = 'distribute-0.6.8-py2.7.egg-info'
- >>> Metadata(pkg_info_path).name
- 'distribute'
-
-
-.. XXX These comments have been here for at least ten years. Write the
- sections or delete the comments (we can maybe ask Greg Ward about
- the planned contents). (Unindent to make them section titles)
-
- .. multiple-ext::
-
- Multiple extension modules
- ==========================
-
- Putting it all together
- =======================
diff --git a/docs/source/distutils/extending.rst b/docs/source/distutils/extending.rst
deleted file mode 100644
--- a/docs/source/distutils/extending.rst
+++ /dev/null
@@ -1,95 +0,0 @@
-.. _extending-distutils:
-
-*******************
-Extending Distutils
-*******************
-
-Distutils can be extended in various ways. Most extensions take the form of new
-commands or replacements for existing commands. New commands may be written to
-support new types of platform-specific packaging, for example, while
-replacements for existing commands may be made to modify details of how the
-command operates on a package.
-
-Most extensions of the distutils are made within :file:`setup.py` scripts that
-want to modify existing commands; many simply add a few file extensions that
-should be copied into packages in addition to :file:`.py` files as a
-convenience.
-
-Most distutils command implementations are subclasses of the
-:class:`distutils2.cmd.Command` class. New commands may directly inherit from
-:class:`Command`, while replacements often derive from :class:`Command`
-indirectly, directly subclassing the command they are replacing. Commands are
-required to derive from :class:`Command`.
-
-.. .. _extend-existing:
- Extending existing commands
- ===========================
-
-
-.. .. _new-commands:
- Writing new commands
- ====================
-
-
-Integrating new commands
-========================
-
-There are different ways to integrate new command implementations into
-distutils. The most difficult is to lobby for the inclusion of the new features
-in distutils itself, and wait for (and require) a version of Python that
-provides that support. This is really hard for many reasons.
-
-The most common, and possibly the most reasonable for most needs, is to include
-the new implementations with your :file:`setup.py` script, and cause the
-:func:`distutils2.core.setup` function use them::
-
- from distutils2.core import setup
- from distutils2.command.build_py import build_py as _build_py
-
- class build_py(_build_py):
- """Specialized Python source builder."""
-
- # implement whatever needs to be different...
-
- setup(..., cmdclass={'build_py': build_py})
-
-This approach is most valuable if the new implementations must be used to use a
-particular package, as everyone interested in the package will need to have the
-new command implementation.
-
-Beginning with Python 2.4, a third option is available, intended to allow new
-commands to be added which can support existing :file:`setup.py` scripts without
-requiring modifications to the Python installation. This is expected to allow
-third-party extensions to provide support for additional packaging systems, but
-the commands can be used for anything distutils commands can be used for. A new
-configuration option, :option:`command_packages` (command-line option
-:option:`--command-packages`), can be used to specify additional packages to be
-searched for modules implementing commands. Like all distutils options, this
-can be specified on the command line or in a configuration file. This option
-can only be set in the ``[global]`` section of a configuration file, or before
-any commands on the command line. If set in a configuration file, it can be
-overridden from the command line; setting it to an empty string on the command
-line causes the default to be used. This should never be set in a configuration
-file provided with a package.
-
-This new option can be used to add any number of packages to the list of
-packages searched for command implementations; multiple package names should be
-separated by commas. When not specified, the search is only performed in the
-:mod:`distutils2.command` package. When :file:`setup.py` is run with the option
-:option:`--command-packages` :option:`distcmds,buildcmds`, however, the packages
-:mod:`distutils2.command`, :mod:`distcmds`, and :mod:`buildcmds` will be searched
-in that order. New commands are expected to be implemented in modules of the
-same name as the command by classes sharing the same name. Given the example
-command-line option above, the command :command:`bdist_openpkg` could be
-implemented by the class :class:`distcmds.bdist_openpkg.bdist_openpkg` or
-:class:`buildcmds.bdist_openpkg.bdist_openpkg`.
-
-
-Adding new distribution types
-=============================
-
-Commands that create distributions (files in the :file:`dist/` directory) need
-to add ``(command, filename)`` pairs to ``self.distribution.dist_files`` so that
-:command:`upload` can upload it to PyPI. The *filename* in the pair contains no
-path information, only the name of the file itself. In dry-run mode, pairs
-should still be added to represent what would have been created.
diff --git a/docs/source/distutils/index.rst b/docs/source/distutils/index.rst
deleted file mode 100644
--- a/docs/source/distutils/index.rst
+++ /dev/null
@@ -1,33 +0,0 @@
-.. _distutils-index:
-
-###############################
- Distributing Python Projects
-###############################
-
-:Authors: Greg Ward, Anthony Baxter and Distutils2 contributors
-:Email: distutils-sig at python.org
-:Release: |version|
-:Date: |today|
-
-This document describes the Python Distribution Utilities ("Distutils2") from
-the developer's point of view, describing how to use the Distutils to make
-Python applications, packages or modules easily available to a wider audience
-with very little overhead for build/release/install mechanics.
-
-.. toctree::
- :maxdepth: 2
- :numbered:
-
- introduction
- setupscript
- configfile
- sourcedist
- builtdist
- packageindex
- uploading
- examples
- extending
- commandhooks
- commandref
- newcommands
- apiref
diff --git a/docs/source/distutils/introduction.rst b/docs/source/distutils/introduction.rst
deleted file mode 100644
--- a/docs/source/distutils/introduction.rst
+++ /dev/null
@@ -1,193 +0,0 @@
-.. _distutils-intro:
-
-*****************************
-An Introduction to Distutils2
-*****************************
-
-This document covers using Distutils2 to distribute your Python modules,
-concentrating on the role of developer/distributor. If you're looking for
-information on installing Python modules you should refer to the
-:ref:`install-index` chapter.
-
-Throughout this documentation, the terms "Distutils", "the Distutils" and
-"Distutils2" will be used interchangeably.
-
-.. _distutils-concepts:
-
-Concepts & Terminology
-======================
-
-Using Distutils is quite simple both for module developers and for
-users/administrators installing third-party modules. As a developer, your
-responsibilities (apart from writing solid, well-documented and well-tested
-code, of course!) are:
-
-* writing a setup script (:file:`setup.py` by convention)
-
-* (optional) writing a setup configuration file
-
-* creating a source distribution
-
-* (optional) creating one or more "built" (binary) distributions of your
- project
-
-All of these tasks are covered in this document.
-
-Not all module developers have access to multiple platforms, so one cannot
-expect them to create buildt distributions for every platform. To remedy
-this, it is hoped that intermediaries called *packagers* will arise to address
-this need. Packagers take source distributions released by module developers,
-build them on one or more platforms and release the resulting built
-distributions. Thus, users on a greater range of platforms will be able to
-install the most popular Python modules in the most natural way for their
-platform without having to run a setup script or compile a single line of code.
-
-
-.. _distutils-simple-example:
-
-A Simple Example
-================
-
-A setup script is usually quite simple, although since it's written in Python
-there are no arbitrary limits to what you can do with it, though you should be
-careful about putting expensive operations in your setup script.
-Unlike, say, Autoconf-style configure scripts the setup script may be run
-multiple times in the course of building and installing a module
-distribution.
-
-If all you want to do is distribute a module called :mod:`foo`, contained in a
-file :file:`foo.py`, then your setup script can be as simple as::
-
- from distutils2.core import setup
- setup(name='foo',
- version='1.0',
- py_modules=['foo'])
-
-Some observations:
-
-* most information that you supply to the Distutils is supplied as keyword
- arguments to the :func:`setup` function
-
-* those keyword arguments fall into two categories: package metadata (name,
- version number, etc.) and information about what's in the package (a list
- of pure Python modules in this case)
-
-* modules are specified by module name, not filename (the same will hold true
- for packages and extensions)
-
-* it's recommended that you supply a little more metadata than we have in the
- example. In particular your name, email address and a URL for the
- project if appropriate (see section :ref:`setup-script` for an example)
-
-To create a source distribution for this module you would create a setup
-script, :file:`setup.py`, containing the above code and run::
-
- python setup.py sdist
-
-which will create an archive file (e.g., tarball on Unix, ZIP file on Windows)
-containing your setup script :file:`setup.py`, and your module :file:`foo.py`.
-The archive file will be named :file:`foo-1.0.tar.gz` (or :file:`.zip`), and
-will unpack into a directory :file:`foo-1.0`.
-
-If an end-user wishes to install your :mod:`foo` module all he has to do is
-download :file:`foo-1.0.tar.gz` (or :file:`.zip`), unpack it, and from the
-:file:`foo-1.0` directory run ::
-
- python setup.py install
-
-which will copy :file:`foo.py` to the appropriate directory for
-third-party modules in their Python installation.
-
-This simple example demonstrates some fundamental concepts of Distutils.
-First, both developers and installers have the same basic user interface, i.e.
-the setup script. The difference is which Distutils *commands* they use: the
-:command:`sdist` command is almost exclusively for module developers, while
-:command:`install` is more often used by installers (although some developers
-will want to install their own code occasionally).
-
-If you want to make things really easy for your users, you can create more
-than one built distributions for them. For instance, if you are running on a
-Windows machine and want to make things easy for other Windows users, you can
-create an executable installer (the most appropriate type of built distribution
-for this platform) with the :command:`bdist_wininst` command. For example::
-
- python setup.py bdist_wininst
-
-will create an executable installer, :file:`foo-1.0.win32.exe`, in the current
-directory. You can find out what distribution formats are available at any time
-by running ::
-
- python setup.py bdist --help-formats
-
-
-.. _python-terms:
-
-General Python terminology
-==========================
-
-If you're reading this document, you probably have a good idea of what Python
-modules, extensions and so forth are. Nevertheless, just to be sure that
-everyone is on the same page, here's a quick overview of Python terms:
-
-module
- The basic unit of code reusability in Python: a block of code imported by
- some other code. Three types of modules are important to us here: pure
- Python modules, extension modules and packages.
-
-pure Python module
- A module written in Python and contained in a single :file:`.py` file (and
- possibly associated :file:`.pyc` and/or :file:`.pyo` files). Sometimes
- referred to as a "pure module."
-
-extension module
- A module written in the low-level language of the Python implementation: C/C++
- for Python, Java for Jython. Typically contained in a single dynamically
- loaded pre-compiled file, e.g. a shared object (:file:`.so`) file for Python
- extensions on Unix, a DLL (given the :file:`.pyd` extension) for Python
- extensions on Windows, or a Java class file for Jython extensions. Note that
- currently Distutils only handles C/C++ extensions for Python.
-
-package
- A module that contains other modules, typically contained in a directory of
- the filesystem and distinguished from other directories by the presence of a
- file :file:`__init__.py`.
-
-root package
- The root of the hierarchy of packages. (This isn't really a package,
- since it doesn't have an :file:`__init__.py` file. But... we have to
- call it something, right?) The vast majority of the standard library is
- in the root package, as are many small standalone third-party modules that
- don't belong to a larger module collection. Unlike regular packages,
- modules in the root package can be found in many directories: in fact,
- every directory listed in ``sys.path`` contributes modules to the root
- package.
-
-
-.. _distutils-term:
-
-Distutils-specific terminology
-==============================
-
-The following terms apply more specifically to the domain of distributing Python
-modules using Distutils:
-
-module distribution
- A collection of Python modules distributed together as a single downloadable
- resource and meant to be installed all as one. Examples of some well-known
- module distributions are Numeric Python, PyXML, PIL (the Python Imaging
- Library) or mxBase. (Module distributions would be called a *package*,
- except that term is already taken in the Python context: a single module
- distribution may contain zero, one, or many Python packages.)
-
-pure module distribution
- A module distribution that contains only pure Python modules and packages.
- Sometimes referred to as a "pure distribution."
-
-non-pure module distribution
- A module distribution that contains at least one extension module. Sometimes
- referred to as a "non-pure distribution."
-
-distribution root
- The top-level directory of your source tree (or source distribution). The
- directory where :file:`setup.py` exists. Generally :file:`setup.py` will
- be run from this directory.
diff --git a/docs/source/distutils/newcommands.rst b/docs/source/distutils/newcommands.rst
deleted file mode 100644
--- a/docs/source/distutils/newcommands.rst
+++ /dev/null
@@ -1,144 +0,0 @@
-========
-Commands
-========
-
-Distutils2 provides a set of commands that are not present in distutils itself.
-You might recognize some of them from other projects, like Distribute or
-Setuptools.
-
-``test`` - Build package and run a unittest suite
-=================================================
-
-When doing test-driven development, or running automated builds that need
-testing before they are deployed for downloading or use, it's often useful
-to be able to run a project's unit tests without actually deploying the project
-anywhere. The ``test`` command runs
-project's unit tests without actually deploying it, by temporarily putting the
-project's source on ``sys.path``, after first running ``build_ext -i``
-to ensure that any C extensions are built.
-
-You can use this command in one of two ways: either by specifying a
-unittest-compatible test suite for your project (or any callable that returns
-it) or by passing a test runner function that will run your tests and display
-results in the console. Both options: ``suite`` and ``runner`` accept dotted
-names that will be resolved into actual objects.
-
-If none of these options are specified, distutils2 will try to perform test
-discovery using either unittest2 (if installed) or unittest (if running on
-recent Python version).
-
-``--suite=NAME, -s NAME``
- Specify the test suite (or module, class, or method) to be run
- (for example ``my_package.tests.all_tests``). The default for this option can be
- set by in your ``setup.cfg`` file.
-
-.. code-block:: ini
-
- [test]
- suite = my_package.tests.all_tests
-
-``--runner=NAME, -r NAME``
- Specify the test runner to be called.
-
-
-``upload`` - Upload source and/or binary distributions to PyPI
-==============================================================
-
-The Python Package Index (PyPI) not only stores the package info, but also the
-package data if the author of the package wishes to. The distutils command
-:command:`upload` pushes the distribution files to PyPI.
-
-The command is invoked immediately after building one or more distribution
-files. For example, the command ::
-
- python setup.py sdist bdist_wininst upload
-
-will cause the source distribution and the Windows installer to be uploaded to
-PyPI. Note that these will be uploaded even if they are built using an earlier
-invocation of :file:`setup.py`, but that only distributions named on the command
-line for the invocation including the :command:`upload` command are uploaded.
-
-The :command:`upload` command uses the username, password, and repository URL
-from the :file:`$HOME/.pypirc` file . If a :command:`register` command was
-previously called in the same command, and if the password was entered in the
-prompt, :command:`upload` will reuse the entered password. This is useful if
-you do not want to store a clear text password in the :file:`$HOME/.pypirc`
-file.
-
-The ``upload`` command has a few options worth noting:
-
-``--sign, -s``
- Sign each uploaded file using GPG (GNU Privacy Guard). The ``gpg`` program
- must be available for execution on the system ``PATH``.
-
-``--identity=NAME, -i NAME``
- Specify the identity or key name for GPG to use when signing. The value of
- this option will be passed through the ``--local-user`` option of the
- ``gpg`` program.
-
-``--show-response``
- Display the full response text from server; this is useful for debugging
- PyPI problems.
-
-``--repository=URL, -r URL``
- The URL of the repository to upload to. Defaults to
- http://pypi.python.org/pypi (i.e., the main PyPI installation).
-
-
-``upload_docs`` - Upload package documentation to PyPI
-======================================================
-
-PyPI now supports uploading project documentation to the dedicated URL
-http://packages.python.org/<project>/.
-
-The ``upload_docs`` command will create the necessary zip file out of a
-documentation directory and will post to the repository.
-
-Note that to upload the documentation of a project, the corresponding version
-must already be registered with PyPI, using the distutils ``register``
-command -- just like the ``upload`` command.
-
-Assuming there is an ``Example`` project with documentation in the
-subdirectory ``docs``, for example::
-
- Example/
- |-- example.py
- |-- setup.cfg
- |-- setup.py
- |-- docs
- | |-- build
- | | `-- html
- | | | |-- index.html
- | | | `-- tips_tricks.html
- | |-- conf.py
- | |-- index.txt
- | `-- tips_tricks.txt
-
-You can simply pass the documentation directory path to the ``upload_docs``
-command::
-
- python setup.py upload_docs --upload-dir=docs/build/html
-
-As with any other command, you can define useful
-defaults in the ``setup.cfg`` of your Python project, for example:
-
-.. code-block:: ini
-
- [upload_docs]
- upload-dir = docs/build/html
-
-The ``upload_docs`` command has the following options:
-
-``--upload-dir``
- The directory to be uploaded to the repository. By default documentation
- is searched for in ``docs`` (or ``doc``) directory in project root.
-
-``--show-response``
- Display the full response text from server; this is useful for debugging
- PyPI problems.
-
-``--repository=URL, -r URL``
- The URL of the repository to upload to. Defaults to
- http://pypi.python.org/pypi (i.e., the main PyPI installation).
-
-
diff --git a/docs/source/distutils/packageindex.rst b/docs/source/distutils/packageindex.rst
deleted file mode 100644
--- a/docs/source/distutils/packageindex.rst
+++ /dev/null
@@ -1,104 +0,0 @@
-.. _package-index:
-
-**********************************
-Registering with the Package Index
-**********************************
-
-The Python Package Index (PyPI) holds metadata describing distributions
-packaged with distutils. The distutils command :command:`register` is used to
-submit your distribution's metadata to the index. It is invoked as follows::
-
- python setup.py register
-
-Distutils will respond with the following prompt::
-
- running register
- We need to know who you are, so please choose either:
- 1. use your existing login,
- 2. register as a new user,
- 3. have the server generate a new password for you (and email it to you), or
- 4. quit
- Your selection [default 1]:
-
-Note: if your username and password are saved locally, you will not see this
-menu.
-
-If you have not registered with PyPI, then you will need to do so now. You
-should choose option 2, and enter your details as required. Soon after
-submitting your details, you will receive an email which will be used to confirm
-your registration.
-
-Once you are registered, you may choose option 1 from the menu. You will be
-prompted for your PyPI username and password, and :command:`register` will then
-submit your metadata to the index.
-
-You may submit any number of versions of your distribution to the index. If you
-alter the metadata for a particular version, you may submit it again and the
-index will be updated.
-
-PyPI holds a record for each (name, version) combination submitted. The first
-user to submit information for a given name is designated the Owner of that
-name. They may submit changes through the :command:`register` command or through
-the web interface. They may also designate other users as Owners or Maintainers.
-Maintainers may edit the package information, but not designate other Owners or
-Maintainers.
-
-By default PyPI will list all versions of a given package. To hide certain
-versions, the Hidden property should be set to yes. This must be edited through
-the web interface.
-
-
-.. _pypirc:
-
-The .pypirc file
-================
-
-The format of the :file:`.pypirc` file is as follows::
-
- [distutils]
- index-servers =
- pypi
-
- [pypi]
- repository: <repository-url>
- username: <username>
- password: <password>
-
-The *distutils* section defines a *index-servers* variable that lists the
-name of all sections describing a repository.
-
-Each section describing a repository defines three variables:
-
-- *repository*, that defines the url of the PyPI server. Defaults to
- ``http://www.python.org/pypi``.
-- *username*, which is the registered username on the PyPI server.
-- *password*, that will be used to authenticate. If omitted the user
- will be prompt to type it when needed.
-
-If you want to define another server a new section can be created and
-listed in the *index-servers* variable::
-
- [distutils]
- index-servers =
- pypi
- other
-
- [pypi]
- repository: <repository-url>
- username: <username>
- password: <password>
-
- [other]
- repository: http://example.com/pypi
- username: <username>
- password: <password>
-
-:command:`register` can then be called with the -r option to point the
-repository to work with::
-
- python setup.py register -r http://example.com/pypi
-
-For convenience, the name of the section that describes the repository
-may also be used::
-
- python setup.py register -r other
diff --git a/docs/source/distutils/setupscript.rst b/docs/source/distutils/setupscript.rst
deleted file mode 100644
--- a/docs/source/distutils/setupscript.rst
+++ /dev/null
@@ -1,686 +0,0 @@
-.. _setup-script:
-
-************************
-Writing the Setup Script
-************************
-
-The setup script is the center of all activity in building, distributing, and
-installing modules using Distutils. The main purpose of the setup script is
-to describe your module distribution to Distutils, so that the various
-commands that operate on your modules do the right thing. As we saw in section
-:ref:`distutils-simple-example`, the setup script consists mainly of a
-call to :func:`setup` where the most information is supplied as
-keyword arguments to :func:`setup`.
-
-Here's a slightly more involved example, which we'll follow for the next couple
-of sections: a setup script that could be used for Distutils2 itself::
-
- #!/usr/bin/env python
-
- from distutils2.core import setup, find_packages
-
- setup(name='Distutils2',
- version='1.0',
- summary='Python Distribution Utilities',
- keywords=['packaging', 'distutils2'],
- author=u'Tarek Ziadé',
- author_email='tarek at ziade.org',
- home_page='http://bitbucket.org/tarek/distutils2/wiki/Home',
- license='PSF',
- packages=find_packages())
-
-
-There are only two differences between this and the trivial one-file
-distribution presented in section :ref:`distutils-simple-example`: more
-metadata and the specification of pure Python modules by package rather than
-by module. This is important since Ristutils consist of a couple of dozen
-modules split into (so far) two packages; an explicit list of every module
-would be tedious to generate and difficult to maintain. For more information
-on the additional metadata, see section :ref:`metadata`.
-
-Note that any pathnames (files or directories) supplied in the setup script
-should be written using the Unix convention, i.e. slash-separated. The
-Distutils will take care of converting this platform-neutral representation into
-whatever is appropriate on your current platform before actually using the
-pathname. This makes your setup script portable across operating systems, which
-of course is one of the major goals of the Distutils. In this spirit, all
-pathnames in this document are slash-separated.
-
-This, of course, only applies to pathnames given to Distutils functions. If
-you, for example, use standard Python functions such as :func:`glob.glob` or
-:func:`os.listdir` to specify files, you should be careful to write portable
-code instead of hardcoding path separators::
-
- glob.glob(os.path.join('mydir', 'subdir', '*.html'))
- os.listdir(os.path.join('mydir', 'subdir'))
-
-
-.. _listing-packages:
-
-Listing whole packages
-======================
-
-The :option:`packages` option tells the Distutils to process (build, distribute,
-install, etc.) all pure Python modules found in each package mentioned in the
-:option:`packages` list. In order to do this, of course, there has to be a
-correspondence between package names and directories in the filesystem. The
-default correspondence is the most obvious one, i.e. package :mod:`distutils2` is
-found in the directory :file:`distutils2` relative to the distribution root.
-Thus, when you say ``packages = ['foo']`` in your setup script, you are
-promising that the Distutils will find a file :file:`foo/__init__.py` (which
-might be spelled differently on your system, but you get the idea) relative to
-the directory where your setup script lives. If you break this promise, the
-Distutils will issue a warning but still process the broken package anyways.
-
-If you use a different convention to lay out your source directory, that's no
-problem: you just have to supply the :option:`package_dir` option to tell the
-Distutils about your convention. For example, say you keep all Python source
-under :file:`lib`, so that modules in the "root package" (i.e., not in any
-package at all) are in :file:`lib`, modules in the :mod:`foo` package are in
-:file:`lib/foo`, and so forth. Then you would put ::
-
- package_dir = {'': 'lib'}
-
-in your setup script. The keys to this dictionary are package names, and an
-empty package name stands for the root package. The values are directory names
-relative to your distribution root. In this case, when you say ``packages =
-['foo']``, you are promising that the file :file:`lib/foo/__init__.py` exists.
-
-Another possible convention is to put the :mod:`foo` package right in
-:file:`lib`, the :mod:`foo.bar` package in :file:`lib/bar`, etc. This would be
-written in the setup script as ::
-
- package_dir = {'foo': 'lib'}
-
-A ``package: dir`` entry in the :option:`package_dir` dictionary implicitly
-applies to all packages below *package*, so the :mod:`foo.bar` case is
-automatically handled here. In this example, having ``packages = ['foo',
-'foo.bar']`` tells the Distutils to look for :file:`lib/__init__.py` and
-:file:`lib/bar/__init__.py`. (Keep in mind that although :option:`package_dir`
-applies recursively, you must explicitly list all packages in
-:option:`packages`: the Distutils will *not* recursively scan your source tree
-looking for any directory with an :file:`__init__.py` file.)
-
-
-.. _listing-modules:
-
-Listing individual modules
-==========================
-
-For a small module distribution, you might prefer to list all modules rather
-than listing packages---especially the case of a single module that goes in the
-"root package" (i.e., no package at all). This simplest case was shown in
-section :ref:`distutils-simple-example`; here is a slightly more involved
-example::
-
- py_modules = ['mod1', 'pkg.mod2']
-
-This describes two modules, one of them in the "root" package, the other in the
-:mod:`pkg` package. Again, the default package/directory layout implies that
-these two modules can be found in :file:`mod1.py` and :file:`pkg/mod2.py`, and
-that :file:`pkg/__init__.py` exists as well. And again, you can override the
-package/directory correspondence using the :option:`package_dir` option.
-
-
-.. _describing-extensions:
-
-Describing extension modules
-============================
-
-Just as writing Python extension modules is a bit more complicated than writing
-pure Python modules, describing them to the Distutils is a bit more complicated.
-Unlike pure modules, it's not enough just to list modules or packages and expect
-the Distutils to go out and find the right files; you have to specify the
-extension name, source file(s), and any compile/link requirements (include
-directories, libraries to link with, etc.).
-
-.. XXX read over this section
-
-All of this is done through another keyword argument to :func:`setup`, the
-:option:`ext_modules` option. :option:`ext_modules` is just a list of
-:class:`Extension` instances, each of which describes a single extension module.
-Suppose your distribution includes a single extension, called :mod:`foo` and
-implemented by :file:`foo.c`. If no additional instructions to the
-compiler/linker are needed, describing this extension is quite simple::
-
- Extension('foo', ['foo.c'])
-
-The :class:`Extension` class can be imported from :mod:`distutils2.core` along
-with :func:`setup`. Thus, the setup script for a module distribution that
-contains only this one extension and nothing else might be::
-
- from distutils2.core import setup, Extension
- setup(name='foo',
- version='1.0',
- ext_modules=[Extension('foo', ['foo.c'])])
-
-The :class:`Extension` class (actually, the underlying extension-building
-machinery implemented by the :command:`build_ext` command) supports a great deal
-of flexibility in describing Python extensions, which is explained in the
-following sections.
-
-
-Extension names and packages
-----------------------------
-
-The first argument to the :class:`Extension` constructor is always the name of
-the extension, including any package names. For example, ::
-
- Extension('foo', ['src/foo1.c', 'src/foo2.c'])
-
-describes an extension that lives in the root package, while ::
-
- Extension('pkg.foo', ['src/foo1.c', 'src/foo2.c'])
-
-describes the same extension in the :mod:`pkg` package. The source files and
-resulting object code are identical in both cases; the only difference is where
-in the filesystem (and therefore where in Python's namespace hierarchy) the
-resulting extension lives.
-
-If you have a number of extensions all in the same package (or all under the
-same base package), use the :option:`ext_package` keyword argument to
-:func:`setup`. For example, ::
-
- setup(...,
- ext_package='pkg',
- ext_modules=[Extension('foo', ['foo.c']),
- Extension('subpkg.bar', ['bar.c'])])
-
-will compile :file:`foo.c` to the extension :mod:`pkg.foo`, and :file:`bar.c` to
-:mod:`pkg.subpkg.bar`.
-
-
-Extension source files
-----------------------
-
-The second argument to the :class:`Extension` constructor is a list of source
-files. Since the Distutils currently only support C, C++, and Objective-C
-extensions, these are normally C/C++/Objective-C source files. (Be sure to use
-appropriate extensions to distinguish C++\ source files: :file:`.cc` and
-:file:`.cpp` seem to be recognized by both Unix and Windows compilers.)
-
-However, you can also include SWIG interface (:file:`.i`) files in the list; the
-:command:`build_ext` command knows how to deal with SWIG extensions: it will run
-SWIG on the interface file and compile the resulting C/C++ file into your
-extension.
-
-.. XXX SWIG support is rough around the edges and largely untested!
-
-This warning notwithstanding, options to SWIG can be currently passed like
-this::
-
- setup(...,
- ext_modules=[Extension('_foo', ['foo.i'],
- swig_opts=['-modern', '-I../include'])],
- py_modules=['foo'])
-
-Or on the command line like this::
-
- > python setup.py build_ext --swig-opts="-modern -I../include"
-
-On some platforms, you can include non-source files that are processed by the
-compiler and included in your extension. Currently, this just means Windows
-message text (:file:`.mc`) files and resource definition (:file:`.rc`) files for
-Visual C++. These will be compiled to binary resource (:file:`.res`) files and
-linked into the executable.
-
-
-Preprocessor options
---------------------
-
-Three optional arguments to :class:`Extension` will help if you need to specify
-include directories to search or preprocessor macros to define/undefine:
-``include_dirs``, ``define_macros``, and ``undef_macros``.
-
-For example, if your extension requires header files in the :file:`include`
-directory under your distribution root, use the ``include_dirs`` option::
-
- Extension('foo', ['foo.c'], include_dirs=['include'])
-
-You can specify absolute directories there; if you know that your extension will
-only be built on Unix systems with X11R6 installed to :file:`/usr`, you can get
-away with ::
-
- Extension('foo', ['foo.c'], include_dirs=['/usr/include/X11'])
-
-You should avoid this sort of non-portable usage if you plan to distribute your
-code: it's probably better to write C code like ::
-
- #include <X11/Xlib.h>
-
-If you need to include header files from some other Python extension, you can
-take advantage of the fact that header files are installed in a consistent way
-by the Distutils :command:`install_header` command. For example, the Numerical
-Python header files are installed (on a standard Unix installation) to
-:file:`/usr/local/include/python1.5/Numerical`. (The exact location will differ
-according to your platform and Python installation.) Since the Python include
-directory---\ :file:`/usr/local/include/python1.5` in this case---is always
-included in the search path when building Python extensions, the best approach
-is to write C code like ::
-
- #include <Numerical/arrayobject.h>
-
-.. TODO check if it's d2.sysconfig or the new sysconfig module now
-
-If you must put the :file:`Numerical` include directory right into your header
-search path, though, you can find that directory using the Distutils
-:mod:`distutils2.sysconfig` module::
-
- from distutils2.sysconfig import get_python_inc
- incdir = os.path.join(get_python_inc(plat_specific=1), 'Numerical')
- setup(...,
- Extension(..., include_dirs=[incdir]))
-
-Even though this is quite portable---it will work on any Python installation,
-regardless of platform---it's probably easier to just write your C code in the
-sensible way.
-
-You can define and undefine preprocessor macros with the ``define_macros`` and
-``undef_macros`` options. ``define_macros`` takes a list of ``(name, value)``
-tuples, where ``name`` is the name of the macro to define (a string) and
-``value`` is its value: either a string or ``None``. (Defining a macro ``FOO``
-to ``None`` is the equivalent of a bare ``#define FOO`` in your C source: with
-most compilers, this sets ``FOO`` to the string ``1``.) ``undef_macros`` is
-just a list of macros to undefine.
-
-For example::
-
- Extension(...,
- define_macros=[('NDEBUG', '1'),
- ('HAVE_STRFTIME', None)],
- undef_macros=['HAVE_FOO', 'HAVE_BAR'])
-
-is the equivalent of having this at the top of every C source file::
-
- #define NDEBUG 1
- #define HAVE_STRFTIME
- #undef HAVE_FOO
- #undef HAVE_BAR
-
-
-Library options
----------------
-
-You can also specify the libraries to link against when building your extension,
-and the directories to search for those libraries. The ``libraries`` option is
-a list of libraries to link against, ``library_dirs`` is a list of directories
-to search for libraries at link-time, and ``runtime_library_dirs`` is a list of
-directories to search for shared (dynamically loaded) libraries at run-time.
-
-For example, if you need to link against libraries known to be in the standard
-library search path on target systems ::
-
- Extension(...,
- libraries=['gdbm', 'readline'])
-
-If you need to link with libraries in a non-standard location, you'll have to
-include the location in ``library_dirs``::
-
- Extension(...,
- library_dirs=['/usr/X11R6/lib'],
- libraries=['X11', 'Xt'])
-
-(Again, this sort of non-portable construct should be avoided if you intend to
-distribute your code.)
-
-.. XXX Should mention clib libraries here or somewhere else!
-
-
-Other options
--------------
-
-There are still some other options which can be used to handle special cases.
-
-The :option:`optional` option is a boolean; if it is true,
-a build failure in the extension will not abort the build process, but
-instead simply not install the failing extension.
-
-The :option:`extra_objects` option is a list of object files to be passed to the
-linker. These files must not have extensions, as the default extension for the
-compiler is used.
-
-:option:`extra_compile_args` and :option:`extra_link_args` can be used to
-specify additional command-line options for the respective compiler and linker
-command lines.
-
-:option:`export_symbols` is only useful on Windows. It can contain a list of
-symbols (functions or variables) to be exported. This option is not needed when
-building compiled extensions: Distutils will automatically add ``initmodule``
-to the list of exported symbols.
-
-The :option:`depends` option is a list of files that the extension depends on
-(for example header files). The build command will call the compiler on the
-sources to rebuild extension if any on this files has been modified since the
-previous build.
-
-Relationships between Distributions and Packages
-================================================
-
-.. FIXME rewrite to update to PEP 345 (but without dist/release confusion)
-
-A distribution may relate to packages in three specific ways:
-
-#. It can require packages or modules.
-
-#. It can provide packages or modules.
-
-#. It can obsolete packages or modules.
-
-These relationships can be specified using keyword arguments to the
-:func:`distutils2.core.setup` function.
-
-Dependencies on other Python modules and packages can be specified by supplying
-the *requires* keyword argument to :func:`setup`. The value must be a list of
-strings. Each string specifies a package that is required, and optionally what
-versions are sufficient.
-
-To specify that any version of a module or package is required, the string
-should consist entirely of the module or package name. Examples include
-``'mymodule'`` and ``'xml.parsers.expat'``.
-
-If specific versions are required, a sequence of qualifiers can be supplied in
-parentheses. Each qualifier may consist of a comparison operator and a version
-number. The accepted comparison operators are::
-
- < > ==
- <= >= !=
-
-These can be combined by using multiple qualifiers separated by commas (and
-optional whitespace). In this case, all of the qualifiers must be matched; a
-logical AND is used to combine the evaluations.
-
-Let's look at a bunch of examples:
-
-+-------------------------+----------------------------------------------+
-| Requires Expression | Explanation |
-+=========================+==============================================+
-| ``==1.0`` | Only version ``1.0`` is compatible |
-+-------------------------+----------------------------------------------+
-| ``>1.0, !=1.5.1, <2.0`` | Any version after ``1.0`` and before ``2.0`` |
-| | is compatible, except ``1.5.1`` |
-+-------------------------+----------------------------------------------+
-
-Now that we can specify dependencies, we also need to be able to specify what we
-provide that other distributions can require. This is done using the *provides*
-keyword argument to :func:`setup`. The value for this keyword is a list of
-strings, each of which names a Python module or package, and optionally
-identifies the version. If the version is not specified, it is assumed to match
-that of the distribution.
-
-Some examples:
-
-+---------------------+----------------------------------------------+
-| Provides Expression | Explanation |
-+=====================+==============================================+
-| ``mypkg`` | Provide ``mypkg``, using the distribution |
-| | version |
-+---------------------+----------------------------------------------+
-| ``mypkg (1.1)`` | Provide ``mypkg`` version 1.1, regardless of |
-| | the distribution version |
-+---------------------+----------------------------------------------+
-
-A package can declare that it obsoletes other packages using the *obsoletes*
-keyword argument. The value for this is similar to that of the *requires*
-keyword: a list of strings giving module or package specifiers. Each specifier
-consists of a module or package name optionally followed by one or more version
-qualifiers. Version qualifiers are given in parentheses after the module or
-package name.
-
-The versions identified by the qualifiers are those that are obsoleted by the
-distribution being described. If no qualifiers are given, all versions of the
-named module or package are understood to be obsoleted.
-
-.. _distutils-installing-scripts:
-
-Installing Scripts
-==================
-
-So far we have been dealing with pure and non-pure Python modules, which are
-usually not run by themselves but imported by scripts.
-
-Scripts are files containing Python source code, intended to be started from the
-command line. Scripts don't require Distutils to do anything very complicated.
-The only clever feature is that if the first line of the script starts with
-``#!`` and contains the word "python", the Distutils will adjust the first line
-to refer to the current interpreter location. By default, it is replaced with
-the current interpreter location. The :option:`--executable` (or :option:`-e`)
-option will allow the interpreter path to be explicitly overridden.
-
-The :option:`scripts` option simply is a list of files to be handled in this
-way. From the PyXML setup script::
-
- setup(...,
- scripts=['scripts/xmlproc_parse', 'scripts/xmlproc_val'])
-
-All the scripts will also be added to the ``MANIFEST`` file if no template is
-provided. See :ref:`manifest`.
-
-.. _distutils-installing-package-data:
-
-Installing Package Data
-=======================
-
-Often, additional files need to be installed into a package. These files are
-often data that's closely related to the package's implementation, or text files
-containing documentation that might be of interest to programmers using the
-package. These files are called :dfn:`package data`.
-
-Package data can be added to packages using the ``package_data`` keyword
-argument to the :func:`setup` function. The value must be a mapping from
-package name to a list of relative path names that should be copied into the
-package. The paths are interpreted as relative to the directory containing the
-package (information from the ``package_dir`` mapping is used if appropriate);
-that is, the files are expected to be part of the package in the source
-directories. They may contain glob patterns as well.
-
-The path names may contain directory portions; any necessary directories will be
-created in the installation.
-
-For example, if a package should contain a subdirectory with several data files,
-the files can be arranged like this in the source tree::
-
- setup.py
- src/
- mypkg/
- __init__.py
- module.py
- data/
- tables.dat
- spoons.dat
- forks.dat
-
-The corresponding call to :func:`setup` might be::
-
- setup(...,
- packages=['mypkg'],
- package_dir={'mypkg': 'src/mypkg'},
- package_data={'mypkg': ['data/*.dat']})
-
-
-All the files that match ``package_data`` will be added to the ``MANIFEST``
-file if no template is provided. See :ref:`manifest`.
-
-
-.. _distutils-additional-files:
-
-Installing Additional Files
-===========================
-
-The :option:`data_files` option can be used to specify additional files needed
-by the module distribution: configuration files, message catalogs, data files,
-anything which doesn't fit in the previous categories.
-
-:option:`data_files` specifies a sequence of (*directory*, *files*) pairs in the
-following way::
-
- setup(...,
- data_files=[('bitmaps', ['bm/b1.gif', 'bm/b2.gif']),
- ('config', ['cfg/data.cfg']),
- ('/etc/init.d', ['init-script'])])
-
-Note that you can specify the directory names where the data files will be
-installed, but you cannot rename the data files themselves.
-
-Each (*directory*, *files*) pair in the sequence specifies the installation
-directory and the files to install there. If *directory* is a relative path, it
-is interpreted relative to the installation prefix (Python's ``sys.prefix`` for
-pure-Python packages, ``sys.exec_prefix`` for packages that contain extension
-modules). Each file name in *files* is interpreted relative to the
-:file:`setup.py` script at the top of the package source distribution. No
-directory information from *files* is used to determine the final location of
-the installed file; only the name of the file is used.
-
-You can specify the :option:`data_files` options as a simple sequence of files
-without specifying a target directory, but this is not recommended, and the
-:command:`install` command will print a warning in this case. To install data
-files directly in the target directory, an empty string should be given as the
-directory.
-
-All the files that match ``data_files`` will be added to the ``MANIFEST`` file
-if no template is provided. See :ref:`manifest`.
-
-
-
-.. _metadata:
-
-Metadata reference
-==================
-
-The setup script may include additional metadata beyond the name and version.
-This table describes required and additional information:
-
-+----------------------+---------------------------+-----------------+--------+
-| Meta-Data | Description | Value | Notes |
-+======================+===========================+=================+========+
-| ``name`` | name of the project | short string | \(1) |
-+----------------------+---------------------------+-----------------+--------+
-| ``version`` | version of this release | short string | (1)(2) |
-+----------------------+---------------------------+-----------------+--------+
-| ``author`` | project author's name | short string | \(3) |
-+----------------------+---------------------------+-----------------+--------+
-| ``author_email`` | email address of the | email address | \(3) |
-| | project author | | |
-+----------------------+---------------------------+-----------------+--------+
-| ``maintainer`` | project maintainer's name | short string | \(3) |
-+----------------------+---------------------------+-----------------+--------+
-| ``maintainer_email`` | email address of the | email address | \(3) |
-| | project maintainer | | |
-+----------------------+---------------------------+-----------------+--------+
-| ``home_page`` | home page for the project | URL | \(1) |
-+----------------------+---------------------------+-----------------+--------+
-| ``summary`` | short description of the | short string | |
-| | project | | |
-+----------------------+---------------------------+-----------------+--------+
-| ``description`` | longer description of the | long string | \(5) |
-| | project | | |
-+----------------------+---------------------------+-----------------+--------+
-| ``download_url`` | location where the | URL | |
-| | project may be downloaded | | |
-+----------------------+---------------------------+-----------------+--------+
-| ``classifiers`` | a list of classifiers | list of strings | \(4) |
-+----------------------+---------------------------+-----------------+--------+
-| ``platforms`` | a list of platforms | list of strings | |
-+----------------------+---------------------------+-----------------+--------+
-| ``license`` | license for the release | short string | \(6) |
-+----------------------+---------------------------+-----------------+--------+
-
-Notes:
-
-(1)
- These fields are required.
-
-(2)
- It is recommended that versions take the form *major.minor[.patch[.sub]]*.
-
-(3)
- Either the author or the maintainer must be identified.
-
-(4)
- The list of classifiers is available from the `PyPI website
- <http://pypi.python.org/pypi>`_. See also :mod:`distutils2.mkcfg`.
-
-(5)
- The ``description`` field is used by PyPI when you are registering a
- release, to build its PyPI page.
-
-(6)
- The ``license`` field is a text indicating the license covering the
- distribution where the license is not a selection from the "License" Trove
- classifiers. See the ``Classifier`` field. Notice that
- there's a ``licence`` distribution option which is deprecated but still
- acts as an alias for ``license``.
-
-'short string'
- A single line of text, not more than 200 characters.
-
-'long string'
- Multiple lines of plain text in reStructuredText format (see
- http://docutils.sf.net/).
-
-'list of strings'
- See below.
-
-In Python 2.x, "string value" means a unicode object. If a byte string (str or
-bytes) is given, it has to be valid ASCII.
-
-.. TODO move this section to the version document, keep a summary, add a link
-
-Encoding the version information is an art in itself. Python projects generally
-adhere to the version format *major.minor[.patch][sub]*. The major number is 0
-for initial, experimental releases of software. It is incremented for releases
-that represent major milestones in a project. The minor number is incremented
-when important new features are added to the project. The patch number
-increments when bug-fix releases are made. Additional trailing version
-information is sometimes used to indicate sub-releases. These are
-"a1,a2,...,aN" (for alpha releases, where functionality and API may change),
-"b1,b2,...,bN" (for beta releases, which only fix bugs) and "pr1,pr2,...,prN"
-(for final pre-release release testing). Some examples:
-
-0.1.0
- the first, experimental release of a project
-
-1.0.1a2
- the second alpha release of the first patch version of 1.0
-
-:option:`classifiers` are specified in a Python list::
-
- setup(...,
- classifiers=[
- 'Development Status :: 4 - Beta',
- 'Environment :: Console',
- 'Environment :: Web Environment',
- 'Intended Audience :: End Users/Desktop',
- 'Intended Audience :: Developers',
- 'Intended Audience :: System Administrators',
- 'License :: OSI Approved :: Python Software Foundation License',
- 'Operating System :: MacOS :: MacOS X',
- 'Operating System :: Microsoft :: Windows',
- 'Operating System :: POSIX',
- 'Programming Language :: Python',
- 'Topic :: Communications :: Email',
- 'Topic :: Office/Business',
- 'Topic :: Software Development :: Bug Tracking',
- ])
-
-
-Debugging the setup script
-==========================
-
-Sometimes things go wrong, and the setup script doesn't do what the developer
-wants.
-
-Distutils catches any exceptions when running the setup script, and print a
-simple error message before the script is terminated. The motivation for this
-behaviour is to not confuse administrators who don't know much about Python and
-are trying to install a project. If they get a big long traceback from deep
-inside the guts of Distutils, they may think the project or the Python
-installation is broken because they don't read all the way down to the bottom
-and see that it's a permission problem.
-
-.. FIXME DISTUTILS_DEBUG is dead, document logging/warnings here
-
-On the other hand, this doesn't help the developer to find the cause of the
-failure. For this purpose, the DISTUTILS_DEBUG environment variable can be set
-to anything except an empty string, and Distutils2 will now print detailed
-information about what it is doing, and prints the full traceback in case an
-exception occurs.
diff --git a/docs/source/distutils/sourcedist.rst b/docs/source/distutils/sourcedist.rst
deleted file mode 100644
--- a/docs/source/distutils/sourcedist.rst
+++ /dev/null
@@ -1,272 +0,0 @@
-.. _source-dist:
-
-******************************
-Creating a Source Distribution
-******************************
-
-As shown in section :ref:`distutils-simple-example`, you use the :command:`sdist` command
-to create a source distribution. In the simplest case, ::
-
- python setup.py sdist
-
-(assuming you haven't specified any :command:`sdist` options in the setup script
-or config file), :command:`sdist` creates the archive of the default format for
-the current platform. The default format is a gzip'ed tar file
-(:file:`.tar.gz`) on Unix, and ZIP file on Windows.
-
-You can specify as many formats as you like using the :option:`--formats`
-option, for example::
-
- python setup.py sdist --formats=gztar,zip
-
-to create a gzipped tarball and a zip file. The available formats are:
-
-+-----------+-------------------------+---------+
-| Format | Description | Notes |
-+===========+=========================+=========+
-| ``zip`` | zip file (:file:`.zip`) | (1),(3) |
-+-----------+-------------------------+---------+
-| ``gztar`` | gzip'ed tar file | \(2) |
-| | (:file:`.tar.gz`) | |
-+-----------+-------------------------+---------+
-| ``bztar`` | bzip2'ed tar file | |
-| | (:file:`.tar.bz2`) | |
-+-----------+-------------------------+---------+
-| ``ztar`` | compressed tar file | \(4) |
-| | (:file:`.tar.Z`) | |
-+-----------+-------------------------+---------+
-| ``tar`` | tar file (:file:`.tar`) | |
-+-----------+-------------------------+---------+
-
-Notes:
-
-(1)
- default on Windows
-
-(2)
- default on Unix
-
-(3)
- requires either external :program:`zip` utility or :mod:`zipfile` module (part
- of the standard Python library since Python 1.6)
-
-(4)
- requires the :program:`compress` program. Notice that this format is now
- pending for deprecation and will be removed in the future versions of Python.
-
-When using any ``tar`` format (``gztar``, ``bztar``, ``ztar`` or
-``tar``) under Unix, you can specify the ``owner`` and ``group`` names
-that will be set for each member of the archive.
-
-For example, if you want all files of the archive to be owned by root::
-
- python setup.py sdist --owner=root --group=root
-
-
-.. _manifest:
-
-Specifying the files to distribute
-==================================
-
-If you don't supply an explicit list of files (or instructions on how to
-generate one), the :command:`sdist` command puts a minimal default set into the
-source distribution:
-
-* all Python source files implied by the :option:`py_modules` and
- :option:`packages` options
-
-* all C source files mentioned in the :option:`ext_modules` or
- :option:`libraries` options
-
-* scripts identified by the :option:`scripts` option
- See :ref:`distutils-installing-scripts`.
-
-* anything that looks like a test script: :file:`test/test\*.py` (currently, the
- Distutils don't do anything with test scripts except include them in source
- distributions, but in the future there will be a standard for testing Python
- module distributions)
-
-* The configuration file :file:`setup.cfg`
-
-* all files that matches the ``package_data`` metadata.
- See :ref:`distutils-installing-package-data`.
-
-* all files that matches the ``data_files`` metadata.
- See :ref:`distutils-additional-files`.
-
-.. Warning::
- In Distutils2, setup.py and README (or README.txt) files are not more
- included in source distribution by default
-
-Sometimes this is enough, but usually you will want to specify additional files
-to distribute. The typical way to do this is to write a *manifest template*,
-called :file:`MANIFEST.in` by default. The manifest template is just a list of
-instructions for how to generate your manifest file, :file:`MANIFEST`, which is
-the exact list of files to include in your source distribution. The
-:command:`sdist` command processes this template and generates a manifest based
-on its instructions and what it finds in the filesystem.
-
-If you prefer to roll your own manifest file, the format is simple: one filename
-per line, regular files (or symlinks to them) only. If you do supply your own
-:file:`MANIFEST`, you must specify everything: the default set of files
-described above does not apply in this case.
-
-:file:`MANIFEST` files start with a comment indicating they are generated.
-Files without this comment are not overwritten or removed.
-
-See :ref:`manifest_template` section for a syntax reference.
-
-.. _manifest-options:
-
-Manifest-related options
-========================
-
-The normal course of operations for the :command:`sdist` command is as follows:
-
-* if the manifest file, :file:`MANIFEST` doesn't exist, read :file:`MANIFEST.in`
- and create the manifest
-
-* if neither :file:`MANIFEST` nor :file:`MANIFEST.in` exist, create a manifest
- with just the default file set
-
-* if either :file:`MANIFEST.in` or the setup script (:file:`setup.py`) are more
- recent than :file:`MANIFEST`, recreate :file:`MANIFEST` by reading
- :file:`MANIFEST.in`
-
-* use the list of files now in :file:`MANIFEST` (either just generated or read
- in) to create the source distribution archive(s)
-
-There are a couple of options that modify this behaviour. First, use the
-:option:`--no-defaults` and :option:`--no-prune` to disable the standard
-"include" and "exclude" sets.
-
-Second, you might just want to (re)generate the manifest, but not create a
-source distribution::
-
- python setup.py sdist --manifest-only
-
-:option:`-o` is a shortcut for :option:`--manifest-only`.
-
-.. _manifest_template:
-
-The MANIFEST.in template
-========================
-
-A :file:`MANIFEST.in` file can be added in a project to define the list of
-files to include in the distribution built by the :command:`sdist` command.
-
-When :command:`sdist` is run, it will look for the :file:`MANIFEST.in` file
-and interpret it to generate the :file:`MANIFEST` file that contains the
-list of files that will be included in the package.
-
-This mechanism can be used when the default list of files is not enough.
-(See :ref:`manifest`).
-
-Principle
----------
-
-The manifest template has one command per line, where each command specifies a
-set of files to include or exclude from the source distribution. For an
-example, let's look at the Distutils' own manifest template::
-
- include *.txt
- recursive-include examples *.txt *.py
- prune examples/sample?/build
-
-The meanings should be fairly clear: include all files in the distribution root
-matching :file:`\*.txt`, all files anywhere under the :file:`examples` directory
-matching :file:`\*.txt` or :file:`\*.py`, and exclude all directories matching
-:file:`examples/sample?/build`. All of this is done *after* the standard
-include set, so you can exclude files from the standard set with explicit
-instructions in the manifest template. (Or, you can use the
-:option:`--no-defaults` option to disable the standard set entirely.)
-
-The order of commands in the manifest template matters: initially, we have the
-list of default files as described above, and each command in the template adds
-to or removes from that list of files. Once we have fully processed the
-manifest template, we remove files that should not be included in the source
-distribution:
-
-* all files in the Distutils "build" tree (default :file:`build/`)
-
-* all files in directories named :file:`RCS`, :file:`CVS`, :file:`.svn`,
- :file:`.hg`, :file:`.git`, :file:`.bzr` or :file:`_darcs`
-
-Now we have our complete list of files, which is written to the manifest for
-future reference, and then used to build the source distribution archive(s).
-
-You can disable the default set of included files with the
-:option:`--no-defaults` option, and you can disable the standard exclude set
-with :option:`--no-prune`.
-
-Following the Distutils' own manifest template, let's trace how the
-:command:`sdist` command builds the list of files to include in the Distutils
-source distribution:
-
-#. include all Python source files in the :file:`distutils2` and
- :file:`distutils2/command` subdirectories (because packages corresponding to
- those two directories were mentioned in the :option:`packages` option in the
- setup script---see section :ref:`setup-script`)
-
-#. include :file:`README.txt`, :file:`setup.py`, and :file:`setup.cfg` (standard
- files)
-
-#. include :file:`test/test\*.py` (standard files)
-
-#. include :file:`\*.txt` in the distribution root (this will find
- :file:`README.txt` a second time, but such redundancies are weeded out later)
-
-#. include anything matching :file:`\*.txt` or :file:`\*.py` in the sub-tree
- under :file:`examples`,
-
-#. exclude all files in the sub-trees starting at directories matching
- :file:`examples/sample?/build`\ ---this may exclude files included by the
- previous two steps, so it's important that the ``prune`` command in the manifest
- template comes after the ``recursive-include`` command
-
-#. exclude the entire :file:`build` tree, and any :file:`RCS`, :file:`CVS`,
- :file:`.svn`, :file:`.hg`, :file:`.git`, :file:`.bzr` and :file:`_darcs`
- directories
-
-Just like in the setup script, file and directory names in the manifest template
-should always be slash-separated; the Distutils will take care of converting
-them to the standard representation on your platform. That way, the manifest
-template is portable across operating systems.
-
-Commands
---------
-
-The manifest template commands are:
-
-+-------------------------------------------+-----------------------------------------------+
-| Command | Description |
-+===========================================+===============================================+
-| :command:`include pat1 pat2 ...` | include all files matching any of the listed |
-| | patterns |
-+-------------------------------------------+-----------------------------------------------+
-| :command:`exclude pat1 pat2 ...` | exclude all files matching any of the listed |
-| | patterns |
-+-------------------------------------------+-----------------------------------------------+
-| :command:`recursive-include dir pat1 pat2 | include all files under *dir* matching any of |
-| ...` | the listed patterns |
-+-------------------------------------------+-----------------------------------------------+
-| :command:`recursive-exclude dir pat1 pat2 | exclude all files under *dir* matching any of |
-| ...` | the listed patterns |
-+-------------------------------------------+-----------------------------------------------+
-| :command:`global-include pat1 pat2 ...` | include all files anywhere in the source tree |
-| | matching --- & any of the listed patterns |
-+-------------------------------------------+-----------------------------------------------+
-| :command:`global-exclude pat1 pat2 ...` | exclude all files anywhere in the source tree |
-| | matching --- & any of the listed patterns |
-+-------------------------------------------+-----------------------------------------------+
-| :command:`prune dir` | exclude all files under *dir* |
-+-------------------------------------------+-----------------------------------------------+
-| :command:`graft dir` | include all files under *dir* |
-+-------------------------------------------+-----------------------------------------------+
-
-The patterns here are Unix-style "glob" patterns: ``*`` matches any sequence of
-regular filename characters, ``?`` matches any single regular filename
-character, and ``[range]`` matches any of the characters in *range* (e.g.,
-``a-z``, ``a-zA-Z``, ``a-f0-9_.``). The definition of "regular filename
-character" is platform-specific: on Unix it is anything except slash; on Windows
-anything except backslash or colon.
diff --git a/docs/source/distutils/uploading.rst b/docs/source/distutils/uploading.rst
deleted file mode 100644
--- a/docs/source/distutils/uploading.rst
+++ /dev/null
@@ -1,80 +0,0 @@
-.. _package-upload:
-
-***************************************
-Uploading Packages to the Package Index
-***************************************
-
-The Python Package Index (PyPI) not only stores the package info, but also the
-package data if the author of the package wishes to. The distutils command
-:command:`upload` pushes the distribution files to PyPI.
-
-The command is invoked immediately after building one or more distribution
-files. For example, the command ::
-
- python setup.py sdist bdist_wininst upload
-
-will cause the source distribution and the Windows installer to be uploaded to
-PyPI. Note that these will be uploaded even if they are built using an earlier
-invocation of :file:`setup.py`, but that only distributions named on the command
-line for the invocation including the :command:`upload` command are uploaded.
-
-The :command:`upload` command uses the username, password, and repository URL
-from the :file:`$HOME/.pypirc` file (see section :ref:`pypirc` for more on this
-file). If a :command:`register` command was previously called in the same
-command, and if the password was entered in the prompt, :command:`upload` will
-reuse the entered password. This is useful if you do not want to store a clear
-text password in the :file:`$HOME/.pypirc` file.
-
-You can specify another PyPI server with the :option:`--repository=*url*`
-option::
-
- python setup.py sdist bdist_wininst upload -r http://example.com/pypi
-
-See section :ref:`pypirc` for more on defining several servers.
-
-You can use the :option:`--sign` option to tell :command:`upload` to sign each
-uploaded file using GPG (GNU Privacy Guard). The :program:`gpg` program must
-be available for execution on the system :envvar:`PATH`. You can also specify
-which key to use for signing using the :option:`--identity=*name*` option.
-
-Other :command:`upload` options include :option:`--repository=<url>` or
-:option:`--repository=<section>` where *url* is the url of the server and
-*section* the name of the section in :file:`$HOME/.pypirc`, and
-:option:`--show-response` (which displays the full response text from the PyPI
-server for help in debugging upload problems).
-
-PyPI package display
-====================
-
-The ``description`` field plays a special role at PyPI. It is used by
-the server to display a home page for the registered package.
-
-If you use the `reStructuredText <http://docutils.sourceforge.net/rst.html>`_
-syntax for this field, PyPI will parse it and display an HTML output for
-the package home page.
-
-The ``description`` field can be filled from a text file located in the
-project::
-
- from distutils2.core import setup
-
- fp = open('README.txt')
- try:
- description = fp.read()
- finally:
- fp.close()
-
- setup(name='Distutils2',
- description=description)
-
-In that case, :file:`README.txt` is a regular reStructuredText text file located
-in the root of the package besides :file:`setup.py`.
-
-To prevent registering broken reStructuredText content, you can use the
-:program:`rst2html` program that is provided by the :mod:`docutils` package
-and check the ``description`` from the command line::
-
- $ python setup.py --description | rst2html.py > output.html
-
-:mod:`docutils` will display a warning if there's something wrong with your
-syntax.
diff --git a/docs/source/images/depgraph_output.png b/docs/source/images/depgraph_output.png
deleted file mode 100644
Binary file docs/source/images/depgraph_output.png has changed
diff --git a/docs/source/index.rst b/docs/source/index.rst
deleted file mode 100644
--- a/docs/source/index.rst
+++ /dev/null
@@ -1,91 +0,0 @@
-.. Distutils2 doc site master file
- This doc serves as project homepage and documentation preview
- (on distutils2.notmyidea.org) until distutils2 is merged back into
- the Python standard library.
- This file should contain the root `toctree` directive.
-
-
-Welcome to Distutils2!
-======================
-
-Distutils2 is the new, improved version of the Python Distribution Utilities,
-a library used to package, distribute, build and install Python projects.
-
-- `Origin of the project`__
-- `Main code repository`__
-- `Clones of this repository`__
-- `Bug tracker`__ (some bugs may be assigned only to Distutils)
-- `Teams that worked on Distutils2 for Google Summer of Code 2010`__ (links to
- their code repositories and weblogs)
-
-.. __: http://tarekziade.wordpress.com/2010/03/03/
- the-fate-of-distutils-pycon-summit-packaging-sprint-detailed-report/
-.. __: http://bitbucket.org/tarek/distutils2/
-.. __: http://bitbucket.org/tarek/distutils2/descendants/
-.. __: http://bugs.python.org/issue?%40sort0=activity&%40sortdir0=on&%40sort1=
- &%40group0=priority&%40group1=&%40columns=title%2Cid%2Cactivity%2Cstatus
- &%40filter=components%2Cstatus&status=1&components=25&%40pagesize=50
- &%40startwith=0
-.. __: http://bitbucket.org/tarek/distutils2/wiki/GSoC_2010_teams
-
-If you’re looking for information on how to contribute, head to
-:doc:`devresources`, and be sure to have a look at :doc:`contributing`.
-
-
-Documentation
--------------
-
-These documents are the in-development version of Distutils2's documentation,
-started from the existing Distutils documentation and updated by the
-Distutils2 group (GSoC students, mentors, volunteers).
-
-Please remember that this is a work in progress. The documentation is not
-complete, not spell-checked, and uses different styles.
-
-The documentation is split in four sections, as in the standard Python docs:
-
-:doc:`install/index`
- A guide for for end-users wanting to install a Python application or
- library.
-
-:doc:`setupcfg-spec`
- Specifications of setup.cfg, the most important file for developers.
-
-:doc:`setupcfg`
- Documenation about using setup.cfg
-
-:doc:`tutorial`
- A tutorial for Python developers to discover Distutils2 main features.
-
-:doc:`distutils/index`
- A guide for Python developers wanting to package and distribute their
- project.
-
-:doc:`library/distutils2`
- A reference for developers wanting to use standalone building blocks like
- :mod:`~distutils2.version` or :mod:`~distutils2.metadata`, or extend
- Distutils2 itself. Since :PEP:`376` is partly implemented in the
- :mod:`pkgutil` module, its updated documentation is also included:
- :doc:`library/pkgutil`.
-
-
-.. toctree::
- :hidden:
-
- devresources
- install/index
- setupcfg-spec
- setupcfg
- tutorial
- distutils/index
- library/distutils2
- library/pkgutil
- contributing
-
-
-Indices and tables
-------------------
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
diff --git a/docs/source/install/index.rst b/docs/source/install/index.rst
deleted file mode 100644
--- a/docs/source/install/index.rst
+++ /dev/null
@@ -1,1004 +0,0 @@
-.. highlightlang:: none
-
-.. _install-index:
-
-******************************
- Installing Python Projects
-******************************
-
-:Author: Greg Ward and Distutils2 contributors
-:Release: |version|
-:Date: |today|
-
-.. TODO: Fill in XXX comments
-
-.. The audience for this document includes people who don't know anything
- about Python and aren't about to learn the language just in order to
- install and maintain it for their users, i.e. system administrators.
- Thus, I have to be sure to explain the basics at some point:
- sys.path and PYTHONPATH at least. Should probably give pointers to
- other docs on "import site", PYTHONSTARTUP, PYTHONHOME, etc.
-
- Finally, it might be useful to include all the material from my "Care
- and Feeding of a Python Installation" talk in here somewhere. Yow!
-
-.. topic:: Abstract
-
- This document describes the Python Distribution Utilities ("Distutils2") from
- the end-user's point-of-view, describing how to extend the capabilities of a
- standard Python installation by building and installing third-party Python
- modules and extensions.
-
-
-.. _inst-intro:
-
-Introduction
-============
-
-Although Python's extensive standard library covers many programming needs,
-there often comes a time when you need to add some new functionality to your
-Python installation in the form of third-party modules. This might be necessary
-to support your own programming, or to support an application that you want to
-use and that happens to be written in Python.
-
-In the past, there has been little support for adding third-party modules to an
-existing Python installation. With the introduction of the Python Distribution
-Utilities (Distutils for short) in Python 2.0, this changed.
-
-This document is aimed primarily at the people who need to install third-party
-Python modules: end-users and system administrators who just need to get some
-Python application running, and existing Python programmers who want to add some
-new goodies to their toolbox. You don't need to know Python to read this
-document; there will be some brief forays into using Python's interactive mode
-to explore your installation, but that's it. If you're looking for information
-on how to distribute your own Python modules so that others may use them, see
-the :ref:`distutils-index` manual.
-
-
-.. _inst-trivial-install:
-
-Best case: trivial installation
--------------------------------
-
-In the best case, someone will have prepared a special version of the module
-distribution you want to install that is targeted specifically at your platform
-and is installed just like any other software on your platform. For example,
-the module developer might make an executable installer available for Windows
-users, an RPM package for users of RPM-based Linux systems (Red Hat, SuSE,
-Mandrake, and many others), a Debian package for users of Debian-based Linux
-systems, and so forth.
-
-In that case, you would download the installer appropriate to your platform and
-do the obvious thing with it: run it if it's an executable installer, ``rpm
---install`` it if it's an RPM, etc. You don't need to run Python or a setup
-script, you don't need to compile anything---you might not even need to read any
-instructions (although it's always a good idea to do so anyways).
-
-Of course, things will not always be that easy. You might be interested in a
-module distribution that doesn't have an easy-to-use installer for your
-platform. In that case, you'll have to start with the source distribution
-released by the module's author/maintainer. Installing from a source
-distribution is not too hard, as long as the modules are packaged in the
-standard way. The bulk of this document is about building and installing
-modules from standard source distributions.
-
-
-.. _inst-new-standard:
-
-The new standard: Distutils
----------------------------
-
-If you download a module source distribution, you can tell pretty quickly if it
-was packaged and distributed in the standard way, i.e. using the Distutils.
-First, the distribution's name and version number will be featured prominently
-in the name of the downloaded archive, e.g. :file:`foo-1.0.tar.gz` or
-:file:`widget-0.9.7.zip`. Next, the archive will unpack into a similarly-named
-directory: :file:`foo-1.0` or :file:`widget-0.9.7`. Additionally, the
-distribution will contain a setup script :file:`setup.py`, and a file named
-:file:`README.txt` or possibly just :file:`README`, which should explain that
-building and installing the module distribution is a simple matter of running ::
-
- python setup.py install
-
-If all these things are true, then you already know how to build and install the
-modules you've just downloaded: Run the command above. Unless you need to
-install things in a non-standard way or customize the build process, you don't
-really need this manual. Or rather, the above command is everything you need to
-get out of this manual.
-
-
-.. _inst-standard-install:
-
-Standard Build and Install
-==========================
-
-As described in section :ref:`inst-new-standard`, building and installing a module
-distribution using the Distutils is usually one simple command::
-
- python setup.py install
-
-On Unix, you'd run this command from a shell prompt; on Windows, you have to
-open a command prompt window ("DOS box") and do it there; on Mac OS X, you open
-a :command:`Terminal` window to get a shell prompt.
-
-
-.. _inst-platform-variations:
-
-Platform variations
--------------------
-
-You should always run the setup command from the distribution root directory,
-i.e. the top-level subdirectory that the module source distribution unpacks
-into. For example, if you've just downloaded a module source distribution
-:file:`foo-1.0.tar.gz` onto a Unix system, the normal thing to do is::
-
- gunzip -c foo-1.0.tar.gz | tar xf - # unpacks into directory foo-1.0
- cd foo-1.0
- python setup.py install
-
-On Windows, you'd probably download :file:`foo-1.0.zip`. If you downloaded the
-archive file to :file:`C:\\Temp`, then it would unpack into
-:file:`C:\\Temp\\foo-1.0`; you can use either a archive manipulator with a
-graphical user interface (such as WinZip) or a command-line tool (such as
-:program:`unzip` or :program:`pkunzip`) to unpack the archive. Then, open a
-command prompt window ("DOS box"), and run::
-
- cd c:\Temp\foo-1.0
- python setup.py install
-
-
-.. _inst-splitting-up:
-
-Splitting the job up
---------------------
-
-Running ``setup.py install`` builds and installs all modules in one run. If you
-prefer to work incrementally---especially useful if you want to customize the
-build process, or if things are going wrong---you can use the setup script to do
-one thing at a time. This is particularly helpful when the build and install
-will be done by different users---for example, you might want to build a module
-distribution and hand it off to a system administrator for installation (or do
-it yourself, with super-user privileges).
-
-For example, you can build everything in one step, and then install everything
-in a second step, by invoking the setup script twice::
-
- python setup.py build
- python setup.py install
-
-If you do this, you will notice that running the :command:`install` command
-first runs the :command:`build` command, which---in this case---quickly notices
-that it has nothing to do, since everything in the :file:`build` directory is
-up-to-date.
-
-You may not need this ability to break things down often if all you do is
-install modules downloaded off the 'net, but it's very handy for more advanced
-tasks. If you get into distributing your own Python modules and extensions,
-you'll run lots of individual Distutils commands on their own.
-
-
-.. _inst-how-build-works:
-
-How building works
-------------------
-
-As implied above, the :command:`build` command is responsible for putting the
-files to install into a *build directory*. By default, this is :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::
-
- python setup.py build --build-base /tmp/pybuild/foo-1.0
-
-(Or you could do this permanently with a directive in your system or personal
-Distutils configuration file; see section :ref:`inst-config-files`.) Normally,
-this isn't necessary.
-
-The default layout for the build tree is as follows::
-
- --- build/ --- lib/
- or
- --- build/ --- lib.<plat>/
- temp.<plat>/
-
-where ``<plat>`` expands to a brief description of the current OS/hardware
-platform and Python version. 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++), then the second form, with two ``<plat>``
-directories, is used. In that case, the :file:`temp.{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.{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 applications.
-
-
-.. _inst-how-install-works:
-
-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.{plat}`) to your chosen installation
-directory.
-
-If you don't choose an installation directory---i.e., if you just run ``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 X, which is also
-Unix-based), it also depends on whether the module distribution being installed
-is pure Python or contains extensions ("non-pure"):
-
-+-----------------+-----------------------------------------------------+--------------------------------------------------+-------+
-| Platform | Standard installation location | Default value | Notes |
-+=================+=====================================================+==================================================+=======+
-| Unix (pure) | :file:`{prefix}/lib/python{X.Y}/site-packages` | :file:`/usr/local/lib/python{X.Y}/site-packages` | \(1) |
-+-----------------+-----------------------------------------------------+--------------------------------------------------+-------+
-| Unix (non-pure) | :file:`{exec-prefix}/lib/python{X.Y}/site-packages` | :file:`/usr/local/lib/python{X.Y}/site-packages` | \(1) |
-+-----------------+-----------------------------------------------------+--------------------------------------------------+-------+
-| Windows | :file:`{prefix}` | :file:`C:\\Python` | \(2) |
-+-----------------+-----------------------------------------------------+--------------------------------------------------+-------+
-
-Notes:
-
-(1)
- Most Linux distributions include Python as a standard part of the system, so
- :file:`{prefix}` and :file:`{exec-prefix}` are usually both :file:`/usr` on
- Linux. If you build Python yourself on Linux (or any Unix-like system), the
- default :file:`{prefix}` and :file:`{exec-prefix}` are :file:`/usr/local`.
-
-(2)
- The default installation directory on Windows was :file:`C:\\Program
- Files\\Python` under Python 1.6a1, 1.5.2, and earlier.
-
-:file:`{prefix}` and :file:`{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 very often the same under Unix and Mac OS X. You
-can find out what your Python installation uses for :file:`{prefix}` and
-:file:`{exec-prefix}` by running Python in interactive mode and typing a few
-simple commands. Under Unix, just type ``python`` at the shell prompt. Under
-Windows, choose :menuselection:`Start --> Programs --> Python X.Y -->
-Python (command line)`. Once the interpreter is started, you type Python code
-at the 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
-:file:`{prefix}` and :file:`{exec-prefix}`::
-
- Python 2.4 (#26, Aug 7 2004, 17:19:02)
- Type "help", "copyright", "credits" or "license" for more information.
- >>> import sys
- >>> sys.prefix
- '/usr'
- >>> sys.exec_prefix
- '/usr'
-
-If you don't want to install modules to the standard location, or if you don't
-have permission to write there, then you need to read about alternate
-installations in section :ref:`inst-alt-install`. If you want to customize your
-installation directories more heavily, see section :ref:`inst-custom-install` on
-custom installations.
-
-
-.. _inst-alt-install:
-
-Alternate Installation
-======================
-
-Often, it is necessary or desirable to install modules to a location other than
-the standard location for third-party Python modules. For example, on a Unix
-system you might not have permission to write to the standard third-party module
-directory. Or you might wish to try out a module before making it a standard
-part of your local Python installation. This is especially true when upgrading
-a distribution already present: you want to make sure your existing base of
-scripts still works with the new version before actually upgrading.
-
-The Distutils :command:`install` command is designed to make installing module
-distributions to an alternate location simple and painless. The basic idea is
-that you supply a base directory for the installation, and the
-:command:`install` command picks a set of directories (called an *installation
-scheme*) under this base directory in which to install files. The details
-differ across platforms, so read whichever of the following sections applies to
-you.
-
-
-.. _inst-alt-install-prefix:
-
-Alternate installation: the home scheme
----------------------------------------
-
-The idea behind the "home scheme" is that you build and maintain a personal
-stash of Python modules. This scheme's name is derived from the idea of a
-"home" directory on Unix, since it's not unusual for a Unix user to make their
-home directory have a layout similar to :file:`/usr/` or :file:`/usr/local/`.
-This scheme can be used by anyone, regardless of the operating system they
-are installing for.
-
-Installing a new module distribution is as simple as ::
-
- python setup.py install --home <dir>
-
-where you can supply any directory you like for the :option:`--home` option. On
-Unix, lazy typists can just type a tilde (``~``); the :command:`install` command
-will expand this to your home directory::
-
- python setup.py install --home ~
-
-The :option:`--home` option defines the installation base directory. Files are
-installed to the following directories under the installation base as follows:
-
-+------------------------------+---------------------------+-----------------------------+
-| Type of file | Installation Directory | Override option |
-+==============================+===========================+=============================+
-| pure module distribution | :file:`{home}/lib/python` | :option:`--install-purelib` |
-+------------------------------+---------------------------+-----------------------------+
-| non-pure module distribution | :file:`{home}/lib/python` | :option:`--install-platlib` |
-+------------------------------+---------------------------+-----------------------------+
-| scripts | :file:`{home}/bin` | :option:`--install-scripts` |
-+------------------------------+---------------------------+-----------------------------+
-| data | :file:`{home}/share` | :option:`--install-data` |
-+------------------------------+---------------------------+-----------------------------+
-
-
-.. _inst-alt-install-home:
-
-Alternate installation: Unix (the prefix scheme)
-------------------------------------------------
-
-The "prefix scheme" is useful when you wish to use one Python installation to
-perform the build/install (i.e., to run the setup script), but install modules
-into the third-party module directory of a different Python installation (or
-something that looks like a different Python installation). If this sounds a
-trifle unusual, it is---that's why the "home scheme" comes first. However,
-there are at least two known cases where the prefix scheme will be useful.
-
-First, consider that many Linux distributions put Python in :file:`/usr`, rather
-than the more traditional :file:`/usr/local`. This is entirely appropriate,
-since in those cases Python is part of "the system" rather than a local add-on.
-However, if you are installing Python modules from source, you probably want
-them to go in :file:`/usr/local/lib/python2.{X}` rather than
-:file:`/usr/lib/python2.{X}`. This can be done with ::
-
- /usr/bin/python setup.py install --prefix /usr/local
-
-Another possibility is a network filesystem where the name used to write to a
-remote directory is different from the name used to read it: for example, the
-Python interpreter accessed as :file:`/usr/local/bin/python` might search for
-modules in :file:`/usr/local/lib/python2.{X}`, but those modules would have to
-be installed to, say, :file:`/mnt/{@server}/export/lib/python2.{X}`. This could
-be done with ::
-
- /usr/local/bin/python setup.py install --prefix=/mnt/@server/export
-
-In either case, the :option:`--prefix` option defines the installation base, and
-the :option:`--exec-prefix` option defines the platform-specific installation
-base, which is used for platform-specific files. (Currently, this just means
-non-pure module distributions, but could be expanded to C libraries, binary
-executables, etc.) If :option:`--exec-prefix` is not supplied, it defaults to
-:option:`--prefix`. Files are installed as follows:
-
-+------------------------------+-----------------------------------------------------+-----------------------------+
-| Type of file | Installation Directory | Override option |
-+==============================+=====================================================+=============================+
-| pure module distribution | :file:`{prefix}/lib/python{X.Y}/site-packages` | :option:`--install-purelib` |
-+------------------------------+-----------------------------------------------------+-----------------------------+
-| non-pure module distribution | :file:`{exec-prefix}/lib/python{X.Y}/site-packages` | :option:`--install-platlib` |
-+------------------------------+-----------------------------------------------------+-----------------------------+
-| scripts | :file:`{prefix}/bin` | :option:`--install-scripts` |
-+------------------------------+-----------------------------------------------------+-----------------------------+
-| data | :file:`{prefix}/share` | :option:`--install-data` |
-+------------------------------+-----------------------------------------------------+-----------------------------+
-
-There is no requirement that :option:`--prefix` or :option:`--exec-prefix`
-actually point to an alternate Python installation; if the directories listed
-above do not already exist, they are created at installation time.
-
-Incidentally, the real reason the prefix scheme is important is simply that a
-standard Unix installation uses the prefix scheme, but with :option:`--prefix`
-and :option:`--exec-prefix` supplied by Python itself as ``sys.prefix`` and
-``sys.exec_prefix``. Thus, you might think you'll never use the prefix scheme,
-but every time you run ``python setup.py install`` without any other options,
-you're using it.
-
-Note that installing extensions to an alternate Python installation has no
-effect on how those extensions are built: in particular, the Python header files
-(:file:`Python.h` and friends) installed with the Python interpreter used to run
-the setup script will be used in compiling extensions. It is your
-responsibility to ensure that the interpreter used to run extensions installed
-in this way is compatible with the interpreter used to build them. The best way
-to do this is to ensure that the two interpreters are the same version of Python
-(possibly different builds, or possibly copies of the same build). (Of course,
-if your :option:`--prefix` and :option:`--exec-prefix` don't even point to an
-alternate Python installation, this is immaterial.)
-
-
-.. _inst-alt-install-windows:
-
-Alternate installation: Windows (the prefix scheme)
----------------------------------------------------
-
-Windows has no concept of a user's home directory, and since the standard Python
-installation under Windows is simpler than under Unix, the :option:`--prefix`
-option has traditionally been used to install additional packages in separate
-locations on Windows. ::
-
- python setup.py install --prefix "\Temp\Python"
-
-to install modules to the :file:`\\Temp\\Python` directory on the current drive.
-
-The installation base is defined by the :option:`--prefix` option; the
-:option:`--exec-prefix` option is not supported under Windows. Files are
-installed as follows:
-
-+------------------------------+---------------------------+-----------------------------+
-| Type of file | Installation Directory | Override option |
-+==============================+===========================+=============================+
-| pure module distribution | :file:`{prefix}` | :option:`--install-purelib` |
-+------------------------------+---------------------------+-----------------------------+
-| non-pure module distribution | :file:`{prefix}` | :option:`--install-platlib` |
-+------------------------------+---------------------------+-----------------------------+
-| scripts | :file:`{prefix}\\Scripts` | :option:`--install-scripts` |
-+------------------------------+---------------------------+-----------------------------+
-| data | :file:`{prefix}\\Data` | :option:`--install-data` |
-+------------------------------+---------------------------+-----------------------------+
-
-
-.. _inst-custom-install:
-
-Custom Installation
-===================
-
-Sometimes, the alternate installation schemes described in section
-:ref:`inst-alt-install` just don't do what you want. You might want to tweak
-just one or two directories while keeping everything under the same base
-directory, or you might want to completely redefine the installation scheme.
-In either case, you're creating a *custom installation scheme*.
-
-You probably noticed the column of "override options" in the tables describing
-the alternate installation schemes above. Those options are how you define a
-custom installation scheme. These override options can be relative, absolute,
-or explicitly defined in terms of one of the installation base directories.
-(There are two installation base directories, and they are normally the same---
-they only differ when you use the Unix "prefix scheme" and supply different
-:option:`--prefix` and :option:`--exec-prefix` options.)
-
-For example, say you're installing a module distribution to your home directory
-under Unix---but you want scripts to go in :file:`~/scripts` rather than
-:file:`~/bin`. As you might expect, you can override this directory with the
-:option:`--install-scripts` option; in this case, it makes most sense to supply
-a relative path, which will be interpreted relative to the installation base
-directory (your home directory, in this case)::
-
- python setup.py install --home ~ --install-scripts scripts
-
-Another Unix example: suppose your Python installation was built and installed
-with a prefix of :file:`/usr/local/python`, so under a standard installation
-scripts will wind up in :file:`/usr/local/python/bin`. If you want them in
-:file:`/usr/local/bin` instead, you would supply this absolute directory for the
-:option:`--install-scripts` option::
-
- python setup.py install --install-scripts /usr/local/bin
-
-(This performs an installation using the "prefix scheme," where the prefix is
-whatever your Python interpreter was installed with--- :file:`/usr/local/python`
-in this case.)
-
-If you maintain Python on Windows, you might want third-party modules to live in
-a subdirectory of :file:`{prefix}`, rather than right in :file:`{prefix}`
-itself. This is almost as easy as customizing the script installation directory
----you just have to remember that there are two types of modules to worry about,
-pure modules and non-pure modules (i.e., modules from a non-pure distribution).
-For example::
-
- python setup.py install --install-purelib Site --install-platlib Site
-
-The specified installation directories are relative to :file:`{prefix}`. Of
-course, you also have to ensure that these directories are in Python's module
-search path, such as by putting a :file:`.pth` file in :file:`{prefix}`. See
-section :ref:`inst-search-path` to find out how to modify Python's search path.
-
-If you want to define an entire installation scheme, you just have to supply all
-of the installation directory options. The recommended way to do this is to
-supply relative paths; for example, if you want to maintain all Python
-module-related files under :file:`python` in your home directory, and you want a
-separate directory for each platform that you use your home directory from, you
-might define the following installation scheme::
-
- python setup.py install --home ~ \
- --install-purelib python/lib \
- --install-platlib python/'lib.$PLAT' \
- --install-scripts python/scripts
- --install-data python/data
-
-or, equivalently, ::
-
- python setup.py install --home ~/python \
- --install-purelib lib \
- --install-platlib 'lib.$PLAT' \
- --install-scripts scripts
- --install-data data
-
-``$PLAT`` is not (necessarily) an environment variable---it will be expanded by
-the Distutils as it parses your command line options, just as it does when
-parsing your configuration file(s).
-
-Obviously, specifying the entire installation scheme every time you install a
-new module distribution would be very tedious. Thus, you can put these options
-into your Distutils config file (see section :ref:`inst-config-files`)::
-
- [install]
- install-base = $HOME
- install-purelib = python/lib
- install-platlib = python/lib.$PLAT
- install-scripts = python/scripts
- install-data = python/data
-
-or, equivalently, ::
-
- [install]
- install-base = $HOME/python
- install-purelib = lib
- install-platlib = lib.$PLAT
- install-scripts = scripts
- install-data = data
-
-Note that these two are *not* equivalent if you supply a different installation
-base directory when you run the setup script. For example, ::
-
- python setup.py install --install-base /tmp
-
-would install pure modules to :file:`{/tmp/python/lib}` in the first case, and
-to :file:`{/tmp/lib}` in the second case. (For the second case, you probably
-want to supply an installation base of :file:`/tmp/python`.)
-
-You probably noticed the use of ``$HOME`` and ``$PLAT`` in the sample
-configuration file input. These are Distutils configuration variables, which
-bear a strong resemblance to environment variables. In fact, you can use
-environment variables in config files on platforms that have such a notion but
-the Distutils additionally define a few extra variables that may not be in your
-environment, such as ``$PLAT``. (And of course, on systems that don't have
-environment variables, such as Mac OS 9, the configuration variables supplied by
-the Distutils are the only ones you can use.) See section :ref:`inst-config-files`
-for details.
-
-.. XXX need some Windows examples---when would custom installation schemes be
- needed on those platforms?
-
-
-.. XXX I'm not sure where this section should go.
-
-.. _inst-search-path:
-
-Modifying Python's Search Path
-------------------------------
-
-When the Python interpreter executes an :keyword:`import` statement, it searches
-for both Python code and extension modules along a search path. A default value
-for the path is configured into the Python binary when the interpreter is built.
-You can determine the path by importing the :mod:`sys` module and printing the
-value of ``sys.path``. ::
-
- $ python
- Python 2.2 (#11, Oct 3 2002, 13:31:27)
- [GCC 2.96 20000731 (Red Hat Linux 7.3 2.96-112)] on linux2
- Type "help", "copyright", "credits" or "license" for more information.
- >>> import sys
- >>> sys.path
- ['', '/usr/local/lib/python2.3', '/usr/local/lib/python2.3/plat-linux2',
- '/usr/local/lib/python2.3/lib-tk', '/usr/local/lib/python2.3/lib-dynload',
- '/usr/local/lib/python2.3/site-packages']
- >>>
-
-The null string in ``sys.path`` represents the current working directory.
-
-The expected convention for locally installed packages is to put them in the
-:file:`{...}/site-packages/` directory, but you may want to install Python
-modules into some arbitrary directory. For example, your site may have a
-convention of keeping all software related to the web server under :file:`/www`.
-Add-on Python modules might then belong in :file:`/www/python`, and in order to
-import them, this directory must be added to ``sys.path``. There are several
-different ways to add the directory.
-
-The most convenient way is to add a path configuration file to a directory
-that's already on Python's path, usually to the :file:`.../site-packages/`
-directory. Path configuration files have an extension of :file:`.pth`, and each
-line must contain a single path that will be appended to ``sys.path``. (Because
-the new paths are appended to ``sys.path``, modules in the added directories
-will not override standard modules. This means you can't use this mechanism for
-installing fixed versions of standard modules.)
-
-Paths can be absolute or relative, in which case they're relative to the
-directory containing the :file:`.pth` file. See the documentation of
-the :mod:`site` module for more information.
-
-A slightly less convenient way is to edit the :file:`site.py` file in Python's
-standard library, and modify ``sys.path``. :file:`site.py` is automatically
-imported when the Python interpreter is executed, unless the :option:`-S` switch
-is supplied to suppress this behaviour. So you could simply edit
-:file:`site.py` and add two lines to it::
-
- import sys
- sys.path.append('/www/python/')
-
-However, if you reinstall the same major version of Python (perhaps when
-upgrading from 2.2 to 2.2.2, for example) :file:`site.py` will be overwritten by
-the stock version. You'd have to remember that it was modified and save a copy
-before doing the installation.
-
-There are two environment variables that can modify ``sys.path``.
-:envvar:`PYTHONHOME` sets an alternate value for the prefix of the Python
-installation. For example, if :envvar:`PYTHONHOME` is set to ``/www/python``,
-the search path will be set to ``['', '/www/python/lib/pythonX.Y/',
-'/www/python/lib/pythonX.Y/plat-linux2', ...]``.
-
-The :envvar:`PYTHONPATH` variable can be set to a list of paths that will be
-added to the beginning of ``sys.path``. For example, if :envvar:`PYTHONPATH` is
-set to ``/www/python:/opt/py``, the search path will begin with
-``['/www/python', '/opt/py']``. (Note that directories must exist in order to
-be added to ``sys.path``; the :mod:`site` module removes paths that don't
-exist.)
-
-Finally, ``sys.path`` is just a regular Python list, so any Python application
-can modify it by adding or removing entries.
-
-
-.. _inst-config-files:
-
-Distutils Configuration Files
-=============================
-
-As mentioned above, you can use Distutils configuration files to record personal
-or site preferences for any Distutils options. That is, any option to any
-command can be stored in one of two or three (depending on your platform)
-configuration files, which will be consulted before the command-line is parsed.
-This means that configuration files will override default values, and the
-command-line will in turn override configuration files. Furthermore, if
-multiple configuration files apply, values from "earlier" files are overridden
-by "later" files.
-
-
-.. _inst-config-filenames:
-
-Location and names of config files
-----------------------------------
-
-The names and locations of the configuration files vary slightly across
-platforms. On Unix and Mac OS X, the three configuration files (in the order
-they are processed) are:
-
-+--------------+----------------------------------------------------------+-------+
-| Type of file | Location and filename | Notes |
-+==============+==========================================================+=======+
-| system | :file:`{prefix}/lib/python{ver}/distutils/distutils.cfg` | \(1) |
-+--------------+----------------------------------------------------------+-------+
-| personal | :file:`$HOME/.pydistutils.cfg` | \(2) |
-+--------------+----------------------------------------------------------+-------+
-| local | :file:`setup.cfg` | \(3) |
-+--------------+----------------------------------------------------------+-------+
-
-And on Windows, the configuration files are:
-
-+--------------+-------------------------------------------------+-------+
-| Type of file | Location and filename | Notes |
-+==============+=================================================+=======+
-| system | :file:`{prefix}\\Lib\\distutils\\distutils.cfg` | \(4) |
-+--------------+-------------------------------------------------+-------+
-| personal | :file:`%HOME%\\pydistutils.cfg` | \(5) |
-+--------------+-------------------------------------------------+-------+
-| local | :file:`setup.cfg` | \(3) |
-+--------------+-------------------------------------------------+-------+
-
-On all platforms, the "personal" file can be temporarily disabled by
-passing the `--no-user-cfg` option.
-
-Notes:
-
-(1)
- Strictly speaking, the system-wide configuration file lives in the directory
- where the Distutils are installed; under Python 1.6 and later on Unix, this
- is as shown. For Python 1.5.2, the Distutils will normally be installed to
- :file:`{prefix}/lib/python1.5/site-packages/distutils`, so the system
- configuration file should be put there under Python 1.5.2.
-
-(2)
- On Unix, if the :envvar:`HOME` environment variable is not defined, the
- user's home directory will be determined with the :func:`getpwuid` function
- from the standard :mod:`pwd` module. This is done by the
- :func:`os.path.expanduser` function used by Distutils.
-
-(3)
- I.e., in the current directory (usually the location of the setup script).
-
-(4)
- (See also note (1).) Python's default installation prefix is
- :file:`C:\\Python`, so the system configuration file is normally
- :file:`C:\\Python\\Lib\\distutils\\distutils.cfg`.
-
-(5)
- On Windows, if the :envvar:`HOME` environment variable is not defined,
- :envvar:`USERPROFILE` then :envvar:`HOMEDRIVE` and :envvar:`HOMEPATH` will
- be tried. This is done by the :func:`os.path.expanduser` function used
- by Distutils.
-
-
-.. _inst-config-syntax:
-
-Syntax of config files
-----------------------
-
-The Distutils configuration files all have the same syntax. The config files
-are grouped into sections. There is one section for each Distutils command,
-plus a ``global`` section for global options that affect every command. Each
-section consists of one option per line, specified as ``option = value``.
-
-For example, the following is a complete config file that just forces all
-commands to run quietly by default::
-
- [global]
- verbose = 0
-
-If this is installed as the system config file, it will affect all processing
-of any Python module distribution by any user on the current system. If it is
-installed as your personal config file (on systems that support them), it will
-affect only module distributions processed by you. And if it is used as the
-:file:`setup.cfg` for a particular module distribution, it affects only that
-distribution.
-
-You could override the default "build base" directory and make the
-:command:`build\*` commands always forcibly rebuild all files with the
-following::
-
- [build]
- build-base = blib
- force = 1
-
-which corresponds to the command-line arguments ::
-
- python setup.py build --build-base blib --force
-
-except that including the :command:`build` command on the command-line means
-that command will be run. Including a particular command in config files has no
-such implication; it only means that if the command is run, the options in the
-config file will apply. (Or if other commands that derive values from it are
-run, they will use the values in the config file.)
-
-You can find out the complete list of options for any command using the
-:option:`--help` option, e.g.::
-
- python setup.py build --help
-
-and you can find out the complete list of global options by using
-:option:`--help` without a command::
-
- python setup.py --help
-
-See also the "Reference" section of the "Distributing Python Modules" manual.
-
-
-.. _inst-building-ext:
-
-Building Extensions: Tips and Tricks
-====================================
-
-Whenever possible, the Distutils try to use the configuration information made
-available by the Python interpreter used to run the :file:`setup.py` script.
-For example, the same compiler and linker flags used to compile Python will also
-be used for compiling extensions. Usually this will work well, but in
-complicated situations this might be inappropriate. This section discusses how
-to override the usual Distutils behaviour.
-
-
-.. _inst-tweak-flags:
-
-Tweaking compiler/linker flags
-------------------------------
-
-Compiling a Python extension written in C or C++ will sometimes require
-specifying custom flags for the compiler and linker in order to use a particular
-library or produce a special kind of object code. This is especially true if the
-extension hasn't been tested on your platform, or if you're trying to
-cross-compile Python.
-
-.. TODO update to new setup.cfg
-
-In the most general case, the extension author might have foreseen that
-compiling the extensions would be complicated, and provided a :file:`Setup` file
-for you to edit. This will likely only be done if the module distribution
-contains many separate extension modules, or if they often require elaborate
-sets of compiler flags in order to work.
-
-A :file:`Setup` file, if present, is parsed in order to get a list of extensions
-to build. Each line in a :file:`Setup` describes a single module. Lines have
-the following structure::
-
- module ... [sourcefile ...] [cpparg ...] [library ...]
-
-
-Let's examine each of the fields in turn.
-
-* *module* is the name of the extension module to be built, and should be a
- valid Python identifier. You can't just change this in order to rename a module
- (edits to the source code would also be needed), so this should be left alone.
-
-* *sourcefile* is anything that's likely to be a source code file, at least
- judging by the filename. Filenames ending in :file:`.c` are assumed to be
- written in C, filenames ending in :file:`.C`, :file:`.cc`, and :file:`.c++` are
- assumed to be C++, and filenames ending in :file:`.m` or :file:`.mm` are assumed
- to be in Objective C.
-
-* *cpparg* is an argument for the C preprocessor, and is anything starting with
- :option:`-I`, :option:`-D`, :option:`-U` or :option:`-C`.
-
-* *library* is anything ending in :file:`.a` or beginning with :option:`-l` or
- :option:`-L`.
-
-If a particular platform requires a special library on your platform, you can
-add it by editing the :file:`Setup` file and running ``python setup.py build``.
-For example, if the module defined by the line ::
-
- foo foomodule.c
-
-must be linked with the math library :file:`libm.a` on your platform, simply add
-:option:`-lm` to the line::
-
- foo foomodule.c -lm
-
-Arbitrary switches intended for the compiler or the linker can be supplied with
-the :option:`-Xcompiler` *arg* and :option:`-Xlinker` *arg* options::
-
- foo foomodule.c -Xcompiler -o32 -Xlinker -shared -lm
-
-The next option after :option:`-Xcompiler` and :option:`-Xlinker` will be
-appended to the proper command line, so in the above example the compiler will
-be passed the :option:`-o32` option, and the linker will be passed
-:option:`-shared`. If a compiler option requires an argument, you'll have to
-supply multiple :option:`-Xcompiler` options; for example, to pass ``-x c++``
-the :file:`Setup` file would have to contain ``-Xcompiler -x -Xcompiler c++``.
-
-Compiler flags can also be supplied through setting the :envvar:`CFLAGS`
-environment variable. If set, the contents of :envvar:`CFLAGS` will be added to
-the compiler flags specified in the :file:`Setup` file.
-
-
-.. _inst-non-ms-compilers:
-
-Using non-Microsoft compilers on Windows
-----------------------------------------
-
-.. sectionauthor:: Rene Liebscher <R.Liebscher at gmx.de>
-
-
-
-Borland/CodeGear C++
-^^^^^^^^^^^^^^^^^^^^
-
-This subsection describes the necessary steps to use Distutils with the Borland
-C++ compiler version 5.5. First you have to know that Borland's object file
-format (OMF) is different from the format used by the Python version you can
-download from the Python or ActiveState Web site. (Python is built with
-Microsoft Visual C++, which uses COFF as the object file format.) For this
-reason you have to convert Python's library :file:`python25.lib` into the
-Borland format. You can do this as follows:
-
-.. Should we mention that users have to create cfg-files for the compiler?
-.. see also http://community.borland.com/article/0,1410,21205,00.html
-
-::
-
- coff2omf python25.lib python25_bcpp.lib
-
-The :file:`coff2omf` program comes with the Borland compiler. The file
-:file:`python25.lib` is in the :file:`Libs` directory of your Python
-installation. If your extension uses other libraries (zlib, ...) you have to
-convert them too.
-
-The converted files have to reside in the same directories as the normal
-libraries.
-
-How does Distutils manage to use these libraries with their changed names? If
-the extension needs a library (eg. :file:`foo`) Distutils checks first if it
-finds a library with suffix :file:`_bcpp` (eg. :file:`foo_bcpp.lib`) and then
-uses this library. In the case it doesn't find such a special library it uses
-the default name (:file:`foo.lib`.) [#]_
-
-To let Distutils compile your extension with Borland C++ you now have to type::
-
- python setup.py build --compiler bcpp
-
-If you want to use the Borland C++ compiler as the default, you could specify
-this in your personal or system-wide configuration file for Distutils (see
-section :ref:`inst-config-files`.)
-
-
-.. seealso::
-
- `C++Builder Compiler <http://www.codegear.com/downloads/free/cppbuilder>`_
- Information about the free C++ compiler from Borland, including links to the
- download pages.
-
- `Creating Python Extensions Using Borland's Free Compiler <http://www.cyberus.ca/~g_will/pyExtenDL.shtml>`_
- Document describing how to use Borland's free command-line C++ compiler to build
- Python.
-
-
-GNU C / Cygwin / MinGW
-^^^^^^^^^^^^^^^^^^^^^^
-
-This section describes the necessary steps to use Distutils with the GNU C/C++
-compilers in their Cygwin and MinGW distributions. [#]_ For a Python interpreter
-that was built with Cygwin, everything should work without any of these
-following steps.
-
-Not all extensions can be built with MinGW or Cygwin, but many can. Extensions
-most likely to not work are those that use C++ or depend on Microsoft Visual C
-extensions.
-
-To let Distutils compile your extension with Cygwin you have to type::
-
- python setup.py build --compiler=cygwin
-
-and for Cygwin in no-cygwin mode [#]_ or for MinGW type::
-
- python setup.py build --compiler=mingw32
-
-If you want to use any of these options/compilers as default, you should
-consider writing it in your personal or system-wide configuration file for
-Distutils (see section :ref:`inst-config-files`.)
-
-Older Versions of Python and MinGW
-""""""""""""""""""""""""""""""""""
-The following instructions only apply if you're using a version of Python
-inferior to 2.4.1 with a MinGW inferior to 3.0.0 (with
-binutils-2.13.90-20030111-1).
-
-These compilers require some special libraries. This task is more complex than
-for Borland's C++, because there is no program to convert the library. First
-you have to create a list of symbols which the Python DLL exports. (You can find
-a good program for this task at
-http://www.emmestech.com/software/pexports-0.43/download_pexports.html).
-
-.. I don't understand what the next line means. --amk
-.. (inclusive the references on data structures.)
-
-::
-
- pexports python25.dll > python25.def
-
-The location of an installed :file:`python25.dll` will depend on the
-installation options and the version and language of Windows. In a "just for
-me" installation, it will appear in the root of the installation directory. In
-a shared installation, it will be located in the system directory.
-
-Then you can create from these information an import library for gcc. ::
-
- /cygwin/bin/dlltool --dllname python25.dll --def python25.def --output-lib libpython25.a
-
-The resulting library has to be placed in the same directory as
-:file:`python25.lib`. (Should be the :file:`libs` directory under your Python
-installation directory.)
-
-If your extension uses other libraries (zlib,...) you might have to convert
-them too. The converted files have to reside in the same directories as the
-normal libraries do.
-
-
-.. seealso::
-
- `Building Python modules on MS Windows platform with MinGW <http://www.zope.org/Members/als/tips/win32_mingw_modules>`_
- Information about building the required libraries for the MinGW
- environment.
-
-
-.. rubric:: Footnotes
-
-.. [#] This also means you could replace all existing COFF-libraries with
- OMF-libraries of the same name.
-
-.. [#] Check http://sources.redhat.com/cygwin/ and http://www.mingw.org/ for
- more information
-
-.. [#] Then you have no POSIX emulation available, but you also don't need
- :file:`cygwin1.dll`.
diff --git a/docs/source/library/distutils2.depgraph.rst b/docs/source/library/distutils2.depgraph.rst
deleted file mode 100644
--- a/docs/source/library/distutils2.depgraph.rst
+++ /dev/null
@@ -1,125 +0,0 @@
-===============================
-Dependency Graph Builder Module
-===============================
-
-Introduction
-------------
-
-This module provides the means to analyse the dependencies between various
-distributions and furthermore to create a graph representing the relationships
-from a list of :class:`distutils2._backport.pkgutil.Distribution` and
-:class:`distutils2._backport.pkgutil.EggInfoDistribution` instances. The graph
-is represented by the :class:`distutils2.depgraph.DependencyGraph` class that
-keeps internally an adjacency list. Several functions are provided that
-generate a graph in different manners. First, all of them are documented and
-then several use case examples are provided along with
-`graphviz <http://www.graphviz.org/>`_ illustrations
-of the generated graphs.
-
-API
----
-
-.. automodule:: distutils2.depgraph
- :members:
-
-Example Usage
--------------
-
-Depict all Dependenciess in the System
-++++++++++++++++++++++++++++++++++++++
-
-First, we shall generate a graph of all the distributions on the system
-and then create an image out of it using the tools provided by
-`graphviz <http://www.graphviz.org/>`_. For obtaining the list of
-installed distributions, we will use the functions provided by the module
-:mod:`distutils2._backport.pkgutil`::
-
- from distutils2._backport.pkgutil import get_distributions
- from distutils2.depgraph import generate_graph
-
- dists = list(pkgutil.get_distributions())
- graph = generate_graph(dists)
-
-Now, it would be of interest to print out the missing requirements. This
-can be done as follows::
-
- for dist, reqs in graph.missing.iteritems():
- if len(reqs) > 0:
- reqs_s = " ,".join(reqs)
- print("Missing dependencies for %s: %s" % (dist.name, reqs_s))
-
-Example output on my configuration is:
-
-.. code-block:: none
-
- Missing dependencies for TurboCheetah: Cheetah
- Missing dependencies for TurboGears: ConfigObj, DecoratorTools, RuleDispatch
- Missing dependencies for jockey: PyKDE4.kdecore, PyKDE4.kdeui, PyQt4.QtCore, PyQt4.QtGui
- Missing dependencies for TurboKid: kid
- Missing dependencies for TurboJson: DecoratorTools, RuleDispatch
-
-Now, we proceed with generating a graphical representation of the graph. First
-we write it to a file, and then we generate a PNG image using the ``dot``
-command-line tool::
-
- from distutils2.depgraph import graph_to_dot
- f = open('output.dot', 'w')
- # we only show the interesting distributions, skipping the disconnected ones
- graph_to_dot(graph, f, skip_disconnected=True)
-
-Now, we can create the actual picture using:
-
-.. code-block:: bash
-
- $ dot -Tpng output.dot > output.png
-
-An example output image is:
-
-.. figure:: ../images/depgraph_output.png
- :alt: An example dot output
-
-If you want to include ``.egg`` and ``.egg-info`` distributions as well, then
-the code requires only one change, namely the line::
-
- dists = list(pkgutil.get_distributions())
-
-has to be replaced with::
-
- dists = list(pkgutil.get_distributions(use_egg_info=True))
-
-Then, on most platforms, a richer graph is obtained because at the moment most
-distributions are provided in the ``.egg``/``.egg-info`` rather than the
-``.dist-info`` format. An example of a more involved graph for illustrative
-reasons can be seen `here <_static/depgraph_big.png>`_.
-
-
-List all Dependent Distributions
-++++++++++++++++++++++++++++++++
-
-We will list all distributions that are dependent on some given distibution.
-This time, ``.egg``/``.egg-info`` distributions will be considered as well::
-
- from distutils2._backport.pkgutil import get_distributions
- from distutils2.depgraph import dependent_dists
- import sys
-
- dists = list(get_distributions(use_egg_info=True))
- dist = None
- for d in dists:
- if d.name == 'bacon':
- dist = d
- break
- if dist is None:
- print('No such distribution in the system')
- sys.exit(1)
- deps = dependent_dists(dists, dist)
- deps_s = ", ".join([x.name for x in deps])
- print("The following distributions depend on %s: %s" % (dist.name, deps_s))
-
-And this is example output with the dependency relationships as in the
-`previous section <_static/depgraph_big.png>`_:
-
-.. code-block:: none
-
- The following distributions depend on bacon: towel-stuff, choxie, grammar
-
diff --git a/docs/source/library/distutils2.index.client.rst b/docs/source/library/distutils2.index.client.rst
deleted file mode 100644
--- a/docs/source/library/distutils2.index.client.rst
+++ /dev/null
@@ -1,20 +0,0 @@
-===============================
-High level API to Query indexes
-===============================
-
-Distutils2 provides a high level API to query indexes, search for releases and
-distributions, no matters the underlying API you want to use.
-
-The aim of this module is to choose the best way to query the API, using the
-less possible XML-RPC, and when possible the simple index.
-
-API
-===
-
-The client comes with the common methods "find_projects", "get_release" and
-"get_releases", which helps to query the servers, and returns
-:class:`distutils2.index.dist.ReleaseInfo`, and
-:class:`distutils2.index.dist.ReleasesList` objects.
-
-.. autoclass:: distutils2.index.wrapper.ClientWrapper
- :members:
diff --git a/docs/source/library/distutils2.index.dist.rst b/docs/source/library/distutils2.index.dist.rst
deleted file mode 100644
--- a/docs/source/library/distutils2.index.dist.rst
+++ /dev/null
@@ -1,112 +0,0 @@
-==================================================
-Representation of informations coming from indexes
-==================================================
-
-Informations coming from indexes are represented by the classes present in the
-:mod:`distutils2.index.dist` module.
-
-API
-===
-
-Keep in mind that each project (eg. FooBar) can have several releases
-(eg. 1.1, 1.2, 1.3), and each of these releases can be provided in multiple
-distributions (eg. a source distribution, a binary one, etc).
-
-ReleaseInfo
-------------
-
-Each release have a project name, a project version and contain project
-metadata. In addition, releases contain the distributions too.
-
-These informations are stored in :class:`distutils2.index.dist.ReleaseInfo`
-objects.
-
-.. autoclass:: distutils2.index.dist.ReleaseInfo
- :members:
-
-DistInfo
----------
-
-:class:`distutils2.index.dist.DistInfo` is a simple class that contains
-informations related to distributions. It's mainly about the URLs where those
-distributions can be found.
-
-.. autoclass:: distutils2.index.dist.DistInfo
- :members:
-
-ReleasesList
-------------
-
-The :mod:`~distutils2.index.dist` module also provides another class, to work
-with lists of :class:`distutils2.index.dist.ReleaseInfo` classes. It allow to
-filter and order results.
-
-.. autoclass:: distutils2.index.dist.ReleasesList
- :members:
-
-Exemple usages
-===============
-
-Build a list of releases, and order them
-----------------------------------------
-
-Assuming we have a list of releases::
-
- >>> from distutils2.index.dist import ReleaseList, ReleaseInfo
- >>> fb10 = ReleaseInfo("FooBar", "1.0")
- >>> fb11 = ReleaseInfo("FooBar", "1.1")
- >>> fb11a = ReleaseInfo("FooBar", "1.1a1")
- >>> ReleasesList("FooBar", [fb11, fb11a, fb10])
- >>> releases.sort_releases()
- >>> releases.get_versions()
- ['1.1', '1.1a1', '1.0']
- >>> releases.add_release("1.2a1")
- >>> releases.get_versions()
- ['1.1', '1.1a1', '1.0', '1.2a1']
- >>> releases.sort_releases()
- ['1.2a1', '1.1', '1.1a1', '1.0']
- >>> releases.sort_releases(prefer_final=True)
- >>> releases.get_versions()
- ['1.1', '1.0', '1.2a1', '1.1a1']
-
-
-Add distribution related informations to releases
--------------------------------------------------
-
-It's easy to add distribution informatons to releases::
-
- >>> from distutils2.index.dist import ReleaseList, ReleaseInfo
- >>> r = ReleaseInfo("FooBar", "1.0")
- >>> r.add_distribution("sdist", url="http://example.org/foobar-1.0.tar.gz")
- >>> r.dists
- {'sdist': FooBar 1.0 sdist}
- >>> r['sdist'].url
- {'url': 'http://example.org/foobar-1.0.tar.gz', 'hashname': None, 'hashval':
- None, 'is_external': True}
-
-Getting attributes from the dist objects
------------------------------------------
-
-To abstract a maximum the way of querying informations to the indexes,
-attributes and releases informations can be retrieved directly from the objects
-returned by the indexes.
-
-For instance, if you have a release instance that does not contain the metadata
-attribute, it can be fetched by using the "fetch_metadata" method::
-
- >>> r = Release("FooBar", "1.1")
- >>> print r.metadata
- None # metadata field is actually set to "None"
- >>> r.fetch_metadata()
- <Metadata for FooBar 1.1>
-
-.. XXX add proper roles to these constructs
-
-Like this, it's possible to retrieve project's releases (`fetch_releases`),
-releases metadata (`fetch_metadata` and releases distributions
-(`fetch_distributions` informations).
-
-Internally, this is possible because while retrieving for the first time
-informations about projects, releases or distributions, a reference to the
-client used is stored in the objects (can be accessed using the object
-`_index` attribute.
diff --git a/docs/source/library/distutils2.index.rst b/docs/source/library/distutils2.index.rst
deleted file mode 100644
--- a/docs/source/library/distutils2.index.rst
+++ /dev/null
@@ -1,31 +0,0 @@
-===================================
-Query Python Package Indexes (PyPI)
-===================================
-
-Distutils2 queries PyPI to get information about projects or download those
-projects. The low-level facilities used internally are also part of the public
-API destined to be used by other tools.
-
-The :mod:`distutils2.index` package provides those facilities, which can be
-used to access informations about Python projects registered at indexes, the
-main one being PyPI, located ad http://pypi.python.org/.
-
-There is two ways to retrieve data from these indexes: using the *simple* API,
-and using *XML-RPC*. The first one is a set of HTML pages avalaibles at
-`http://pypi.python.org/simple/`, and the second one contains a set of XML-RPC
-methods. Mirrors typically implement the simple interface.
-
-If you dont care about which API to use, the best thing to do is to let
-distutils2 decide this for you, by using :class:`distutils2.index.ClientWrapper`.
-
-Of course, you can rely too on :class:`distutils2.index.simple.Crawler` and
-:class:`distutils2.index.xmlrpc.Client` if you need to use a specific API.
-
-.. toctree::
- :maxdepth: 2
- :numbered:
-
- distutils2.index.client
- distutils2.index.dist
- distutils2.index.simple
- distutils2.index.xmlrpc
diff --git a/docs/source/library/distutils2.index.simple.rst b/docs/source/library/distutils2.index.simple.rst
deleted file mode 100644
--- a/docs/source/library/distutils2.index.simple.rst
+++ /dev/null
@@ -1,143 +0,0 @@
-=========================================
-Querying indexes via the simple index API
-=========================================
-
-`distutils2.index.simple` can process Python Package Indexes, and provides
-useful informations about distributions. It also can crawl local indexes, for
-instance.
-
-You should use `distutils2.index.simple` for:
-
- * Search distributions by name and versions.
- * Process index external pages.
- * Download distributions by name and versions.
-
-And should not be used to:
-
- * Things that will end up in too long index processing (like "finding all
- distributions with a specific version, no matters the name")
-
-API
----
-
-.. autoclass:: distutils2.index.simple.Crawler
- :members:
-
-
-Usage Exemples
----------------
-
-To help you understand how using the `Crawler` class, here are some basic
-usages.
-
-Request the simple index to get a specific distribution
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++
-
-Supposing you want to scan an index to get a list of distributions for
-the "foobar" project. You can use the "get_releases" method for that.
-The get_releases method will browse the project page, and return :class:`ReleaseInfo`
-objects for each found link that rely on downloads. ::
-
- >>> from distutils2.index.simple import Crawler
- >>> crawler = Crawler()
- >>> crawler.get_releases("FooBar")
- [<ReleaseInfo "Foobar 1.1">, <ReleaseInfo "Foobar 1.2">]
-
-Note that you also can request the client about specific versions, using version
-specifiers (described in `PEP 345
-<http://www.python.org/dev/peps/pep-0345/#version-specifiers>`_)::
-
- >>> client.get_releases("FooBar < 1.2")
- [<ReleaseInfo "FooBar 1.1">, ]
-
-`get_releases` returns a list of :class:`ReleaseInfo`, but you also can get the best
-distribution that fullfil your requirements, using "get_release"::
-
- >>> client.get_release("FooBar < 1.2")
- <ReleaseInfo "FooBar 1.1">
-
-Download distributions
-+++++++++++++++++++++++
-
-As it can get the urls of distributions provided by PyPI, the `Crawler`
-client also can download the distributions and put it for you in a temporary
-destination::
-
- >>> client.download("foobar")
- /tmp/temp_dir/foobar-1.2.tar.gz
-
-You also can specify the directory you want to download to::
-
- >>> client.download("foobar", "/path/to/my/dir")
- /path/to/my/dir/foobar-1.2.tar.gz
-
-While downloading, the md5 of the archive will be checked, if not matches, it
-will try another time, then if fails again, raise `MD5HashDoesNotMatchError`.
-
-Internally, that's not the Crawler which download the distributions, but the
-`DistributionInfo` class. Please refer to this documentation for more details.
-
-Following PyPI external links
-++++++++++++++++++++++++++++++
-
-The default behavior for distutils2 is to *not* follow the links provided
-by HTML pages in the "simple index", to find distributions related
-downloads.
-
-It's possible to tell the PyPIClient to follow external links by setting the
-`follow_externals` attribute, on instantiation or after::
-
- >>> client = Crawler(follow_externals=True)
-
-or ::
-
- >>> client = Crawler()
- >>> client.follow_externals = True
-
-Working with external indexes, and mirrors
-+++++++++++++++++++++++++++++++++++++++++++
-
-The default `Crawler` behavior is to rely on the Python Package index stored
-on PyPI (http://pypi.python.org/simple).
-
-As you can need to work with a local index, or private indexes, you can specify
-it using the index_url parameter::
-
- >>> client = Crawler(index_url="file://filesystem/path/")
-
-or ::
-
- >>> client = Crawler(index_url="http://some.specific.url/")
-
-You also can specify mirrors to fallback on in case the first index_url you
-provided doesnt respond, or not correctly. The default behavior for
-`Crawler` is to use the list provided by Python.org DNS records, as
-described in the :PEP:`381` about mirroring infrastructure.
-
-If you don't want to rely on these, you could specify the list of mirrors you
-want to try by specifying the `mirrors` attribute. It's a simple iterable::
-
- >>> mirrors = ["http://first.mirror","http://second.mirror"]
- >>> client = Crawler(mirrors=mirrors)
-
-Searching in the simple index
-+++++++++++++++++++++++++++++
-
-It's possible to search for projects with specific names in the package index.
-Assuming you want to find all projects containing the "distutils" keyword::
-
- >>> c.search_projects("distutils")
- [<Project "collective.recipe.distutils">, <Project "Distutils">, <Project
- "Distutils2">, <Project "distutilscross">, <Project "lpdistutils">, <Project
- "taras.recipe.distutils">, <Project "zerokspot.recipe.distutils">]
-
-You can also search the projects starting with a specific text, or ending with
-that text, using a wildcard.::
-
- >>> c.search_projects("distutils*")
- [<Project "Distutils">, <Project "Distutils2">, <Project "distutilscross">]
-
- >>> c.search_projects("*distutils")
- [<Project "collective.recipe.distutils">, <Project "Distutils">, <Project
- "lpdistutils">, <Project "taras.recipe.distutils">, <Project
- "zerokspot.recipe.distutils">]
diff --git a/docs/source/library/distutils2.index.xmlrpc.rst b/docs/source/library/distutils2.index.xmlrpc.rst
deleted file mode 100644
--- a/docs/source/library/distutils2.index.xmlrpc.rst
+++ /dev/null
@@ -1,128 +0,0 @@
-=========================
-Query indexes via XML-RPC
-=========================
-
-Indexes can be queried using XML-RPC calls, and Distutils2 provides a simple
-way to interface with XML-RPC.
-
-You should **use** XML-RPC when:
-
- * Searching the index for projects **on other fields than project
- names**. For instance, you can search for projects based on the
- author_email field.
- * Searching all the versions that have existed for a project.
- * you want to retrive METADATAs informations from releases or
- distributions.
-
-You should **avoid using** XML-RPC method calls when:
-
- * Retrieving the last version of a project
- * Getting the projects with a specific name and version.
- * The simple index can match your needs
-
-When dealing with indexes, keep in mind that the index queriers will always
-return you :class:`distutils2.index.ReleaseInfo` and
-:class:`distutils2.index.ReleasesList` objects.
-
-Some methods here share common APIs with the one you can find on
-:class:`distutils2.index.simple`, internally, :class:`distutils2.index.client`
-is inherited by :class:`distutils2.index.xmlrpc.Client`
-
-API
-====
-
-.. autoclass:: distutils2.index.xmlrpc.Client
- :members:
-
-Usage examples
-===============
-
-Use case described here are use case that are not common to the other clients.
-If you want to see all the methods, please refer to API or to usage examples
-described in :class:`distutils2.index.client.Client`
-
-Finding releases
-----------------
-
-It's a common use case to search for "things" within the index.
-We can basically search for projects by their name, which is the
-most used way for users (eg. "give me the last version of the FooBar project").
-This can be accomplished using the following syntax::
-
- >>> client = xmlrpc.Client()
- >>> client.get_release("Foobar (<= 1.3))
- <FooBar 1.2.1>
- >>> client.get_releases("FooBar (<= 1.3)")
- [FooBar 1.1, FooBar 1.1.1, FooBar 1.2, FooBar 1.2.1]
-
-And we also can find for specific fields::
-
- >>> client.search_projects(field=value)
-
-You could specify the operator to use, default is "or"::
-
- >>> client.search_projects(field=value, operator="and")
-
-The specific fields you can search are:
-
- * name
- * version
- * author
- * author_email
- * maintainer
- * maintainer_email
- * home_page
- * license
- * summary
- * description
- * keywords
- * platform
- * download_url
-
-Getting metadata informations
------------------------------
-
-XML-RPC is a prefered way to retrieve metadata informations from indexes.
-It's really simple to do so::
-
- >>> client = xmlrpc.Client()
- >>> client.get_metadata("FooBar", "1.1")
- <ReleaseInfo FooBar 1.1>
-
-Assuming we already have a :class:`distutils2.index.ReleaseInfo` object defined,
-it's possible to pass it ot the xmlrpc client to retrieve and complete its
-metadata::
-
- >>> foobar11 = ReleaseInfo("FooBar", "1.1")
- >>> client = xmlrpc.Client()
- >>> returned_release = client.get_metadata(release=foobar11)
- >>> returned_release
- <ReleaseInfo FooBar 1.1>
-
-Get all the releases of a project
----------------------------------
-
-To retrieve all the releases for a project, you can build them using
-`get_releases`::
-
- >>> client = xmlrpc.Client()
- >>> client.get_releases("FooBar")
- [<ReleaseInfo FooBar 0.9>, <ReleaseInfo FooBar 1.0>, <ReleaseInfo 1.1>]
-
-Get informations about distributions
-------------------------------------
-
-Indexes have informations about projects, releases **and** distributions.
-If you're not familiar with those, please refer to the documentation of
-:mod:`distutils2.index.dist`.
-
-It's possible to retrive informations about distributions, e.g "what are the
-existing distributions for this release ? How to retrieve them ?"::
-
- >>> client = xmlrpc.Client()
- >>> release = client.get_distributions("FooBar", "1.1")
- >>> release.dists
- {'sdist': <FooBar 1.1 sdist>, 'bdist': <FooBar 1.1 bdist>}
-
-As you see, this does not return a list of distributions, but a release,
-because a release can be used like a list of distributions.
diff --git a/docs/source/library/distutils2.install.rst b/docs/source/library/distutils2.install.rst
deleted file mode 100644
--- a/docs/source/library/distutils2.install.rst
+++ /dev/null
@@ -1,25 +0,0 @@
-==================
-Installation tools
-==================
-
-In addition to the install commands, distutils2 provides a set of tools to deal
-with installation of distributions.
-
-Basically, they're intended to download the distribution from indexes, to
-resolve the dependencies, and to provide a safe way to install all the
-distributions.
-
-You can find those tools in :module distutils2.install_tools:.
-
-
-API
----
-
-.. automodule:: distutils2.install
- :members:
-
-Example usage
---------------
-
-Get the scheme of what's gonna be installed if we install "foobar":
-
diff --git a/docs/source/library/distutils2.metadata.rst b/docs/source/library/distutils2.metadata.rst
deleted file mode 100644
--- a/docs/source/library/distutils2.metadata.rst
+++ /dev/null
@@ -1,93 +0,0 @@
-========
-Metadata
-========
-
-.. module:: distutils2.metadata
-
-Distutils2 provides a :class:`~distutils2.metadata.Metadata` class that can read and
-write metadata files. This class is compatible with all metadata versions:
-
-* 1.0: :PEP:`241`
-* 1.1: :PEP:`314`
-* 1.2: :PEP:`345`
-
-The :PEP:`345` implementation supports the micro-language for the environment
-markers, and displays warnings when versions that are supposed to be
-:PEP:`386` are violating the scheme.
-
-
-Reading metadata
-================
-
-The :class:`~distutils2.metadata.Metadata` class can be instantiated with the path of
-the metadata file, and provides a dict-like interface to the values::
-
- >>> from distutils2.metadata import Metadata
- >>> metadata = Metadata('PKG-INFO')
- >>> metadata.keys()[:5]
- ('Metadata-Version', 'Name', 'Version', 'Platform', 'Supported-Platform')
- >>> metadata['Name']
- 'CLVault'
- >>> metadata['Version']
- '0.5'
- >>> metadata['Requires-Dist']
- ["pywin32; sys.platform == 'win32'", "Sphinx"]
-
-The fields that supports environment markers can be automatically ignored if
-the object is instantiated using the ``platform_dependent`` option.
-:class:`~distutils2.metadata.Metadata` will interpret in the case the markers and will
-automatically remove the fields that are not compliant with the running
-environment. Here's an example under Mac OS X. The win32 dependency
-we saw earlier is ignored::
-
- >>> from distutils2.metadata import Metadata
- >>> metadata = Metadata('PKG-INFO', platform_dependent=True)
- >>> metadata['Requires-Dist']
- ['bar']
-
-If you want to provide your own execution context, let's say to test the
-metadata under a particular environment that is not the current environment,
-you can provide your own values in the ``execution_context`` option, which
-is the dict that may contain one or more keys of the context the micro-language
-expects.
-
-Here's an example, simulating a win32 environment::
-
- >>> from distutils2.metadata import Metadata
- >>> context = {'sys.platform': 'win32'}
- >>> metadata = Metadata('PKG-INFO', platform_dependent=True,
- ... execution_context=context)
- ...
- >>> metadata['Requires-Dist'] = ["pywin32; sys.platform == 'win32'",
- ... "Sphinx"]
- ...
- >>> metadata['Requires-Dist']
- ['pywin32', 'Sphinx']
-
-
-Writing metadata
-================
-
-Writing metadata can be done using the ``write`` API::
-
- >>> metadata.write('/to/my/PKG-INFO')
-
-The class will pick the best version for the metadata, depending on the values
-provided. If all the values provided exist in all versions, the class will
-use :attr:`metadata.PKG_INFO_PREFERRED_VERSION`. It is set by default to 1.0.
-
-
-Conflict checking and best version
-==================================
-
-Some fields in :PEP:`345` have to follow a version scheme in their versions
-predicate. When the scheme is violated, a warning is emitted::
-
- >>> from distutils2.metadata import Metadata
- >>> metadata = Metadata()
- >>> metadata['Requires-Dist'] = ['Funky (Groovie)']
- "Funky (Groovie)" is not a valid predicate
- >>> metadata['Requires-Dist'] = ['Funky (1.2)']
-
-
-.. TODO talk about check()
diff --git a/docs/source/library/distutils2.rst b/docs/source/library/distutils2.rst
deleted file mode 100644
--- a/docs/source/library/distutils2.rst
+++ /dev/null
@@ -1,44 +0,0 @@
-:mod:`distutils2` --- Packaging support
-=======================================
-
-.. module:: distutils2
- :synopsis: Packaging system and building blocks for other packaging systems
-.. sectionauthor:: Distutils2 contributors
-
-
-The :mod:`distutils2` package provides support for building, packaging,
-distributing and installing additional projects into a Python installation.
-Projects may be include modules, extension modules, packages and scripts.
-:mod:`distutils2` also provides building blocks for other packaging systems
-that do not use the command system.
-
-This manual is the reference documentation for those standalone building
-blocks and for extending Distutils2. If you're looking for the user-centric
-guides to install a project or package your own code, head to `See also`__.
-
-
-.. toctree::
- :maxdepth: 2
- :numbered:
-
- distutils2.version
- distutils2.metadata
- distutils2.depgraph
- distutils2.install
- distutils2.index
- distutils2.tests.pypi_server
-
-
-.. __:
-
-.. seealso::
-
- :doc:`../distutils/index`
- The manual for developers of Python projects who want to package and
- distribute them. This describes how to use :mod:`distutils2` to make
- projects easily found and added to an existing Python installation.
-
- :doc:`../install/index`
- A user-centered manual which includes information on adding projects
- into an existing Python installation. You do not need to be a Python
- programmer to read this manual.
diff --git a/docs/source/library/distutils2.tests.pypi_server.rst b/docs/source/library/distutils2.tests.pypi_server.rst
deleted file mode 100644
--- a/docs/source/library/distutils2.tests.pypi_server.rst
+++ /dev/null
@@ -1,89 +0,0 @@
-==============
-Test Framework
-==============
-
-When you are testing code that works with distutils, you might find these tools
-useful.
-
-``PyPIServer``
-==============
-
-PyPIServer is a class that implements an HTTP server running in a separate
-thread. All it does is record the requests for further inspection. The recorded
-data is available under ``requests`` attribute. The default
-HTTP response can be overriden with the ``default_response_status``,
-``default_response_headers`` and ``default_response_data`` attributes.
-
-By default, when accessing the server with urls beginning with `/simple/`,
-the server also record your requests, but will look for files under
-the `/tests/pypiserver/simple/` path.
-
-You can tell the sever to serve static files for other paths. This could be
-accomplished by using the `static_uri_paths` parameter, as below::
-
- server = PyPIServer(static_uri_paths=["first_path", "second_path"])
-
-You need to create the content that will be served under the
-`/tests/pypiserver/default` path. If you want to serve content from another
-place, you also can specify another filesystem path (wich need to be under
-`tests/pypiserver/`. This will replace the default behavior of the server, and
-it will not serve content from the `default` dir ::
-
- server = PyPIServer(static_filesystem_paths=["path/to/your/dir"])
-
-If you just need to add some paths to the existing ones, you can do as shown,
-keeping in mind that the server will alwas try to load paths in reverse order
-(e.g here, try "another/super/path" then the default one) ::
-
- server = PyPIServer(test_static_path="another/super/path")
- server = PyPIServer("another/super/path")
- # or
- server.static_filesystem_paths.append("another/super/path")
-
-As a result of what, in your tests, while you need to use the PyPIServer, in
-order to isolates the test cases, the best practice is to place the common files
-in the `default` folder, and to create a directory for each specific test case::
-
- server = PyPIServer(static_filesystem_paths = ["default", "test_pypi_server"],
- static_uri_paths=["simple", "external"])
-
-``PyPIServerTestCase``
-======================
-
-``PyPIServerTestCase`` is a test case class with setUp and tearDown methods that
-take care of a single PyPIServer instance attached as a ``pypi`` attribute on
-the test class. Use it as one of the base classes in your test case::
-
- class UploadTestCase(PyPIServerTestCase):
- def test_something(self):
- cmd = self.prepare_command()
- cmd.ensure_finalized()
- cmd.repository = self.pypi.full_address
- cmd.run()
-
- environ, request_data = self.pypi.requests[-1]
- self.assertEqual(request_data, EXPECTED_REQUEST_DATA)
-
-The ``use_pypi_server`` decorator
-=================================
-
-You also can use a decorator for your tests, if you do not need the same server
-instance along all you test case. So, you can specify, for each test method,
-some initialisation parameters for the server.
-
-For this, you need to add a `server` parameter to your method, like this::
-
- class SampleTestCase(TestCase):
- @use_pypi_server()
- def test_somthing(self, server):
- # your tests goes here
- ...
-
-The decorator will instantiate the server for you, and run and stop it just
-before and after your method call. You also can pass the server initializer,
-just like this::
-
- class SampleTestCase(TestCase):
- @use_pypi_server("test_case_name")
- def test_something(self, server):
- ...
diff --git a/docs/source/library/distutils2.version.rst b/docs/source/library/distutils2.version.rst
deleted file mode 100644
--- a/docs/source/library/distutils2.version.rst
+++ /dev/null
@@ -1,70 +0,0 @@
-======================
-Working with versions
-======================
-
-Distutils2 ships with a python package capable to work with version numbers.
-It's an implementation of version specifiers `as defined in PEP 345
-<http://www.python.org/dev/peps/pep-0345/#version-specifiers>`_ about
-Metadatas.
-
-NormalizedVersion
-=================
-
-A Normalized version is a specific version of a distribution, as
-described in the PEP 345. So, you can work with the `NormalizedVersion` like
-this::
-
- >>> NormalizedVersion("1.2b1")
- NormalizedVersion('1.2b1')
-
-If you try to use irrational version specifiers, an `IrrationalVersionError`
-will be raised::
-
- >>> NormalizedVersion("irrational_version_number")
- ...
- IrrationalVersionError: irrational_version_number
-
-You can compare NormalizedVersion objects, like this::
-
- >>> NormalizedVersion("1.2b1") < NormalizedVersion("1.2")
- True
-
-NormalizedVersion is used internally by `VersionPredicate` to do his stuff.
-
-Suggest a normalized version
-----------------------------
-
-Before this version scheme, there was existing others ones. Distutils2 provides
-a tool that suggests a normalized version: the `suggest_normalized_version`
-function::
-
- >>> suggest_normalized_version('2.1-rc1')
- 2.1c1
-
-If `suggest_normalized_version` can't actually suggest you a version, it will
-return `None`::
-
- >>> print suggest_normalized_version('not a version')
- None
-
-Dealing with version predicates
-===============================
-
-`VersionPredicate` knows how to parse stuff like "ProjectName (>=version)", the
-class also provides a `match` method to test if a version number is the version
-predicate::
-
- >>> version = VersionPredicate("ProjectName (<1.2,>1.0")
- >>> version.match("1.2.1")
- False
- >>> version.match("1.1.1")
- True
-
-You could test if a predicate is a valid one, usng the `is_valid_predicate`
-function::
-
- >>> is_valid_predicate('FooBar (1.1)')
- True
- >>> is_valid_predicate('FooBar (+1.1)')
- False
-
diff --git a/docs/source/library/pkgutil.rst b/docs/source/library/pkgutil.rst
deleted file mode 100644
--- a/docs/source/library/pkgutil.rst
+++ /dev/null
@@ -1,333 +0,0 @@
-:mod:`pkgutil` --- Package utilities
-====================================
-
-.. module:: pkgutil
- :synopsis: Utilities to support packages.
-
-This module provides utilities to manipulate packages: support for the
-Importer protocol defined in :PEP:`302` and implementation of the API
-described in :PEP:`376` to work with the database of installed Python
-distributions.
-
-Import system utilities
------------------------
-
-.. function:: extend_path(path, name)
-
- Extend the search path for the modules which comprise a package. Intended
- use is to place the following code in a package's :file:`__init__.py`::
-
- from pkgutil import extend_path
- __path__ = extend_path(__path__, __name__)
-
- This will add to the package's ``__path__`` all subdirectories of directories
- on :data:`sys.path` named after the package. This is useful if one wants to
- distribute different parts of a single logical package as multiple
- directories.
-
- It also looks for :file:`\*.pkg` files beginning where ``*`` matches the
- *name* argument. This feature is similar to :file:`\*.pth` files (see the
- :mod:`site` module for more information), except that it doesn't special-case
- lines starting with ``import``. A :file:`\*.pkg` file is trusted at face
- value: apart from checking for duplicates, all entries found in a
- :file:`\*.pkg` file are added to the path, regardless of whether they exist
- on the filesystem. (This is a feature.)
-
- If the input path is not a list (as is the case for frozen packages) it is
- returned unchanged. The input path is not modified; an extended copy is
- returned. Items are only appended to the copy at the end.
-
- It is assumed that :data:`sys.path` is a sequence. Items of :data:`sys.path`
- that are not strings referring to existing directories are ignored. Unicode
- items on :data:`sys.path` that cause errors when used as filenames may cause
- this function to raise an exception (in line with :func:`os.path.isdir`
- behavior).
-
-
-.. class:: ImpImporter(dirname=None)
-
- :pep:`302` Importer that wraps Python's "classic" import algorithm.
-
- If *dirname* is a string, a :pep:`302` importer is created that searches that
- directory. If *dirname* is ``None``, a :pep:`302` importer is created that
- searches the current :data:`sys.path`, plus any modules that are frozen or
- built-in.
-
- Note that :class:`ImpImporter` does not currently support being used by
- placement on :data:`sys.meta_path`.
-
-
-.. class:: ImpLoader(fullname, file, filename, etc)
-
- :pep:`302` Loader that wraps Python's "classic" import algorithm.
-
-
-.. function:: find_loader(fullname)
-
- Find a :pep:`302` "loader" object for *fullname*.
-
- If *fullname* contains dots, path must be the containing package's
- ``__path__``. Returns ``None`` if the module cannot be found or imported.
- This function uses :func:`iter_importers`, and is thus subject to the same
- limitations regarding platform-specific special import locations such as the
- Windows registry.
-
-
-.. function:: get_importer(path_item)
-
- Retrieve a :pep:`302` importer for the given *path_item*.
-
- The returned importer is cached in :data:`sys.path_importer_cache` if it was
- newly created by a path hook.
-
- If there is no importer, a wrapper around the basic import machinery is
- returned. This wrapper is never inserted into the importer cache (None is
- inserted instead).
-
- The cache (or part of it) can be cleared manually if a rescan of
- :data:`sys.path_hooks` is necessary.
-
-
-.. function:: get_loader(module_or_name)
-
- Get a :pep:`302` "loader" object for *module_or_name*.
-
- If the module or package is accessible via the normal import mechanism, a
- wrapper around the relevant part of that machinery is returned. Returns
- ``None`` if the module cannot be found or imported. If the named module is
- not already imported, its containing package (if any) is imported, in order
- to establish the package ``__path__``.
-
- This function uses :func:`iter_importers`, and is thus subject to the same
- limitations regarding platform-specific special import locations such as the
- Windows registry.
-
-
-.. function:: iter_importers(fullname='')
-
- Yield :pep:`302` importers for the given module name.
-
- If fullname contains a '.', the importers will be for the package containing
- fullname, otherwise they will be importers for :data:`sys.meta_path`,
- :data:`sys.path`, and Python's "classic" import machinery, in that order. If
- the named module is in a package, that package is imported as a side effect
- of invoking this function.
-
- Non-:pep:`302` mechanisms (e.g. the Windows registry) used by the standard
- import machinery to find files in alternative locations are partially
- supported, but are searched *after* :data:`sys.path`. Normally, these
- locations are searched *before* :data:`sys.path`, preventing :data:`sys.path`
- entries from shadowing them.
-
- For this to cause a visible difference in behaviour, there must be a module
- or package name that is accessible via both :data:`sys.path` and one of the
- non-:pep:`302` file system mechanisms. In this case, the emulation will find
- the former version, while the builtin import mechanism will find the latter.
-
- Items of the following types can be affected by this discrepancy:
- ``imp.C_EXTENSION``, ``imp.PY_SOURCE``, ``imp.PY_COMPILED``,
- ``imp.PKG_DIRECTORY``.
-
-
-.. function:: iter_modules(path=None, prefix='')
-
- Yields ``(module_loader, name, ispkg)`` for all submodules on *path*, or, if
- path is ``None``, all top-level modules on :data:`sys.path`.
-
- *path* should be either ``None`` or a list of paths to look for modules in.
-
- *prefix* is a string to output on the front of every module name on output.
-
-
-.. function:: walk_packages(path=None, prefix='', onerror=None)
-
- Yields ``(module_loader, name, ispkg)`` for all modules recursively on
- *path*, or, if path is ``None``, all accessible modules.
-
- *path* should be either ``None`` or a list of paths to look for modules in.
-
- *prefix* is a string to output on the front of every module name on output.
-
- Note that this function must import all *packages* (*not* all modules!) on
- the given *path*, in order to access the ``__path__`` attribute to find
- submodules.
-
- *onerror* is a function which gets called with one argument (the name of the
- package which was being imported) if any exception occurs while trying to
- import a package. If no *onerror* function is supplied, :exc:`ImportError`\s
- are caught and ignored, while all other exceptions are propagated,
- terminating the search.
-
- Examples::
-
- # list all modules python can access
- walk_packages()
-
- # list all submodules of ctypes
- walk_packages(ctypes.__path__, ctypes.__name__ + '.')
-
-
-.. function:: get_data(package, resource)
-
- Get a resource from a package.
-
- This is a wrapper for the :pep:`302` loader :func:`get_data` API. The
- *package* argument should be the name of a package, in standard module format
- (``foo.bar``). The *resource* argument should be in the form of a relative
- filename, using ``/`` as the path separator. The parent directory name
- ``..`` is not allowed, and nor is a rooted name (starting with a ``/``).
-
- The function returns a binary string that is the contents of the specified
- resource.
-
- For packages located in the filesystem, which have already been imported,
- this is the rough equivalent of::
-
- d = os.path.dirname(sys.modules[package].__file__)
- data = open(os.path.join(d, resource), 'rb').read()
-
- If the package cannot be located or loaded, or it uses a :pep:`302` loader
- which does not support :func:`get_data`, then ``None`` is returned.
-
-
-Installed distributions database
---------------------------------
-
-Installed Python distributions are represented by instances of
-:class:`~distutils2._backport.pkgutil.Distribution`, or its subclass
-:class:`~distutils2._backport.pkgutil.EggInfoDistribution` for legacy ``.egg``
-and ``.egg-info`` formats). Most functions also provide an extra argument
-``use_egg_info`` to take legacy distributions into account.
-
-.. TODO write docs here, don't rely on automodule
- classes: Distribution and descendents
- functions: provides, obsoletes, replaces, etc.
-
-Caching
-+++++++
-
-For performance purposes, the list of distributions is being internally
-cached. It is enabled by default, but you can turn it off or clear
-it using :func:`~distutils2._backport.pkgutil.enable_cache`,
-:func:`~distutils2._backport.pkgutil.disable_cache` and
-:func:`~distutils2._backport.pkgutil.clear_cache`.
-
-
-Examples
---------
-
-Print all information about a distribution
-++++++++++++++++++++++++++++++++++++++++++
-
-Given a path to a ``.dist-info`` distribution, we shall print out all
-information that can be obtained using functions provided in this module::
-
- from distutils2._backport import pkgutil
- import sys
-
- path = raw_input() # read the path from the keyboard
- # first create the Distribution instance
- try:
- dist = pkgutil.Distribution(path)
- except IOError:
- print('No such distribution')
- sys.exit(1)
-
- print('Information about %s' % dist.name)
- print('Files')
- print('=====')
- for (path, md5, size) in dist.get_installed_files():
- print('* Path: %s' % path)
- print(' Hash %s, Size: %s bytes' % (md5, size))
- print('Metadata')
- print('========')
- for key, value in dist.metadata.items():
- print('%20s: %s' % (key, value))
- print('Extra')
- print('=====')
- if dist.requested:
- print('* It was installed by user request')
- else:
- print('* It was installed as a dependency')
-
-If we save the script above as ``print_info.py`` and we are intested in the
-distribution located at
-``/home/josip/dev/distutils2/src/distutils2/_backport/tests/fake_dists/choxie-2.0.0.9``
-then by typing in the console:
-
-.. code-block:: bash
-
- $ echo /home/josip/dev/distutils2/src/distutils2/_backport/tests/fake_dists/choxie-2.0.0.9.dist-info | python print_info.py
-
-we get the following output:
-
-.. code-block:: none
-
- Information about choxie
- Files
- =====
- * Path: ../home/josip/dev/distutils2/src/distutils2/_backport/tests/fake_dists/choxie-2.0.0.9/truffles.py
- Hash 5e052db6a478d06bad9ae033e6bc08af, Size: 111 bytes
- * Path: ../home/josip/dev/distutils2/src/distutils2/_backport/tests/fake_dists/choxie-2.0.0.9/choxie/chocolate.py
- Hash ac56bf496d8d1d26f866235b95f31030, Size: 214 bytes
- * Path: ../home/josip/dev/distutils2/src/distutils2/_backport/tests/fake_dists/choxie-2.0.0.9/choxie/__init__.py
- Hash 416aab08dfa846f473129e89a7625bbc, Size: 25 bytes
- * Path: ../home/josip/dev/distutils2/src/distutils2/_backport/tests/fake_dists/choxie-2.0.0.9.dist-info/INSTALLER
- Hash d41d8cd98f00b204e9800998ecf8427e, Size: 0 bytes
- * Path: ../home/josip/dev/distutils2/src/distutils2/_backport/tests/fake_dists/choxie-2.0.0.9.dist-info/METADATA
- Hash 696a209967fef3c8b8f5a7bb10386385, Size: 225 bytes
- * Path: ../home/josip/dev/distutils2/src/distutils2/_backport/tests/fake_dists/choxie-2.0.0.9.dist-info/REQUESTED
- Hash d41d8cd98f00b204e9800998ecf8427e, Size: 0 bytes
- * Path: ../home/josip/dev/distutils2/src/distutils2/_backport/tests/fake_dists/choxie-2.0.0.9.dist-info/RECORD
- Hash None, Size: None bytes
- Metadata
- ========
- Metadata-Version: 1.2
- Name: choxie
- Version: 2.0.0.9
- Platform: []
- Supported-Platform: UNKNOWN
- Summary: Chocolate with a kick!
- Description: UNKNOWN
- Keywords: []
- Home-page: UNKNOWN
- Author: UNKNOWN
- Author-email: UNKNOWN
- Maintainer: UNKNOWN
- Maintainer-email: UNKNOWN
- License: UNKNOWN
- Classifier: []
- Download-URL: UNKNOWN
- Obsoletes-Dist: ['truffles (<=0.8,>=0.5)', 'truffles (<=0.9,>=0.6)']
- Project-URL: []
- Provides-Dist: ['truffles (1.0)']
- Requires-Dist: ['towel-stuff (0.1)']
- Requires-Python: UNKNOWN
- Requires-External: []
- Extra
- =====
- * It was installed as a dependency
-
-Find out obsoleted distributions
-++++++++++++++++++++++++++++++++
-
-Now, we take tackle a different problem, we are interested in finding out
-which distributions have been obsoleted. This can be easily done as follows::
-
- from distutils2._backport import pkgutil
-
- # iterate over all distributions in the system
- for dist in pkgutil.get_distributions():
- name = dist.name
- version = dist.metadata['Version']
- # find out which distributions obsolete this name/version combination
- for obsoleted_by in pkgutil.obsoletes_distribution(name, version):
- print('%s(%s) is obsoleted by %s' % (name, version, obsoleted_by.name))
-
-This is how the output might look like:
-
-.. code-block:: none
-
- strawberry(0.6) is obsoleted by choxie
- grammar(1.0a4) is obsoleted by towel-stuff
-
diff --git a/docs/source/setupcfg-spec.rst b/docs/source/setupcfg-spec.rst
deleted file mode 100644
--- a/docs/source/setupcfg-spec.rst
+++ /dev/null
@@ -1,308 +0,0 @@
-===================
-setup.cfg file v0.9
-===================
-
-This document describes the :file:`setup.cfg`, a ini-like file used by
-Distutils2 to replace the :file:`setup.py` file.
-
-Syntax
-======
-
-The configuration file is an ini-based file. Variables name can be
-assigned values, and grouped into sections. A line that starts with "#" is
-commented out. Empty lines are also removed.
-
-Example::
-
- [section1]
- # comment
- name = value
- name2 = "other value"
-
- [section2]
- foo = bar
-
-
-Values conversion
-:::::::::::::::::
-
-Here are a set of rules for converting values:
-
-- If value is quoted with " chars, it's a string. This notation is useful to
- include "=" characters in the value. In case the value contains a "
- character, it must be escaped with a "\" character.
-- If the value is "true" or "false" --no matter what the case is--, it's
- converted to a boolean, or 0 and 1 when the language does not have a
- boolean type.
-- A value can contains multiple lines. When read, lines are converted into a
- sequence of values. Each new line for a multiple lines value must start with
- a least one space or tab character. These indentation characters will be
- stripped.
-- all other values are considered as strings
-
-Examples::
-
- [section]
- foo = one
- two
- three
-
- bar = false
- baz = 1.3
- boo = "ok"
- beee = "wqdqw pojpj w\"ddq"
-
-Extending files
-:::::::::::::::
-
-An INI file can extend another file. For this, a "DEFAULT" section must contain
-an "extends" variable that can point to one or several INI files which will be
-merged to the current file by adding new sections and values.
-
-If the file pointed in "extends" contains section/variable names that already
-exist in the original file, they will not override existing ones.
-
-file_one.ini::
-
- [section1]
- name2 = "other value"
-
- [section2]
- foo = baz
- bas = bar
-
-file_two.ini::
-
- [DEFAULT]
- extends = file_one.ini
-
- [section2]
- foo = bar
-
-Result::
-
- [section1]
- name2 = "other value"
-
- [section2]
- foo = bar
- bas = bar
-
-To point several files, the multi-line notation can be used:
-
- [DEFAULT]
- extends = file_one.ini
- file_two.ini
-
-When several files are provided, they are processed sequentially. So if the
-first one has a value that is also present in the second, the second one will
-be ignored. This means that the configuration goes from the most specialized to
-the most common.
-
-**Tools will need to provide a way to produce a canonical version of the
-file**. This will be useful to publish a single file.
-
-
-Description of sections and fields
-==================================
-
-Each section contains a description of its options.
-
-- Options that are marked *\*multi* can have multiple values, one value per
- line.
-- Options that are marked *\*optional* can be omited.
-
-
-The sections are:
-
-global
- Global options for Distutils2.
-
-metadata
- The metadata section contains the metadata for the project as described in
- :PEP:`345`.
-
-files
- Declaration of package files included in the project.
-
-`command` sections
- Redefinition of user options for Distutils2 commands.
-
-
-global
-::::::
-
-Contains global options for Distutils2. This section is shared with Distutils1
-(legacy version distributed in python 2.X standard library).
-
-
-- **commands**: Defined Distutils2 command. A command is defined by its fully
- qualified name.
-
- Examples::
-
- [global]
- commands =
- package.sdist.CustomSdistCommand
-
- *\*optional* *\*multi*
-
-- **compilers**: Defined Distutils2 compiler. A compiler is defined by its fully
- qualified name.
-
- Example::
-
- [global]
- compiler =
- package.compiler.CustomCCompiler
-
- *\*optional* *\*multi*
-
-- **setup_hook**: defines a callable that will be called right after the
- :file:`setup.cfg` file is read. The callable receives the configuration
- in form of a mapping and can make some changes to it. *\*optional*
-
- Example::
-
- [global]
- setup_hook =
- distutils2.tests.test_config.hook
-
-
-metadata
-::::::::
-
-The metadata section contains the metadata for the project as described in
-:PEP:`345`. Field names are case-insensitive.
-
-- metadata-version
-- name
-- version
-- platform
-- supported-platform
-- summary
-- description
-- keywords
-- home-page
-- download-url
-- author
-- author-email
-- maintainer
-- maintainer-email
-- license
-- classifiers
-- requires-dist
-- provides-dist
-- obsoletes-dist
-- requires-python
-- requires-externals
-- project-url
-
-There's one extra field, to replace description with a path to a text file:
-
-- description-file: path to a text file that will be used to replace description
-
-
-files
-:::::
-
-This section describes the files included in the project.
-
-- **packages_root**: the root directory containing all packages. If not provided
- Distutils2 will use the current directory. *\*optional*
-- **packages**: a list of packages the project includes *\*optional* *\*multi*
-- **modules**: a list of packages the project includes *\*optional* *\*multi*
-- **scripts**: a list of scripts the project includes *\*optional* *\*multi*
-- **extra_files**: a list of patterns to include extra files *\*optional* *\*multi*
-- **resources**: a list of data files. *\*optional* *\*multi*
-
-Example::
-
- [files]
- packages_root = src
- packages =
- pypi2rpm
- pypi2rpm.command
-
- scripts =
- pypi2rpm/pypi2rpm.py
-
- extra_files =
- setup.py
- README
-
- resources =
- source1 = destination1
- source2 = destination2
- doc/* = {doc}
- scripts/foo.sh = {datadir}/scripts/{distribution.name}
-
-extensions
-::::::::::
-
-
-XXX
-
-Command sections
-:::::::::::::::::
-
-Each Distutils2 command can have its own user options defined in :file:`setup.cfg`
-
-Example::
-
- [sdist]
- manifest-builders = package.module.Maker
-
-
-To override the build class in order to generate Python3 code from your Python2 base::
-
- [build_py]
- use-2to3 = True
-
-Extensibility
-=============
-
-Every section can define new variable that are not part of the specification.
-They are called **extensions**.
-
-An extension field starts with *X-*.
-
-Example::
-
- [metadata]
- ...
- X-Debian-Name = python-distribute
-
-Changes in the specification
-============================
-
-The version scheme for this specification is **MAJOR.MINOR**.
-Changes in the specification will increment the version.
-
-- minor version changes (1.x): backwards compatible
- - new fields and sections (both optional and mandatory) can be added
- - optional fields can be removed
-- major channges (2.X): backwards-incompatible
- - mandatory fields/sections are removed
- - fields change their meaning
-
-As a consequence, a tool written to consume 1.X (say, X=5) has these
-properties:
-
-- reading 1.Y, Y<X (e.g. 1.1) is possible, since the tool knows what
- optional fields weren't there
-- reading 1.Y, Y>X is also possible. The tool will just ignore the new
- fields (even if they are mandatory in that version)
- If optional fields were removed, the tool will just consider them absent.
-- reading 2.X is not possible; the tool should refuse to interpret
- the file.
-
-A tool written to produce 1.X should have these properties:
-- it will write all mandatory fields
-- it may write optional fields
-
-Acks
-====
-
-XXX
-
diff --git a/docs/source/setupcfg.rst b/docs/source/setupcfg.rst
deleted file mode 100644
--- a/docs/source/setupcfg.rst
+++ /dev/null
@@ -1,549 +0,0 @@
-==================
-The setup.cfg file
-==================
-
-This document describes the :file:`setup.cfg`, a ini-like file used by
-Distutils2 to replace the :file:`setup.py` file.
-
-Each section contains a description of its options.
-
-- Options that are marked *\*multi* can have multiple values, one value per
- line.
-- Options that are marked *\*optional* can be omited.
-- Options that are marked *\*environ* can use environment markers, as described
- in :PEP:`345`.
-
-
-The sections are:
-
-global
- Global options for Distutils2.
-
-metadata
- The metadata section contains the metadata for the project as described in
- :PEP:`345`.
-
-files
- Declaration of package files included in the project.
-
-`command` sections
- Redefinition of user options for Distutils2 commands.
-
-
-global
-======
-
-Contains global options for Distutils2. This section is shared with Distutils1
-(legacy version distributed in python 2.X standard library).
-
-
-- **commands**: Defined Distutils2 command. A command is defined by its fully
- qualified name.
-
- Examples::
-
- [global]
- commands =
- package.sdist.CustomSdistCommand
-
- *\*optional* *\*multi*
-
-- **compilers**: Defined Distutils2 compiler. A compiler is defined by its fully
- qualified name.
-
- Example::
-
- [global]
- compiler =
- package.compiler.CustomCCompiler
-
- *\*optional* *\*multi*
-
-- **setup_hook**: defines a callable that will be called right after the
- :file:`setup.cfg` file is read. The callable receives the configuration
- in form of a mapping and can make some changes to it. *\*optional*
-
- Example::
-
- [global]
- setup_hook =
- distutils2.tests.test_config.hook
-
-
-metadata
-========
-
-The metadata section contains the metadata for the project as described in
-:PEP:`345`.
-
-.. Note::
- Field names are case-insensitive.
-
-Fields:
-
-- **name**: Name of the project.
-- **version**: Version of the project. Must comply with :PEP:`386`.
-- **platform**: Platform specification describing an operating system supported
- by the distribution which is not listed in the "Operating System" Trove
- classifiers (:PEP:`301`). *\*multi* *\*optional*
-- **supported-platform**: Binary distributions containing a PKG-INFO file will
- use the Supported-Platform field in their metadata to specify the OS and
- CPU for which the binary distribution was compiled. The semantics of
- the Supported-Platform field are freeform. *\*multi* *\*optional*
-- **summary**: A one-line summary of what the distribution does.
- (Used to be called *description* in Distutils1.)
-- **description**: A longer description. (Used to be called *long_description*
- in Distutils1.) A file can be provided in the *description-file* field.
- *\*optional*
-- **description-file**: path to a text file that will be used for the
- **description** field. *\*optional*
-- **keywords**: A list of additional keywords to be used to assist searching
- for the distribution in a larger catalog. Comma or space-separated. *\*optional*
-- **home-page**: The URL for the distribution's home page.
-- **download-url**: The URL from which this version of the distribution
- can be downloaded. *\*optional*
-- **author**: Author's name. *\*optional*
-- **author-email**: Author's e-mail. *\*optional*
-- **maintainer**: Maintainer's name. *\*optional*
-- **maintainer-email**: Maintainer's e-mail. *\*optional*
-- **license**: A text indicating the term of uses, when a trove classifier does
- not match. *\*optional*.
-- **classifiers**: Classification for the distribution, as described in PEP 301.
- *\*optional* *\*multi* *\*environ*
-- **requires-dist**: name of another distutils project required as a dependency.
- The format is *name (version)* where version is an optional
- version declaration, as described in PEP 345. *\*optional* *\*multi* *\*environ*
-- **provides-dist**: name of another distutils project contained whithin this
- distribution. Same format than *requires-dist*. *\*optional* *\*multi* *\*environ*
-- **obsoletes-dist**: name of another distutils project this version obsoletes.
- Same format than *requires-dist*. *\*optional* *\*multi* *\*environ*
-- **requires-python**: Specifies the Python version the distribution requires.
- The value is a version number, as described in PEP 345.
- *\*optional* *\*multi* *\*environ*
-- **requires-externals**: a dependency in the system. This field is free-form,
- and just a hint for downstream maintainers. *\*optional* *\*multi* *\*environ*
-- **project-url**: A label, followed by a browsable URL for the project.
- "label, url". The label is limited to 32 signs. *\*optional* *\*multi*
-
-
-Example::
-
- [metadata]
- name = pypi2rpm
- version = 0.1
- author = Tarek Ziade
- author-email = tarek at ziade.org
- summary = Script that transforms a sdist archive into a rpm archive
- description-file = README
- home-page = http://bitbucket.org/tarek/pypi2rpm
- project-url: RSS feed, https://bitbucket.org/tarek/pypi2rpm/rss
-
- classifier = Development Status :: 3 - Alpha
- License :: OSI Approved :: Mozilla Public License 1.1 (MPL 1.1)
-
-.. Note::
- Some metadata fields seen in :PEP:`345` are automatically generated
- (for instance Metadata-Version value).
-
-
-files
-=====
-
-This section describes the files included in the project.
-
-- **packages_root**: the root directory containing all packages. If not provided
- Distutils2 will use the current directory. *\*optional*
-- **packages**: a list of packages the project includes *\*optional* *\*multi*
-- **modules**: a list of packages the project includes *\*optional* *\*multi*
-- **scripts**: a list of scripts the project includes *\*optional* *\*multi*
-- **extra_files**: a list of patterns to include extra files *\*optional* *\*multi*
-
-Example::
-
- [files]
- packages_root = src
- packages =
- pypi2rpm
- pypi2rpm.command
-
- scripts =
- pypi2rpm/pypi2rpm.py
-
- extra_files =
- setup.py
- README
-
-.. Note::
- In Distutils2, setup.cfg will be implicitly included.
-
-Resources
-=========
-
-This section describes the files used by the project which must not be installed in the same place that python modules or libraries, they are called **resources**. They are for example documentation files, script files, databases, etc...
-
-For declaring resources, you must use this notation ::
-
- source = destination
-
-Data-files are declared in the **resources** field in the **file** section, for example::
-
- [files]
- resources =
- source1 = destination1
- source2 = destination2
-
-The **source** part of the declaration are relative paths of resources files (using unix path separator **/**). For example, if you've this source tree::
-
- foo/
- doc/
- doc.man
- scripts/
- foo.sh
-
-Your setup.cfg will look like::
-
- [files]
- resources =
- doc/doc.man = destination_doc
- scripts/foo.sh = destination_scripts
-
-The final paths where files will be placed are composed by : **source** + **destination**. In the previous example, **doc/doc.man** will be placed in **destination_doc/doc/doc.man** and **scripts/foo.sh** will be placed in **destination_scripts/scripts/foo.sh**. (If you want more control on the final path, take a look at base_prefix_).
-
-The **destination** part of resources declaration are paths with categories. Indeed, it's generally a bad idea to give absolute path as it will be cross incompatible. So, you must use resources categories in your **destination** declaration. Categories will be replaced by their real path at the installation time. Using categories is all benefit, your declaration will be simpler, cross platform and it will allow packager to place resources files where they want without breaking your code.
-
-Categories can be specified by using this syntax::
-
- {category}
-
-Default categories are::
-
-* config
-* appdata
-* appdata.arch
-* appdata.persistent
-* appdata.disposable
-* help
-* icon
-* scripts
-* doc
-* info
-* man
-
-A special category also exists **{distribution.name}** that will be replaced by the name of the distribution, but as most of the defaults categories use them, so it's not necessary to add **{distribution.name}** into your destination.
-
-If you use categories in your declarations, and you are encouraged to do, final path will be::
-
- source + destination_expanded
-
-.. _example_final_path:
-
-For example, if you have this setup.cfg::
-
- [metadata]
- name = foo
-
- [files]
- resources =
- doc/doc.man = {doc}
-
-And if **{doc}** is replaced by **{datadir}/doc/{distribution.name}**, final path will be::
-
- {datadir}/doc/foo/doc/doc.man
-
-Where {datafir} category will be platform-dependent.
-
-
-More control on source part
----------------------------
-
-Glob syntax
-___________
-
-When you declare source file, you can use a glob-like syntax to match multiples file, for example::
-
- scripts/* = {script}
-
-Will match all the files in the scripts directory and placed them in the script category.
-
-Glob tokens are:
-
- * * : match all files.
- * ? : match any character.
- * ** : match any level of tree recursion (even 0).
- * {} : will match any part separated by comma (example : {sh,bat}).
-
-TODO ::
-
- Add an example
-
-Order of declaration
-____________________
-
-The order of declaration is important if one file match multiple rules. The last rules matched by file is used, this is useful if you have this source tree::
-
- foo/
- doc/
- index.rst
- setup.rst
- documentation.txt
- doc.tex
- README
-
-And you want all the files in the doc directory to be placed in {doc} category, but README must be placed in {help} category, instead of listing all the files one by one, you can declare them in this way::
-
- [files]
- resources =
- doc/* = {doc}
- doc/README = {help}
-
-Exclude
-_______
-
-You can exclude some files of resources declaration by giving no destination, it can be useful if you have a non-resources file in the same directory of resources files::
-
- foo/
- doc/
- RELEASES
- doc.tex
- documentation.txt
- docu.rst
-
-Your **file** section will be::
-
- [files]
- resources =
- doc/* = {doc}
- doc/RELEASES =
-
-More control on destination part
---------------------------------
-
-.. _base_prefix:
-
-Define a base-prefix
-____________________
-
-When you define your resources, you can have more control of how the final path is compute.
-
-By default, the final path is::
-
- destination + source
-
-This can generate long paths, for example (example_final_path_)::
-
- {datadir}/doc/foo/doc/doc.man
-
-When you declare your source, you can use a separator to split the source in **prefix** **suffix**. The supported separator are :
-
- * Whitespace
-
-So, for example, if you have this source::
-
- docs/ doc.man
-
-The **prefix** is "docs/" and the **suffix** is "doc.html".
-
-.. note::
-
- Separator can be placed after a path separator or replace it. So theses two sources are equivalent::
-
- docs/ doc.man
- docs doc.man
-
-.. note::
-
- Glob syntax is working the same way with standard source and splitted source. So theses rules::
-
- docs/*
- docs/ *
- docs *
-
- Will match all the files in the docs directory.
-
-When you use splitted source, the final path is compute in this way::
-
- destination + prefix
-
-So for example, if you have this setup.cfg::
-
- [metadata]
- name = foo
-
- [files]
- resources =
- doc/ doc.man = {doc}
-
-And if **{doc}** is replaced by **{datadir}/doc/{distribution.name}**, final path will be::
-
- {datadir}/doc/foo/doc.man
-
-
-Overwrite paths for categories
-------------------------------
-
-.. warning::
-
- This part is intended for system administrator or packager.
-
-The real paths of categories are registered in the *sysconfig.cfg* file installed in your python installation. The format of this file is INI-like. The content of the file is organized into several sections :
-
- * globals : Standard categories's paths.
- * posix_prefix : Standard paths for categories and installation paths for posix system.
- * other one...
-
-Standard categories's paths are platform independent, they generally refers to other categories, which are platform dependent. Sysconfig module will choose these category from sections matching os.name. For example::
-
- doc = {datadir}/doc/{distribution.name}
-
-It refers to datadir category, which can be different between platforms. In posix system, it may be::
-
- datadir = /usr/share
-
-So the final path will be::
-
- doc = /usr/share/doc/{distribution.name}
-
-The platform dependent categories are :
-
- * confdir
- * datadir
- * libdir
- * base
-
-Define extra-categories
------------------------
-
-Examples
---------
-
-.. note::
-
- These examples are incremental but works unitarily.
-
-Resources in root dir
-_____________________
-
-Source tree::
-
- babar-1.0/
- README
- babar.sh
- launch.sh
- babar.py
-
-Setup.cfg::
-
- [files]
- resources =
- README = {doc}
- *.sh = {scripts}
-
-So babar.sh and launch.sh will be placed in {scripts} directory.
-
-Now let's move all the scripts into a scripts directory.
-
-Resources in sub-directory
-__________________________
-
-Source tree::
-
- babar-1.1/
- README
- scripts/
- babar.sh
- launch.sh
- LAUNCH
- babar.py
-
-Setup.cfg::
-
- [files]
- resources =
- README = {doc}
- scripts/ LAUNCH = {doc}
- scripts/ *.sh = {scripts}
-
-It's important to use the separator after scripts/ to install all the bash scripts into {scripts} instead of {scripts}/scripts.
-
-Now let's add some docs.
-
-Resources in multiple sub-directories
-_____________________________________
-
-Source tree::
-
- babar-1.2/
- README
- scripts/
- babar.sh
- launch.sh
- LAUNCH
- docs/
- api
- man
- babar.py
-
-Setup.cfg::
-
- [files]
- resources =
- README = {doc}
- scripts/ LAUNCH = {doc}
- scripts/ *.sh = {scripts}
- doc/ * = {doc}
- doc/ man = {man}
-
-You want to place all the file in the docs script into {doc} category, instead of man, which must be placed into {man} category, we will use the order of declaration of globs to choose the destination, the last glob that match the file is used.
-
-Now let's add some scripts for windows users.
-
-Complete example
-________________
-
-Source tree::
-
- babar-1.3/
- README
- doc/
- api
- man
- scripts/
- babar.sh
- launch.sh
- babar.bat
- launch.bat
- LAUNCH
-
-Setup.cfg::
-
- [files]
- resources =
- README = {doc}
- scripts/ LAUNCH = {doc}
- scripts/ *.{sh,bat} = {scripts}
- doc/ * = {doc}
- doc/ man = {man}
-
-We use brace expansion syntax to place all the bash and batch scripts into {scripts} category.
-
-.. Warning::
- In Distutils2, setup.py and README (or README.txt) files are not more
- included in source distribution by default
-
-`command` sections
-==================
-
-Each Distutils2 command can have its own user options defined in :file:`setup.cfg`
-
-Example::
-
- [sdist]
- manifest-builders = package.module.Maker
-
-
-To override the build class in order to generate Python3 code from your Python2 base::
-
- [build_py]
- use-2to3 = True
-
-
diff --git a/docs/source/tutorial.rst b/docs/source/tutorial.rst
deleted file mode 100644
--- a/docs/source/tutorial.rst
+++ /dev/null
@@ -1,129 +0,0 @@
-===================
-Distutils2 tutorial
-===================
-
-Welcome to the Distutils2 tutorial ! We will learn here how to use Distutils2
-to package your project.
-
-
-Installing Distutils2
-=====================
-
-Quite simple, my dear reader::
-
- $ pip install Distutils2
-
-Or.. grab it at PyPI and run::
-
- $ python setup.py install
-
-
-
-Getting started
-===============
-
-Distutils2 works with the *setup.cfg* file. It contains all the metadata for
-your project, as defined in PEP 345, but also declare what your project
-contains.
-
-Let's say you have a project called *CLVault* containing one package called
-*clvault*, and a few scripts inside. You can use the *mkcfg* script to create
-a *setup.cfg* file for the project. The script will ask you a few questions::
-
- $ mkdir CLVault
- $ cd CLVault
- $ python -m distutils2.mkcfg
- Project name [CLVault]:
- Current version number: 0.1
- Package description:
- >Command-line utility to store and retrieve passwords
- Author name: Tarek Ziade
- Author e-mail address: tarek at ziade.org
- Project Home Page: http://bitbucket.org/tarek/clvault
- Do you want to add a package ? (y/n): y
- Package name: clvault
- Do you want to add a package ? (y/n): n
- Do you want to set Trove classifiers? (y/n): y
- Please select the project status:
-
- 1 - Planning
- 2 - Pre-Alpha
- 3 - Alpha
- 4 - Beta
- 5 - Production/Stable
- 6 - Mature
- 7 - Inactive
-
- Status: 3
- What license do you use: GPL
- Matching licenses:
-
- 1) License :: OSI Approved :: GNU General Public License (GPL)
- 2) License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL)
-
- Type the number of the license you wish to use or ? to try again:: 1
- Do you want to set other trove identifiers (y/n) [n]: n
- Wrote "setup.cfg".
-
-
-A setup.cfg file is created, containing the metadata of your project and the
-list of the packages it contains::
-
- $ more setup.cfg
- [metadata]
- name = CLVault
- version = 0.1
- author = Tarek Ziade
- author_email = tarek at ziade.org
- description = Command-line utility to store and retrieve passwords
- home_page = http://bitbucket.org/tarek/clvault
-
- classifier = Development Status :: 3 - Alpha
- License :: OSI Approved :: GNU General Public License (GPL)
-
- [files]
-
- packages = clvault
-
-
-Our project will depend on the *keyring* project. Let's add it in the
-[metadata] section::
-
- [metadata]
- ...
- requires_dist =
- keyring
-
-
-
-Running commands
-================
-
-You can run useful commands on your project once the setup.cfg file is ready:
-
-- sdist: creates a source distribution
-- register: register your project to PyPI
-- upload: upload the distribution to PyPI
-- install: install it
-
-All commands are run using the run script::
-
- $ python -m distutils2.run install
- $ python -m distutils2.run sdist
- $ python -m distutils2.run upload
-
-If you want to push a source distribution of your project at PyPI, do::
-
- $ python -m distutils2.run sdist register upload
-
-
-Installing the project
-======================
-
-People will have to manually run the distutils2 install command::
-
- $ python -m distutils2.run install
-
-
-
-
diff --git a/setup.cfg b/setup.cfg
--- a/setup.cfg
+++ b/setup.cfg
@@ -1,9 +1,10 @@
[metadata]
name = Distutils2
-version = 1.0a3
+version = 1.0a5.dev0
summary = Python Packaging Library
description-file = README.txt
-home-page = http://bitbucket.org/tarek/distutils2/wiki/Home
+home-page = http://wiki.python.org/moin/Distutils2
+download-url = http://pypi.python.org/pypi/Distutils2
author = The Fellowship of the Packaging
author-email = the-fellowship-of-the-packaging at googlegroups.com
# we set a custom license field in addition to the classifier below
@@ -16,6 +17,10 @@
License :: OSI Approved :: Python Software Foundation License
Operating System :: OS Independent
Programming Language :: Python
+ Programming Language :: Python :: 3
+ Programming Language :: Python :: 3.1
+ Programming Language :: Python :: 3.2
+ Programming Language :: Python :: Implementation :: CPython
Topic :: Software Development :: Libraries :: Python Modules
Topic :: System :: Archiving :: Packaging
Topic :: System :: Systems Administration
@@ -37,14 +42,23 @@
distutils2.tests = xxmodule.c
scripts =
pysetup
+extra_files =
+ README.txt
+ LICENSE.txt
+ CHANGES.txt
+ CONTRIBUTORS.txt
+ DEVNOTES.txt
+ setup.py
+ Makefile
+ runtests.py
+ check.sh
+ tests.sh
+ tox.ini
+ scan_pypi_versions.py
-# TODO build hashlib for Python < 2.4
# TODO add all test data files
# FIXME cfg_to_args should support comments in multi-line fields
[build_ext]
# needed so that tests work without mucking with sys.path
inplace = 1
-
-[upload_docs]
-upload-dir = docs/build/html
diff --git a/setup.py b/setup.py
--- a/setup.py
+++ b/setup.py
@@ -15,7 +15,7 @@
def cfg_to_args(path='setup.cfg'):
- opts_to_args = {
+ opts_to_args = {
'metadata': (
('name', 'name', None),
('version', 'version', None),
diff --git a/tox.ini b/tox.ini
--- a/tox.ini
+++ b/tox.ini
@@ -1,6 +1,6 @@
[tox]
#distshare={homedir}/.tox/distshare
-envlist=py24,py25,py26,py26-s,py27
+envlist=py31,py32,py33
[tox:hudson]
#distshare={toxworkdir}/distshare
@@ -8,22 +8,10 @@
[testenv]
commands=
+ # explicit argument to exclude _backport/tests;
+ # their coverage is not interesting
nosetests --with-xunit distutils2/tests
deps=
- unittest2
+ docutils
+ unittest2-py3k
nose
-
-[testenv:py26-s]
-distribute=False
-
-[testenv:py27]
-basepython=python2.7
-commands=
- nosetests --with-xunit distutils2/tests
-
-[testenv:py24]
-basepython=python2.4
-commands=
- rm -f distutils2/_backport/_hashlib.so
- python setup.py build_ext -f
- nosetests --with-xunit distutils2/tests
--
Repository URL: http://hg.python.org/distutils2
More information about the Python-checkins
mailing list