6 \title{Distributing Python Modules
}
9 \authoraddress{E-mail:
\email{gward@python.net
}}
18 This
document describes the Python Distribution Utilities
19 (``Distutils'') from the module developer's point-of-view, describing
20 how to use the Distutils to make Python modules and extensions easily
21 available to a wider audience with very little overhead for
22 build/release/install mechanics.
25 % The ugly "%begin{latexonly}" pseudo-environment supresses the table
26 % of contents for HTML generation.
33 \section{Introduction
}
36 In the past, Python module developers have not had much infrastructure
37 support for distributing modules, nor have Python users had much support
38 for installing and maintaining third-party modules. With the
39 introduction of the Python Distribution Utilities (Distutils for short)
40 in Python
1.6, this situation should start to improve.
42 This
document only covers using the Distutils to distribute your Python
43 modules. Using the Distutils does not tie you to Python
1.6, though:
44 the Distutils work just fine with Python
1.5.2, and it is reasonable
45 (and expected to become commonplace) to expect users of Python
1.5.2 to
46 download and install the Distutils separately before they can install
47 your modules. Python
1.6 (or later) users, of course, won't have to add
48 anything to their Python installation in order to use the Distutils to
49 install third-party modules.
51 This
document concentrates on the role of developer/distributor: if
52 you're looking for information on installing Python modules, you
53 should refer to the
\citetitle[../inst/inst.html
]{Installing Python
57 \section{Concepts \& Terminology
}
60 Using the Distutils is quite simple, both for module developers and for
61 users/administrators installing third-party modules. As a developer,
62 your responsibilities (apart from writing solid, well-documented and
63 well-tested code, of course!) are:
65 \item write a setup script (
\file{setup.py
} by convention)
66 \item (optional) write a setup configuration file
67 \item create a source distribution
68 \item (optional) create one or more built (binary) distributions
70 Each of these tasks is covered in this
document.
72 Not all module developers have access to a multitude of platforms, so
73 it's not always feasible to expect them to create a multitude of built
74 distributions. It is hoped that a class of intermediaries, called
75 \emph{packagers
}, will arise to address this need. Packagers will take
76 source distributions released by module developers, build them on one or
77 more platforms, and release the resulting built distributions. Thus,
78 users on the most popular platforms will be able to install most popular
79 Python module distributions in the most natural way for their platform,
80 without having to run a single setup script or compile a line of code.
83 \subsection{A simple example
}
84 \label{simple-example
}
86 The setup script is usually quite simple, although since it's written in
87 Python, there are no arbitrary limits to what you can do with
88 it.
\footnote{But be careful about putting arbitrarily expensive
89 operations in your setup script; unlike, say, Autoconf-style configure
90 scripts, the setup script may be run multiple times in the course of
91 building and installing your module distribution. If you need to
92 insert potentially expensive processing steps into the Distutils
93 chain, see section~
\ref{extending
} on extending the Distutils.
} If
94 all you want to do is distribute a module called
\module{foo
}, contained
95 in a file
\file{foo.py
}, then your setup script can be as little as
99 from distutils.core import setup
107 \item most information that you supply to the Distutils is supplied as
108 keyword arguments to the
\function{setup()
} function
109 \item those keyword arguments fall into two categories: package
110 meta-data (name, version number) and information about what's in the
111 package (a list of pure Python modules, in this case)
112 \item modules are specified by module name, not filename (the same will
113 hold true for packages and extensions)
114 \item it's recommended that you supply a little more meta-data, in
115 particular your name, email address and a URL for the project
116 (see section~
\ref{setup-script
} for an example)
119 To create a source distribution for this module, you would create a
120 setup script,
\file{setup.py
}, containing the above code, and run:
123 python setup.py sdist
126 which will create an archive file (e.g., tarball on
\UNIX, ZIP file on
127 Windows) containing your setup script,
\file{setup.py
}, and your module,
128 \file{foo.py
}. The archive file will be named
\file{Foo-
1.0.tar.gz
} (or
129 \file{.zip
}), and will unpack into a directory
\file{Foo-
1.0}.
131 If an end-user wishes to install your
\module{foo
} module, all she has
132 to do is download
\file{Foo-
1.0.tar.gz
} (or
\file{.zip
}), unpack it,
133 and---from the
\file{Foo-
1.0} directory---run
136 python setup.py install
139 which will ultimately copy
\file{foo.py
} to the appropriate directory
140 for third-party modules in their Python installation.
142 This simple example demonstrates some fundamental concepts of the
143 Distutils: first, both developers and installers have the same basic
144 user interface, i.e. the setup script. The difference is which
145 Distutils
\emph{commands
} they use: the
\command{sdist
} command is
146 almost exclusively for module developers, while
\command{install
} is
147 more often for installers (although most developers will want to install
148 their own code occasionally).
150 If you want to make things really easy for your users, you can create
151 one or more built distributions for them. For instance, if you are
152 running on a Windows machine, and want to make things easy for other
153 Windows users, you can create an executable installer (the most
154 appropriate type of built distribution for this platform) with the
155 \command{bdist
\_wininst} command. For example:
158 python setup.py bdist_wininst
161 will create an executable installer,
\file{Foo-
1.0.win32.exe
}, in the
164 Currently (Distutils
0.9.2), the only other useful built
165 distribution format is RPM, implemented by the
\command{bdist
\_rpm}
166 command. For example, the following command will create an RPM file
167 called
\file{Foo-
1.0.noarch.rpm
}:
170 python setup.py bdist_rpm
173 (This uses the
\command{rpm
} command, so has to be run on an RPM-based
174 system such as Red Hat Linux, SuSE Linux, or Mandrake Linux.)
176 You can find out what distribution formats are available at any time by
180 python setup.py bdist --help-formats
184 \subsection{General Python terminology
}
187 If you're reading this
document, you probably have a good idea of what
188 modules, extensions, and so forth are. Nevertheless, just to be sure
189 that everyone is operating from a common starting point, we offer the
190 following glossary of common Python terms:
192 \item[module
] the basic unit of code reusability in Python: a block of
193 code imported by some other code. Three types of modules concern us
194 here: pure Python modules, extension modules, and packages.
195 \item[pure Python module
] a module written in Python and contained in a
196 single
\file{.py
} file (and possibly associated
\file{.pyc
} and/or
197 \file{.pyo
} files). Sometimes referred to as a ``pure module.''
198 \item[extension module
] a module written in the low-level language of
199 the Python implementation: C/C++ for Python, Java for JPython.
200 Typically contained in a single dynamically loadable pre-compiled
201 file, e.g. a shared object (
\file{.so
}) file for Python extensions on
202 \UNIX, a DLL (given the
\file{.pyd
} extension) for Python extensions
203 on Windows, or a Java class file for JPython extensions. (Note that
204 currently, the Distutils only handles C/C++ extensions for Python.)
205 \item[package
] a module that contains other modules; typically contained
206 in a directory in the filesystem and distinguished from other
207 directories by the presence of a file
\file{\_\_init\_\_.py
}.
208 \item[root package
] the root of the hierarchy of packages. (This isn't
209 really a package, since it doesn't have an
\file{\_\_init\_\_.py
}
210 file. But we have to call it something.) The vast majority of the
211 standard library is in the root package, as are many small, standalone
212 third-party modules that don't belong to a larger module collection.
213 Unlike regular packages, modules in the root package can be found in
214 many directories: in fact, every directory listed in
\code{sys.path
}
215 can contribute modules to the root package.
219 \subsection{Distutils-specific terminology
}
220 \label{distutils-term
}
222 The following terms apply more specifically to the domain of
223 distributing Python modules using the Distutils:
225 \item[module distribution
] a collection of Python modules distributed
226 together as a single downloadable resource and meant to be installed
227 \emph{en masse
}. Examples of some well-known module distributions are
228 Numeric Python, PyXML, PIL (the Python Imaging Library), or
229 mxDateTime. (This would be called a
\emph{package
}, except that term
230 is already taken in the Python context: a single module distribution
231 may contain zero, one, or many Python packages.)
232 \item[pure module distribution
] a module distribution that contains only
233 pure Python modules and packages. Sometimes referred to as a ``pure
235 \item[non-pure module distribution
] a module distribution that contains
236 at least one extension module. Sometimes referred to as a ``non-pure
238 \item[distribution root
] the top-level directory of your source tree (or
239 source distribution); the directory where
\file{setup.py
} exists and
244 \section{Writing the Setup Script
}
247 The setup script is the centre of all activity in building,
248 distributing, and installing modules using the Distutils. The main
249 purpose of the setup script is to describe your module distribution to
250 the Distutils, so that the various commands that operate on your modules
251 do the right thing. As we saw in section~
\ref{simple-example
} above,
252 the setup script consists mainly of a call to
\function{setup()
}, and
253 most information supplied to the Distutils by the module developer is
254 supplied as keyword arguments to
\function{setup()
}.
256 Here's a slightly more involved example, which we'll follow for the next
257 couple of sections: the Distutils' own setup script. (Keep in mind that
258 although the Distutils are included with Python
1.6 and later, they also
259 have an independent existence so that Python
1.5.2 users can use them to
260 install other module distributions. The Distutils' own setup script,
261 shown here, is used to install the package into Python
1.5.2.)
264 #!/usr/bin/env python
266 from distutils.core import setup
268 setup(name="Distutils",
270 description="Python Distribution Utilities",
272 author_email="gward@python.net",
273 url="http://www.python.org/sigs/distutils-sig/",
274 packages=
['distutils', 'distutils.command'
],
278 There are only two differences between this and the trivial one-file
279 distribution presented in section~
\ref{simple-example
}: more
280 meta-data, and the specification of pure Python modules by package,
281 rather than by module. This is important since the Distutils consist of
282 a couple of dozen modules split into (so far) two packages; an explicit
283 list of every module would be tedious to generate and difficult to
286 Note that any pathnames (files or directories) supplied in the setup
287 script should be written using the
\UNIX{} convention, i.e.
288 slash-separated. The Distutils will take care of converting this
289 platform-neutral representation into whatever is appropriate on your
290 current platform before actually using the pathname. This makes your
291 setup script portable across operating systems, which of course is one
292 of the major goals of the Distutils. In this spirit, all pathnames in
293 this
document are slash-separated (MacOS programmers should keep in
294 mind that the
\emph{absence
} of a leading slash indicates a relative
295 path, the opposite of the MacOS convention with colons).
297 This, of course, only applies to pathnames given to Distutils functions.
298 If you, for example, use standard python functions such as glob.glob
299 or os.listdir to specify files, you should be careful to write portable
300 code instead of hardcoding path separators:
303 glob.glob(os.path.join('mydir', 'subdir', '*.html'))
304 os.listdir(os.path.join('mydir', 'subdir'))
307 \subsection{Listing whole packages
}
308 \label{listing-packages
}
310 The
\option{packages
} option tells the Distutils to process (build,
311 distribute, install, etc.) all pure Python modules found in each package
312 mentioned in the
\option{packages
} list. In order to do this, of
313 course, there has to be a correspondence between package names and
314 directories in the filesystem. The default correspondence is the most
315 obvious one, i.e. package
\module{distutils
} is found in the directory
316 \file{distutils
} relative to the distribution root. Thus, when you say
317 \code{packages =
['foo'
]} in your setup script, you are promising that
318 the Distutils will find a file
\file{foo/
\_\_init\_\_.py
} (which might
319 be spelled differently on your system, but you get the idea) relative to
320 the directory where your setup script lives. (If you break this
321 promise, the Distutils will issue a warning but process the broken
324 If you use a different convention to lay out your source directory,
325 that's no problem: you just have to supply the
\option{package
\_dir}
326 option to tell the Distutils about your convention. For example, say
327 you keep all Python source under
\file{lib
}, so that modules in the
328 ``root package'' (i.e., not in any package at all) are right in
329 \file{lib
}, modules in the
\module{foo
} package are in
\file{lib/foo
},
330 and so forth. Then you would put
333 package_dir =
{'': 'lib'
}
336 in your setup script. (The keys to this dictionary are package names,
337 and an empty package name stands for the root package. The values are
338 directory names relative to your distribution root.) In this case, when
339 you say
\code{packages =
['foo'
]}, you are promising that the file
340 \file{lib/foo/
\_\_init\_\_.py
} exists.
342 Another possible convention is to put the
\module{foo
} package right in
343 \file{lib
}, the
\module{foo.bar
} package in
\file{lib/bar
}, etc. This
344 would be written in the setup script as
347 package_dir =
{'foo': 'lib'
}
350 A
\code{\var{package
}:
\var{dir
}} entry in the
\option{package
\_dir}
351 dictionary implicitly applies to all packages below
\var{package
}, so
352 the
\module{foo.bar
} case is automatically handled here. In this
353 example, having
\code{packages =
['foo', 'foo.bar'
]} tells the Distutils
354 to look for
\file{lib/
\_\_init\_\_.py
} and
355 \file{lib/bar/
\_\_init\_\_.py
}. (Keep in mind that although
356 \option{package
\_dir} applies recursively, you must explicitly list all
357 packages in
\option{packages
}: the Distutils will
\emph{not
} recursively
358 scan your source tree looking for any directory with an
359 \file{\_\_init\_\_.py
} file.)
362 \subsection{Listing individual modules
}
363 \label{listing-modules
}
365 For a small module distribution, you might prefer to list all modules
366 rather than listing packages---especially the case of a single module
367 that goes in the ``root package'' (i.e., no package at all). This
368 simplest case was shown in section~
\ref{simple-example
}; here is a
369 slightly more involved example:
372 py_modules =
['mod1', 'pkg.mod2'
]
375 This describes two modules, one of them in the ``root'' package, the
376 other in the
\module{pkg
} package. Again, the default package/directory
377 layout implies that these two modules can be found in
\file{mod1.py
} and
378 \file{pkg/mod2.py
}, and that
\file{pkg/
\_\_init\_\_.py
} exists as well.
379 And again, you can override the package/directory correspondence using
380 the
\option{package
\_dir} option.
383 \subsection{Describing extension modules
}
384 \label{describing-extensions
}
386 Just as writing Python extension modules is a bit more complicated than
387 writing pure Python modules, describing them to the Distutils is a bit
388 more complicated. Unlike pure modules, it's not enough just to list
389 modules or packages and expect the Distutils to go out and find the
390 right files; you have to specify the extension name, source file(s), and
391 any compile/link requirements (include directories, libraries to link
394 All of this is done through another keyword argument to
395 \function{setup()
}, the
\option{extensions
} option.
\option{extensions
}
396 is just a list of
\class{Extension
} instances, each of which describes a
397 single extension module. Suppose your distribution includes a single
398 extension, called
\module{foo
} and implemented by
\file{foo.c
}. If no
399 additional instructions to the compiler/linker are needed, describing
400 this extension is quite simple:
403 Extension("foo",
["foo.c"
])
406 The
\class{Extension
} class can be imported from
407 \module{distutils.core
}, along with
\function{setup()
}. Thus, the setup
408 script for a module distribution that contains only this one extension
409 and nothing else might be:
412 from distutils.core import setup, Extension
413 setup(name="foo", version="
1.0",
414 ext_modules=
[Extension("foo",
["foo.c"
])
])
417 The
\class{Extension
} class (actually, the underlying extension-building
418 machinery implemented by the
\command{build
\_ext} command) supports a
419 great deal of flexibility in describing Python extensions, which is
420 explained in the following sections.
423 \subsubsection{Extension names and packages
}
425 The first argument to the
\class{Extension
} constructor is always the
426 name of the extension, including any package names. For example,
429 Extension("foo",
["src/foo1.c", "src/foo2.c"
])
432 describes an extension that lives in the root package, while
435 Extension("pkg.foo",
["src/foo1.c", "src/foo2.c"
])
438 describes the same extension in the
\module{pkg
} package. The source
439 files and resulting object code are identical in both cases; the only
440 difference is where in the filesystem (and therefore where in Python's
441 namespace hierarchy) the resulting extension lives.
443 If you have a number of extensions all in the same package (or all under
444 the same base package), use the
\option{ext
\_package} keyword argument
445 to
\function{setup()
}. For example,
450 ext_modules=
[Extension("foo",
["foo.c"
]),
451 Extension("subpkg.bar",
["bar.c"
])
]
455 will compile
\file{foo.c
} to the extension
\module{pkg.foo
}, and
456 \file{bar.c
} to
\module{pkg.subpkg.bar
}.
459 \subsubsection{Extension source files
}
461 The second argument to the
\class{Extension
} constructor is a list of
462 source files. Since the Distutils currently only support C/C++
463 extensions, these are normally C/C++ source files. (Be sure to use
464 appropriate extensions to distinguish C++ source files:
\file{.cc
} and
465 \file{.cpp
} seem to be recognized by both
\UNIX{} and Windows compilers.)
467 However, you can also include SWIG interface (
\file{.i
}) files in the
468 list; the
\command{build
\_ext} command knows how to deal with SWIG
469 extensions: it will run SWIG on the interface file and compile the
470 resulting C/C++ file into your extension.
472 \XXX{SWIG support is rough around the edges and largely untested;
473 especially SWIG support of C++ extensions! Explain in more detail
474 here when the interface firms up.
}
476 On some platforms, you can include non-source files that are processed
477 by the compiler and included in your extension. Currently, this just
478 means Windows message text (
\file{.mc
}) files and resource definition
479 (
\file{.rc
}) files for Visual C++. These will be compiled to binary resource
480 (
\file{.res
}) files and linked into the executable.
483 \subsubsection{Preprocessor options
}
485 Three optional arguments to
\class{Extension
} will help if you need to
486 specify include directories to search or preprocessor macros to
487 define/undefine:
\code{include
\_dirs},
\code{define
\_macros}, and
488 \code{undef
\_macros}.
490 For example, if your extension requires header files in the
491 \file{include
} directory under your distribution root, use the
492 \code{include
\_dirs} option:
495 Extension("foo",
["foo.c"
], include_dirs=
["include"
])
498 You can specify absolute directories there; if you know that your
499 extension will only be built on
\UNIX{} systems with X11R6 installed to
500 \file{/usr
}, you can get away with
503 Extension("foo",
["foo.c"
], include_dirs=
["/usr/include/X11"
])
506 You should avoid this sort of non-portable usage if you plan to
507 distribute your code: it's probably better to write your code to include
508 (e.g.)
\code{<X11/Xlib.h>
}.
510 If you need to include header files from some other Python extension,
511 you can take advantage of the fact that the Distutils install extension
512 header files in a consistent way. For example, the Numerical Python
513 header files are installed (on a standard
\UNIX{} installation) to
514 \file{/usr/local/include/python1.5/Numerical
}. (The exact location will
515 differ according to your platform and Python installation.) Since the
516 Python include directory---
\file{/usr/local/include/python1.5
} in this
517 case---is always included in the search path when building Python
518 extensions, the best approach is to include (e.g.)
519 \code{<Numerical/arrayobject.h>
}. If you insist on putting the
520 \file{Numerical
} include directory right into your header search path,
521 though, you can find that directory using the Distutils
522 \module{sysconfig
} module:
525 from distutils.sysconfig import get_python_inc
526 incdir = os.path.join(get_python_inc(plat_specific=
1), "Numerical")
528 Extension(..., include_dirs=
[incdir
]))
531 Even though this is quite portable---it will work on any Python
532 installation, regardless of platform---it's probably easier to just
533 write your C code in the sensible way.
535 You can define and undefine pre-processor macros with the
536 \code{define
\_macros} and
\code{undef
\_macros} options.
537 \code{define
\_macros} takes a list of
\code{(name, value)
} tuples, where
538 \code{name
} is the name of the macro to define (a string) and
539 \code{value
} is its value: either a string or
\code{None
}. (Defining a
540 macro
\code{FOO
} to
\code{None
} is the equivalent of a bare
541 \code{\#define FOO
} in your C source: with most compilers, this sets
542 \code{FOO
} to the string
\code{1}.)
\code{undef
\_macros} is just
543 a list of macros to undefine.
549 define_macros=
[('NDEBUG', '
1')
],
550 ('HAVE_STRFTIME', None),
551 undef_macros=
['HAVE_FOO', 'HAVE_BAR'
])
554 is the equivalent of having this at the top of every C source file:
558 #define HAVE_STRFTIME
564 \subsubsection{Library options
}
566 You can also specify the libraries to link against when building your
567 extension, and the directories to search for those libraries. The
568 \code{libraries
} option is a list of libraries to link against,
569 \code{library
\_dirs} is a list of directories to search for libraries at
570 link-time, and
\code{runtime
\_library\_dirs} is a list of directories to
571 search for shared (dynamically loaded) libraries at run-time.
573 For example, if you need to link against libraries known to be in the
574 standard library search path on target systems
578 libraries=
["gdbm", "readline"
])
581 If you need to link with libraries in a non-standard location, you'll
582 have to include the location in
\code{library
\_dirs}:
586 library_dirs=
["/usr/X11R6/lib"
],
587 libraries=
["X11", "Xt"
])
590 (Again, this sort of non-portable construct should be avoided if you
591 intend to distribute your code.)
593 \XXX{Should mention clib libraries here or somewhere else!
}
595 \subsubsection{Other options
}
597 There are still some other options which can be used to handle special
600 The
\option{extra
\_objects} option is a list of object files to be passed
601 to the linker. These files must not have extensions, as the default
602 extension for the compiler is used.
604 \option{extra
\_compile\_args} and
\option{extra
\_link\_args} can be used
605 to specify additional command line options for the compiler resp.
606 the linker command line.
608 \option{export
\_symbols} is only useful on windows, it can contain a list
609 of symbols (functions or variables) to be exported. This option
610 is not needed when building compiled extensions: the
\code{initmodule
}
611 function will automatically be added to the exported symbols list
614 \subsection{Listing scripts
}
615 So far we have been dealing with pure and non-pure Python modules,
616 which are usually not run by themselves but imported by scripts.
618 Scripts are files containing Python source code, indended to be started
619 from the command line.
620 Distutils doesn't provide much functionality for the scripts: the only
621 support Distutils gives is to adjust the first line of the script
622 if it starts with
\code{\#!
} and contains the word ``python'' to refer
623 to the current interpreter location.
625 The
\option{scripts
} option simply is a list of files to be handled
629 \subsection{Listing additional files
}
631 The
\option{data
\_files} option can be used to specify additional
632 files needed by the module distribution: configuration files,
633 data files, anything which does not fit in the previous categories.
635 \option{data
\_files} specify a sequence of
\code{(directory, files)
}
636 pairs in the following way:
640 data_files=
[('bitmaps',
['bm/b1.gif', 'bm/b2.gif'
]),
641 ('config',
['cfg/data.cfg'
])
])
644 Note that you can specify the directory names where the data files
645 will be installed, but you cannot rename the data files themselves.
647 You can specify the
\option{data
\_files} options as a simple sequence
648 of files without specifying a target directory, but this is not recommended,
649 and the
\command{install
} command will print a warning in this case.
650 To install data files directly in the target directory, an empty
651 string should be given as the directory.
654 \section{Writing the Setup Configuration File
}
657 Often, it's not possible to write down everything needed to build a
658 distribution
\emph{a priori
}: you may need to get some information from
659 the user, or from the user's system, in order to proceed. As long as
660 that information is fairly simple---a list of directories to search for
661 C header files or libraries, for example---then providing a
662 configuration file,
\file{setup.cfg
}, for users to edit is a cheap and
663 easy way to solicit it. Configuration files also let you provide
664 default values for any command option, which the installer can then
665 override either on the command-line or by editing the config file.
667 (If you have more advanced needs, such as determining which extensions
668 to build based on what capabilities are present on the target system,
669 then you need the Distutils ``auto-configuration'' facility. This
670 started to appear in Distutils
0.9 but, as of this writing, isn't mature
671 or stable enough yet for real-world use.)
673 The setup configuration file is a useful middle-ground between the setup
674 script---which, ideally, would be opaque to installers
\footnote{This
675 ideal probably won't be achieved until auto-configuration is fully
676 supported by the Distutils.
}---and the command-line to the setup
677 script, which is outside of your control and entirely up to the
678 installer. In fact,
\file{setup.cfg
} (and any other Distutils
679 configuration files present on the target system) are processed after
680 the contents of the setup script, but before the command-line. This has
681 several useful consequences:
683 \item installers can override some of what you put in
\file{setup.py
} by
684 editing
\file{setup.cfg
}
685 \item you can provide non-standard defaults for options that are not
686 easily set in
\file{setup.py
}
687 \item installers can override anything in
\file{setup.cfg
} using the
688 command-line options to
\file{setup.py
}
691 The basic syntax of the configuration file is simple:
699 where
\var{command
} is one of the Distutils commands (e.g.
700 \command{build
\_py},
\command{install
}), and
\var{option
} is one of the
701 options that command supports. Any number of options can be supplied
702 for each command, and any number of command sections can be included in
703 the file. Blank lines are ignored, as are comments (from a
704 \character{\#
} character to end-of-line). Long option values can be
705 split across multiple lines simply by indenting the continuation lines.
707 You can find out the list of options supported by a particular command
708 with the universal
\longprogramopt{help
} option, e.g.
711 > python setup.py --help build_ext
713 Options for 'build_ext' command:
714 --build-lib (-b) directory for compiled extension modules
715 --build-temp (-t) directory for temporary files (build by-products)
716 --inplace (-i) ignore build-lib and put compiled extensions into the
717 source directory alongside your pure Python modules
718 --include-dirs (-I) list of directories to search for header files
719 --define (-D) C preprocessor macros to define
720 --undef (-U) C preprocessor macros to undefine
724 Or consult section
\ref{reference
} of this
document (the command
727 Note that an option spelled
\longprogramopt{foo-bar
} on the command-line
728 is spelled
\option{foo
\_bar} in configuration files.
730 For example, say you want your extensions to be built
731 ``in-place''---that is, you have an extension
\module{pkg.ext
}, and you
732 want the compiled extension file (
\file{ext.so
} on
\UNIX, say) to be put
733 in the same source directory as your pure Python modules
734 \module{pkg.mod1
} and
\module{pkg.mod2
}. You can always use the
735 \longprogramopt{inplace
} option on the command-line to ensure this:
738 python setup.py build_ext --inplace
741 But this requires that you always specify the
\command{build
\_ext}
742 command explicitly, and remember to provide
\longprogramopt{inplace
}.
743 An easier way is to ``set and forget'' this option, by encoding it in
744 \file{setup.cfg
}, the configuration file for this distribution:
751 This will affect all builds of this module distribution, whether or not
752 you explcitly specify
\command{build
\_ext}. If you include
753 \file{setup.cfg
} in your source distribution, it will also affect
754 end-user builds---which is probably a bad idea for this option, since
755 always building extensions in-place would break installation of the
756 module distribution. In certain peculiar cases, though, modules are
757 built right in their installation directory, so this is conceivably a
758 useful ability. (Distributing extensions that expect to be built in
759 their installation directory is almost always a bad idea, though.)
761 Another example: certain commands take a lot of options that don't
762 change from run-to-run; for example,
\command{bdist
\_rpm} needs to know
763 everything required to generate a ``spec'' file for creating an RPM
764 distribution. Some of this information comes from the setup script, and
765 some is automatically generated by the Distutils (such as the list of
766 files installed). But some of it has to be supplied as options to
767 \command{bdist
\_rpm}, which would be very tedious to do on the
768 command-line for every run. Hence, here is a snippet from the
769 Distutils' own
\file{setup.cfg
}:
774 packager = Greg Ward <gward@python.net>
775 doc_files = CHANGES.txt
782 Note that the
\option{doc
\_files} option is simply a
783 whitespace-separated string split across multiple lines for readability.
787 \seetitle[../inst/config-syntax.html
]{Installing Python
788 Modules
}{More information on the configuration files is
789 available in the manual for system administrators.
}
793 \section{Creating a Source Distribution
}
796 As shown in section~
\ref{simple-example
}, you use the
797 \command{sdist
} command to create a source distribution. In the
801 python setup.py sdist
804 (assuming you haven't specified any
\command{sdist
} options in the setup
805 script or config file),
\command{sdist
} creates the archive of the
806 default format for the current platform. The default format is gzip'ed
807 tar file (
\file{.tar.gz
}) on
\UNIX, and ZIP file on Windows.
808 \XXX{no MacOS support here
}
810 You can specify as many formats as you like using the
811 \longprogramopt{formats
} option, for example:
814 python setup.py sdist --formats=gztar,zip
817 to create a gzipped tarball and a zip file. The available formats are:
818 \begin{tableiii
}{l|l|c
}{code
}%
819 {Format
}{Description
}{Notes
}
820 \lineiii{zip
}{zip file (
\file{.zip
})
}{(
1),(
3)
}
821 \lineiii{gztar
}{gzip'ed tar file (
\file{.tar.gz
})
}{(
2),(
4)
}
822 \lineiii{bztar
}{bzip2'ed tar file (
\file{.tar.gz
})
}{(
4)
}
823 \lineiii{ztar
}{compressed tar file (
\file{.tar.Z
})
}{(
4)
}
824 \lineiii{tar
}{tar file (
\file{.tar
})
}{(
4)
}
829 \item[(
1)
] default on Windows
830 \item[(
2)
] default on
\UNIX
831 \item[(
3)
] requires either external
\program{zip
} utility or
832 \module{zipfile
} module (not part of the standard Python library)
833 \item[(
4)
] requires external utilities:
\program{tar
} and possibly one
834 of
\program{gzip
},
\program{bzip2
}, or
\program{compress
}
839 \subsection{Specifying the files to distribute
}
842 If you don't supply an explicit list of files (or instructions on how to
843 generate one), the
\command{sdist
} command puts a minimal default set
844 into the source distribution:
846 \item all Python source files implied by the
\option{py
\_modules} and
847 \option{packages
} options
848 \item all C source files mentioned in the
\option{ext
\_modules} or
849 \option{libraries
} options (
\XXX{getting C library sources currently
850 broken -- no get
\_source\_files() method in build
\_clib.py!
})
851 \item anything that looks like a test script:
\file{test/test*.py
}
852 (currently, the Distutils don't do anything with test scripts except
853 include them in source distributions, but in the future there will be
854 a standard for testing Python module distributions)
855 \item \file{README.txt
} (or
\file{README
}),
\file{setup.py
} (or whatever
856 you called your setup script), and
\file{setup.cfg
}
858 Sometimes this is enough, but usually you will want to specify
859 additional files to distribute. The typical way to do this is to write
860 a
\emph{manifest template
}, called
\file{MANIFEST.in
} by default. The
861 manifest template is just a list of instructions for how to generate
862 your manifest file,
\file{MANIFEST
}, which is the exact list of files to
863 include in your source distribution. The
\command{sdist
} command
864 processes this template and generates a manifest based on its
865 instructions and what it finds in the filesystem.
867 If you prefer to roll your own manifest file, the format is simple: one
868 filename per line, regular files (or symlinks to them) only. If you do
869 supply your own
\file{MANIFEST
}, you must specify everything: the
870 default set of files described above does not apply in this case.
872 The manifest template has one command per line, where each command
873 specifies a set of files to include or exclude from the source
874 distribution. For an example, again we turn to the Distutils' own
879 recursive-include examples *.txt *.py
880 prune examples/sample?/build
883 The meanings should be fairly clear: include all files in the
884 distribution root matching
\code{*.txt
}, all files anywhere under the
885 \file{examples
} directory matching
\code{*.txt
} or
\code{*.py
}, and
886 exclude all directories matching
\code{examples/sample?/build
}. All of
887 this is done
\emph{after
} the standard include set, so you can exclude
888 files from the standard set with explicit instructions in the manifest
889 template. (Or, you can use the
\longprogramopt{no-defaults
} option to
890 disable the standard set entirely.) There are several other commands
891 available in the manifest template mini-language; see
892 section~
\ref{sdist-cmd
}.
894 The order of commands in the manifest template matters: initially, we
895 have the list of default files as described above, and each command in
896 the template adds to or removes from that list of files. Once we have
897 fully processed the manifest template, we remove files that should not
898 be included in the source distribution:
900 \item all files in the Distutils ``build'' tree (default
\file{build/
})
901 \item all files in directories named
\file{RCS
} or
\file{CVS
}
903 Now we have our complete list of files, which is written to the manifest
904 for future reference, and then used to build the source distribution
907 You can disable the default set of included files with the
908 \longprogramopt{no-defaults
} option, and you can disable the standard
909 exclude set with
\longprogramopt{no-prune
}.
911 Following the Distutils' own manifest template, let's trace how the
912 \command{sdist
} command builds the list of files to include in the
913 Distutils source distribution:
915 \item include all Python source files in the
\file{distutils
} and
916 \file{distutils/command
} subdirectories (because packages
917 corresponding to those two directories were mentioned in the
918 \option{packages
} option in the setup script---see
919 section~
\ref{setup-script
})
920 \item include
\file{README.txt
},
\file{setup.py
}, and
\file{setup.cfg
}
922 \item include
\file{test/test*.py
} (standard files)
923 \item include
\file{*.txt
} in the distribution root (this will find
924 \file{README.txt
} a second time, but such redundancies are weeded out
926 \item include anything matching
\file{*.txt
} or
\file{*.py
} in the
927 sub-tree under
\file{examples
},
928 \item exclude all files in the sub-trees starting at directories
929 matching
\file{examples/sample?/build
}---this may exclude files
930 included by the previous two steps, so it's important that the
931 \code{prune
} command in the manifest template comes after the
932 \code{recursive-include
} command
933 \item exclude the entire
\file{build
} tree, and any
\file{RCS
} or
934 \file{CVS
} directories
936 Just like in the setup script, file and directory names in the manifest
937 template should always be slash-separated; the Distutils will take care
938 of converting them to the standard representation on your platform.
939 That way, the manifest template is portable across operating systems.
942 \subsection{Manifest-related options
}
943 \label{manifest-options
}
945 The normal course of operations for the
\command{sdist
} command is as
948 \item if the manifest file,
\file{MANIFEST
} doesn't exist, read
949 \file{MANIFEST.in
} and create the manifest
950 \item if neither
\file{MANIFEST
} nor
\file{MANIFEST.in
} exist, create a
951 manifest with just the default file set
\footnote{In versions of the
952 Distutils up to and including
0.9.2 (Python
2.0b1), this feature was
953 broken; use the
\programopt{-f
} (
\longprogramopt{force-manifest
})
954 option to work around the bug.
}
955 \item if either
\file{MANIFEST.in
} or the setup script (
\file{setup.py
})
956 are more recent than
\file{MANIFEST
}, recreate
\file{MANIFEST
} by
957 reading
\file{MANIFEST.in
}
958 \item use the list of files now in
\file{MANIFEST
} (either just
959 generated or read in) to create the source distribution archive(s)
961 There are a couple of options that modify this behaviour. First, use
962 the
\longprogramopt{no-defaults
} and
\longprogramopt{no-prune
} to
963 disable the standard ``include'' and ``exclude'' sets.
\footnote{Note
964 that if you have no manifest template, no manifest, and use the
965 \longprogramopt{no-defaults
}, you will get an empty manifest. Another
966 bug in Distutils
0.9.2 and earlier causes an uncaught exception in
967 this case. The workaround is: Don't Do That.
}
969 Second, you might want to force the manifest to be regenerated---for
970 example, if you have added or removed files or directories that match an
971 existing pattern in the manifest template, you should regenerate the
975 python setup.py sdist --force-manifest
978 Or, you might just want to (re)generate the manifest, but not create a
982 python setup.py sdist --manifest-only
985 \longprogramopt{manifest-only
} implies
\longprogramopt{force-manifest
}.
986 \programopt{-o
} is a shortcut for
\longprogramopt{manifest-only
}, and
987 \programopt{-f
} for
\longprogramopt{force-manifest
}.
990 \section{Creating Built Distributions
}
993 A ``built distribution'' is what you're probably used to thinking of
994 either as a ``binary package'' or an ``installer'' (depending on your
995 background). It's not necessarily binary, though, because it might
996 contain only Python source code and/or byte-code; and we don't call it a
997 package, because that word is already spoken for in Python. (And
998 ``installer'' is a term specific to the Windows world.
\XXX{do Mac
1001 A built distribution is how you make life as easy as possible for
1002 installers of your module distribution: for users of RPM-based Linux
1003 systems, it's a binary RPM; for Windows users, it's an executable
1004 installer; for Debian-based Linux users, it's a Debian package; and so
1005 forth. Obviously, no one person will be able to create built
1006 distributions for every platform under the sun, so the Distutils are
1007 designed to enable module developers to concentrate on their
1008 specialty---writing code and creating source distributions---while an
1009 intermediary species of
\emph{packager
} springs up to turn source
1010 distributions into built distributions for as many platforms as there
1013 Of course, the module developer could be his own packager; or the
1014 packager could be a volunteer ``out there'' somewhere who has access to
1015 a platform which the original developer does not; or it could be
1016 software periodically grabbing new source distributions and turning them
1017 into built distributions for as many platforms as the software has
1018 access to. Regardless of the nature of the beast, a packager uses the
1019 setup script and the
\command{bdist
} command family to generate built
1022 As a simple example, if I run the following command in the Distutils
1026 python setup.py bdist
1029 then the Distutils builds my module distribution (the Distutils itself
1030 in this case), does a ``fake'' installation (also in the
\file{build
}
1031 directory), and creates the default type of built distribution for my
1032 platform. The default format for built distributions is a ``dumb'' tar
1033 file on
\UNIX, and an simple executable installer on Windows. (That tar
1034 file is considered ``dumb'' because it has to be unpacked in a specific
1037 Thus, the above command on a
\UNIX{} system creates
1038 \file{Distutils-
0.9.1.
\filevar{plat
}.tar.gz
}; unpacking this tarball
1039 from the right place installs the Distutils just as though you had
1040 downloaded the source distribution and run
\code{python setup.py
1041 install
}. (The ``right place'' is either the root of the filesystem or
1042 Python's
\filevar{prefix
} directory, depending on the options given to
1043 the
\command{bdist
\_dumb} command; the default is to make dumb
1044 distributions relative to
\filevar{prefix
}.)
1046 Obviously, for pure Python distributions, this isn't a huge win---but
1047 for non-pure distributions, which include extensions that would need to
1048 be compiled, it can mean the difference between someone being able to
1049 use your extensions or not. And creating ``smart'' built distributions,
1050 such as an RPM package or an executable installer for Windows, is a big
1051 win for users even if your distribution doesn't include any extensions.
1053 The
\command{bdist
} command has a
\longprogramopt{formats
} option,
1054 similar to the
\command{sdist
} command, which you can use to select the
1055 types of built distribution to generate: for example,
1058 python setup.py bdist --format=zip
1061 would, when run on a
\UNIX{} system, create
1062 \file{Distutils-
0.8.
\filevar{plat
}.zip
}---again, this archive would be
1063 unpacked from the root directory to install the Distutils.
1065 The available formats for built distributions are:
1066 \begin{tableiii
}{l|l|c
}{code
}%
1067 {Format
}{Description
}{Notes
}
1068 \lineiii{gztar
}{gzipped tar file (
\file{.tar.gz
})
}{(
1),(
3)
}
1069 \lineiii{ztar
}{compressed tar file (
\file{.tar.Z
})
}{(
3)
}
1070 \lineiii{tar
}{tar file (
\file{.tar
})
}{(
3)
}
1071 \lineiii{zip
}{zip file (
\file{.zip
})
}{(
4)
}
1072 \lineiii{rpm
}{RPM
}{(
5)
}
1073 \lineiii{srpm
}{source RPM
}{(
5)
\XXX{to do!
}}
1074 \lineiii{wininst
}{self-extracting ZIP file for Windows
}{(
2),(
4)
}
1079 \item[(
1)
] default on
\UNIX
1080 \item[(
2)
] default on Windows
\XXX{to-do!
}
1081 \item[(
3)
] requires external utilities:
\program{tar
} and possibly one
1082 of
\program{gzip
},
\program{bzip2
}, or
\program{compress
}
1083 \item[(
4)
] requires either external
\program{zip
} utility or
1084 \module{zipfile
} module (not part of the standard Python library)
1085 \item[(
5)
] requires external
\program{rpm
} utility, version
3.0.4 or
1086 better (use
\code{rpm --version
} to find out which version you have)
1089 You don't have to use the
\command{bdist
} command with the
1090 \longprogramopt{formats
} option; you can also use the command that
1091 directly implements the format you're interested in. Some of these
1092 \command{bdist
} ``sub-commands'' actually generate several similar
1093 formats; for instance, the
\command{bdist
\_dumb} command generates all
1094 the ``dumb'' archive formats (
\code{tar
},
\code{ztar
},
\code{gztar
}, and
1095 \code{zip
}), and
\command{bdist
\_rpm} generates both binary and source
1096 RPMs. The
\command{bdist
} sub-commands, and the formats generated by
1098 \begin{tableii
}{l|l
}{command
}%
1100 \lineii{bdist
\_dumb}{tar, ztar, gztar, zip
}
1101 \lineii{bdist
\_rpm}{rpm, srpm
}
1102 \lineii{bdist
\_wininst}{wininst
}
1105 The following sections give details on the individual
\command{bdist
\_*
}
1109 \subsection{Creating dumb built distributions
}
1110 \label{creating-dumb
}
1112 \XXX{Need to
document absolute vs. prefix-relative packages here, but
1113 first I have to implement it!
}
1116 \subsection{Creating RPM packages
}
1117 \label{creating-rpms
}
1119 The RPM format is used by many of popular Linux distributions, including
1120 Red Hat, SuSE, and Mandrake. If one of these (or any of the other
1121 RPM-based Linux distributions) is your usual environment, creating RPM
1122 packages for other users of that same distribution is trivial.
1123 Depending on the complexity of your module distribution and differences
1124 between Linux distributions, you may also be able to create RPMs that
1125 work on different RPM-based distributions.
1127 The usual way to create an RPM of your module distribution is to run the
1128 \command{bdist
\_rpm} command:
1131 python setup.py bdist_rpm
1134 or the
\command{bdist
} command with the
\longprogramopt{format
} option:
1137 python setup.py bdist --formats=rpm
1140 The former allows you to specify RPM-specific options; the latter allows
1141 you to easily specify multiple formats in one run. If you need to do
1142 both, you can explicitly specify multiple
\command{bdist
\_*
} commands
1146 python setup.py bdist_rpm --packager="John Doe <jdoe@python.net>" \
1147 bdist_wininst --target_version="
2.0"
1150 Creating RPM packages is driven by a
\file{.spec
} file, much as using
1151 the Distutils is driven by the setup script. To make your life easier,
1152 the
\command{bdist
\_rpm} command normally creates a
\file{.spec
} file
1153 based on the information you supply in the setup script, on the command
1154 line, and in any Distutils configuration files. Various options and
1155 sections in the
\file{.spec
} file are derived from options in the setup
1157 \begin{tableii
}{l|l
}{textrm
}%
1158 {RPM
\file{.spec
} file option or section
}{Distutils setup script option
}
1159 \lineii{Name
}{\option{name
}}
1160 \lineii{Summary (in preamble)
}{\option{description
}}
1161 \lineii{Version
}{\option{version
}}
1162 \lineii{Vendor
}{\option{author
} and
\option{author
\_email}, or \\&
1163 \option{maintainer
} and
\option{maintainer
\_email}}
1164 \lineii{Copyright
}{\option{licence
}}
1165 \lineii{Url
}{\option{url
}}
1166 \lineii{\%description (section)
}{\option{long
\_description}}
1169 Additionally, there many options in
\file{.spec
} files that don't have
1170 corresponding options in the setup script. Most of these are handled
1171 through options to the
\command{bdist
\_rpm} command as follows:
1172 \begin{tableiii
}{l|l|l
}{textrm
}%
1173 {RPM
\file{.spec
} file option or section
}%
1174 {\command{bdist
\_rpm} option
}%
1176 \lineiii{Release
}{\option{release
}}{``
1''
}
1177 \lineiii{Group
}{\option{group
}}{``Development/Libraries''
}
1178 \lineiii{Vendor
}{\option{vendor
}}{(see above)
}
1179 \lineiii{Packager
}{\option{packager
}}{(none)
}
1180 \lineiii{Provides
}{\option{provides
}}{(none)
}
1181 \lineiii{Requires
}{\option{requires
}}{(none)
}
1182 \lineiii{Conflicts
}{\option{conflicts
}}{(none)
}
1183 \lineiii{Obsoletes
}{\option{obsoletes
}}{(none)
}
1184 \lineiii{Distribution
}{\option{distribution
\_name}}{(none)
}
1185 \lineiii{BuildRequires
}{\option{build
\_requires}}{(none)
}
1186 \lineiii{Icon
}{\option{icon
}}{(none)
}
1188 Obviously, supplying even a few of these options on the command-line
1189 would be tedious and error-prone, so it's usually best to put them in
1190 the setup configuration file,
\file{setup.cfg
}---see
1191 section~
\ref{setup-config
}. If you distribute or package many Python
1192 module distributions, you might want to put options that apply to all of
1193 them in your personal Distutils configuration file
1194 (
\file{\textasciitilde/.pydistutils.cfg
}).
1196 There are three steps to building a binary RPM package, all of which are
1197 handled automatically by the Distutils:
1199 \item create a
\file{.spec
} file, which describes the package (analogous
1200 to the Distutils setup script; in fact, much of the information in the
1201 setup script winds up in the
\file{.spec
} file)
1202 \item create the source RPM
1203 \item create the ``binary'' RPM (which may or may not contain binary
1204 code, depending on whether your module distribution contains Python
1207 Normally, RPM bundles the last two steps together; when you use the
1208 Distutils, all three steps are typically bundled together.
1210 If you wish, you can separate these three steps. You can use the
1211 \longprogramopt{spec-only
} option to make
\command{bdist
\_rpm} just
1212 create the
\file{.spec
} file and exit; in this case, the
\file{.spec
}
1213 file will be written to the ``distribution directory''---normally
1214 \file{dist/
}, but customizable with the
\longprogramopt{dist-dir
}
1215 option. (Normally, the
\file{.spec
} file winds up deep in the ``build
1216 tree,'' in a temporary directory created by
\command{bdist
\_rpm}.)
1218 \XXX{this isn't implemented yet---is it needed?!
}
1219 You can also specify a custom
\file{.spec
} file with the
1220 \longprogramopt{spec-file
} option; used in conjunction with
1221 \longprogramopt{spec-only
}, this gives you an opportunity to customize
1222 the
\file{.spec
} file manually:
1225 > python setup.py bdist_rpm --spec-only
1226 # ...edit dist/FooBar-
1.0.spec
1227 > python setup.py bdist_rpm --spec-file=dist/FooBar-
1.0.spec
1230 (Although a better way to do this is probably to override the standard
1231 \command{bdist
\_rpm} command with one that writes whatever else you want
1232 to the
\file{.spec
} file; see section~
\ref{extending
} for information on
1233 extending the Distutils.)
1236 \subsection{Creating Windows installers
}
1237 \label{creating-wininst
}
1239 Executable Windows installers are the natural format for binary
1240 distributions on Windows. They display a nice GUI interface, display
1241 some information of the module distribution to be installed, taken
1242 from the meta-dada in the setup script, let the user select a few
1243 (currently maybe too few) options, and start or cancel the installation.
1245 Since the meta-data is taken from the setup script, creating
1246 Windows installers is usually as easy as running:
1249 python setup.py bdist_wininst
1252 or the
\command{bdist
} command with the
\longprogramopt{format
} option:
1255 python setup.py bdist --formats=wininst
1258 If you have a pure module distribution (only containing pure
1259 Python modules and packages), the resulting installer will be
1260 version independent and have a name like
\file{Foo-
1.0.win32.exe
}.
1261 These installers can even be created on
\UNIX{} or MacOS platforms.
1263 If you have a non-pure distribution, the extensions can only be
1264 created on a Windows platform, and will be Python version dependend.
1265 The installer filename will reflect this and now has the form
1266 \file{Foo-
1.0.win32-py2.0.exe
}. You have to create a separate installer
1267 for every Python version you want to support.
1269 The installer will try to compile pure modules into bytecode after
1270 installation on the target system in normal and optimizing mode.
1271 If you don't want this to happen for some reason, you can run
1272 the bdist_wininst command with the
\longprogramopt{no-target-compile
} and/or
1273 the
\longprogramopt{no-target-optimize
} option.
1279 %\subsection{Pure Python distribution (by module)}
1283 %\subsection{Pure Python distribution (by package)}
1287 %\subsection{Single extension module}
1291 %\subsection{Multiple extension modules}
1292 %\label{multiple-ext}
1295 %\subsection{Putting it all together}
1299 %\section{Extending the Distutils}
1303 %\subsection{Extending existing commands}
1304 %\label{extend-existing}
1307 %\subsection{Writing new commands}
1308 %\label{new-commands}
1310 %\XXX{Would an uninstall command be a good example here?}
1318 %\subsection{Building modules: the \protect\command{build} command family}
1321 %\subsubsection{\protect\command{build}}
1324 %\subsubsection{\protect\command{build\_py}}
1325 %\label{build-py-cmd}
1327 %\subsubsection{\protect\command{build\_ext}}
1328 %\label{build-ext-cmd}
1330 %\subsubsection{\protect\command{build\_clib}}
1331 %\label{build-clib-cmd}
1334 \subsection{Installing modules: the
\protect\command{install
} command family
}
1337 The install command ensures that the build commands have been run and then
1338 runs the subcommands
\command{install
\_lib},
1339 \command{install
\_data} and
1340 \command{install
\_scripts}.
1342 %\subsubsection{\protect\command{install\_lib}}
1343 %\label{install-lib-cmd}
1345 \subsubsection{\protect\command{install
\_data}}
1346 \label{install-data-cmd
}
1347 This command installs all data files provided with the distribution.
1349 \subsubsection{\protect\command{install
\_scripts}}
1350 \label{install-scripts-cmd
}
1351 This command installs all (Python) scripts in the distribution.
1354 %\subsection{Cleaning up: the \protect\command{clean} command}
1358 \subsection{Creating a source distribution: the
1359 \protect\command{sdist
} command
}
1363 \XXX{fragment moved down from above: needs context!
}
1365 The manifest template commands are:
1366 \begin{tableii
}{ll
}{command
}{Command
}{Description
}
1367 \lineii{include
\var{pat1
} \var{pat2
} ...
}
1368 {include all files matching any of the listed patterns
}
1369 \lineii{exclude
\var{pat1
} \var{pat2
} ...
}
1370 {exclude all files matching any of the listed patterns
}
1371 \lineii{recursive-include
\var{dir
} \var{pat1
} \var{pat2
} ...
}
1372 {include all files under
\var{dir
} matching any of the listed patterns
}
1373 \lineii{recursive-exclude
\var{dir
} \var{pat1
} \var{pat2
} ...
}
1374 {exclude all files under
\var{dir
} matching any of the listed patterns
}
1375 \lineii{global-include
\var{pat1
} \var{pat2
} ...
}
1376 {include all files anywhere in the source tree matching\\&
1377 any of the listed patterns
}
1378 \lineii{global-exclude
\var{pat1
} \var{pat2
} ...
}
1379 {exclude all files anywhere in the source tree matching\\&
1380 any of the listed patterns
}
1381 \lineii{prune
\var{dir
}}{exclude all files under
\var{dir
}}
1382 \lineii{graft
\var{dir
}}{include all files under
\var{dir
}}
1384 The patterns here are
\UNIX-style ``glob'' patterns:
\code{*
} matches any
1385 sequence of regular filename characters,
\code{?
} matches any single
1386 regular filename character, and
\code{[\var{range
}]} matches any of the
1387 characters in
\var{range
} (e.g.,
\code{a-z
},
\code{a-zA-Z
},
1388 \code{a-f0-
9\_.
}). The definition of ``regular filename character'' is
1389 platform-specific: on
\UNIX{} it is anything except slash; on Windows
1390 anything except backslash or colon; on MacOS anything except colon.
1392 \XXX{Windows and MacOS support not there yet
}
1395 %\subsection{Creating a built distribution: the
1396 % \protect\command{bdist} command family}
1400 %\subsubsection{\protect\command{blib}}
1402 %\subsubsection{\protect\command{blib\_dumb}}
1404 %\subsubsection{\protect\command{blib\_rpm}}
1406 %\subsubsection{\protect\command{blib\_wise}}