summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorPJ Eby <distutils-sig@python.org>2006-04-14 19:13:24 +0000
committerPJ Eby <distutils-sig@python.org>2006-04-14 19:13:24 +0000
commit868c0d39e6fced1d53d8dfd7cf2136cc3e47ab61 (patch)
tree4d0f5b8aab3c00f2a6a87a292f5eb8e35484e0e8 /docs
parent2073779a928690e0b6902d7f099087478502b28c (diff)
downloadpython-setuptools-bitbucket-868c0d39e6fced1d53d8dfd7cf2136cc3e47ab61.tar.gz
Don't eagerly import namespace packages. This was the big reason for
branching to 0.7 now, as I wanted this wart gone before anything went into Python 2.5. But it's gone now, yay!
Diffstat (limited to 'docs')
-rw-r--r--docs/pkg_resources.txt17
1 files changed, 10 insertions, 7 deletions
diff --git a/docs/pkg_resources.txt b/docs/pkg_resources.txt
index 8dd3e9ab..18b68db7 100644
--- a/docs/pkg_resources.txt
+++ b/docs/pkg_resources.txt
@@ -137,13 +137,16 @@ Namespace Package Support
A namespace package is a package that only contains other packages and modules,
with no direct contents of its own. Such packages can be split across
-multiple, separately-packaged distributions. Normally, you do not need to use
-the namespace package APIs directly; instead you should supply the
-``namespace_packages`` argument to ``setup()`` in your project's ``setup.py``.
-See the `setuptools documentation on namespace packages`_ for more information.
-
-However, if for some reason you need to manipulate namespace packages or
-directly alter ``sys.path`` at runtime, you may find these APIs useful:
+multiple, separately-packaged distributions. They are normally used to split
+up large packages produced by a single organization, such as in the ``zope``
+namespace package for Zope Corporation packages, and the ``peak`` namespace
+package for the Python Enterprise Application Kit.
+
+To create a namespace package, you list it in the ``namespace_packages``
+argument to ``setup()``, in your project's ``setup.py``. (See the `setuptools
+documentation on namespace packages`_ for more information on this.) Also,
+you must add a ``declare_namespace()`` call in the package's ``__init__.py``
+file(s):
``declare_namespace(name)``
Declare that the dotted package name `name` is a "namespace package" whose