Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
S
setuptools
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Analytics
Analytics
CI / CD
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Jérome Perrin
setuptools
Commits
eff1456d
Commit
eff1456d
authored
Mar 16, 2014
by
Jason R. Coombs
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Update documentation to reflect new include parameter.
parent
3e6b92ec
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
8 additions
and
5 deletions
+8
-5
docs/setuptools.txt
docs/setuptools.txt
+8
-5
No files found.
docs/setuptools.txt
View file @
eff1456d
...
@@ -416,19 +416,22 @@ the ``packages`` argument of ``setup()``. However, for very large projects
...
@@ -416,19 +416,22 @@ the ``packages`` argument of ``setup()``. However, for very large projects
(Twisted, PEAK, Zope, Chandler, etc.), it can be a big burden to keep the
(Twisted, PEAK, Zope, Chandler, etc.), it can be a big burden to keep the
package list updated. That's what ``setuptools.find_packages()`` is for.
package list updated. That's what ``setuptools.find_packages()`` is for.
``find_packages()`` takes a source directory, and a list of package names or
``find_packages()`` takes a source directory and two lists of package name
patterns to exclude. If omitted, the source directory defaults to the same
patterns to exclude and include. If omitted, the source directory defaults to
the same
directory as the setup script. Some projects use a ``src`` or ``lib``
directory as the setup script. Some projects use a ``src`` or ``lib``
directory as the root of their source tree, and those projects would of course
directory as the root of their source tree, and those projects would of course
use ``"src"`` or ``"lib"`` as the first argument to ``find_packages()``. (And
use ``"src"`` or ``"lib"`` as the first argument to ``find_packages()``. (And
such projects also need something like ``package_dir = {'':'src'}`` in their
such projects also need something like ``package_dir = {'':'src'}`` in their
``setup()`` arguments, but that's just a normal distutils thing.)
``setup()`` arguments, but that's just a normal distutils thing.)
Anyway, ``find_packages()`` walks the target directory, and finds Python
Anyway, ``find_packages()`` walks the target directory, filtering by inclusion
patterns, and finds Python
packages by looking for ``__init__.py`` files. It then filters the list of
packages by looking for ``__init__.py`` files. It then filters the list of
packages using the exclusion patterns.
packages using the exclusion patterns.
Exclusion patterns are package names, optionally including wildcards. For
Inclusion and exclusion patterns are package names, optionally including
wildcards. For
example, ``find_packages(exclude=["*.tests"])`` will exclude all packages whose
example, ``find_packages(exclude=["*.tests"])`` will exclude all packages whose
last name part is ``tests``. Or, ``find_packages(exclude=["*.tests",
last name part is ``tests``. Or, ``find_packages(exclude=["*.tests",
"*.tests.*"])`` will also exclude any subpackages of packages named ``tests``,
"*.tests.*"])`` will also exclude any subpackages of packages named ``tests``,
...
@@ -442,7 +445,7 @@ in order to cover all the bases. Really, the exclusion patterns are intended
...
@@ -442,7 +445,7 @@ in order to cover all the bases. Really, the exclusion patterns are intended
to cover simpler use cases than this, like excluding a single, specified
to cover simpler use cases than this, like excluding a single, specified
package and its subpackages.
package and its subpackages.
Regardless of the
target directory or exclusion
s, the ``find_packages()``
Regardless of the
parameter
s, the ``find_packages()``
function returns a list of package names suitable for use as the ``packages``
function returns a list of package names suitable for use as the ``packages``
argument to ``setup()``, and so is usually the easiest way to set that
argument to ``setup()``, and so is usually the easiest way to set that
argument in your setup script. Especially since it frees you from having to
argument in your setup script. Especially since it frees you from having to
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment