| 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| 2 | <html> |
| 3 | <head> |
| 4 | <link rel="STYLESHEET" href="dist.css" type='text/css' /> |
| 5 | <link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" /> |
| 6 | <link rel='start' href='../index.html' title='Python Documentation Index' /> |
| 7 | <link rel="first" href="dist.html" title='Distributing Python Modules' /> |
| 8 | <link rel='index' href='genindex.html' title='Index' /> |
| 9 | <link rel='last' href='about.html' title='About this document...' /> |
| 10 | <link rel='help' href='about.html' title='About this document...' /> |
| 11 | <link rel="next" href="intro.html" /> |
| 12 | <meta name='aesop' content='information' /> |
| 13 | <title>Distributing Python Modules</title> |
| 14 | </head> |
| 15 | <body> |
| 16 | <DIV CLASS="navigation"> |
| 17 | <div id='top-navigation-panel' xml:id='top-navigation-panel'> |
| 18 | <table align="center" width="100%" cellpadding="0" cellspacing="2"> |
| 19 | <tr> |
| 20 | <td class='online-navigation'><img src='../icons/previous.png' |
| 21 | border='0' height='32' alt='Previous Page' width='32' /></td> |
| 22 | <td class='online-navigation'><a rel="parent" title="Python Documentation Index" |
| 23 | href="../index.html"><img src='../icons/up.png' |
| 24 | border='0' height='32' alt='Up One Level' width='32' /></A></td> |
| 25 | <td class='online-navigation'><a rel="next" title="1. An Introduction to" |
| 26 | href="intro.html"><img src='../icons/next.png' |
| 27 | border='0' height='32' alt='Next Page' width='32' /></A></td> |
| 28 | <td align="center" width="100%">Distributing Python Modules</td> |
| 29 | <td class='online-navigation'><img src='../icons/blank.png' |
| 30 | border='0' height='32' alt='' width='32' /></td> |
| 31 | <td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png' |
| 32 | border='0' height='32' alt='Module Index' width='32' /></a></td> |
| 33 | <td class='online-navigation'><a rel="index" title="Index" |
| 34 | href="genindex.html"><img src='../icons/index.png' |
| 35 | border='0' height='32' alt='Index' width='32' /></A></td> |
| 36 | </tr></table> |
| 37 | <div class='online-navigation'> |
| 38 | <b class="navlabel">Up:</b> |
| 39 | <a class="sectref" rel="parent" href="../index.html">Python Documentation Index</A> |
| 40 | <b class="navlabel">Next:</b> |
| 41 | <a class="sectref" rel="next" href="intro.html">1. An Introduction to</A> |
| 42 | </div> |
| 43 | <hr /></div> |
| 44 | </DIV> |
| 45 | <!--End of Navigation Panel--> |
| 46 | |
| 47 | <P> |
| 48 | |
| 49 | <link rel='up' href='../index.html' title='Python Documentation Index' /> |
| 50 | <div class="titlepage"> |
| 51 | <div class='center'> |
| 52 | <h1>Distributing Python Modules</h1> |
| 53 | <p><b><font size="+2">Greg Ward</font></b></p> |
| 54 | <p> |
| 55 | <strong>Python Software Foundation</strong> |
| 56 | <BR> |
| 57 | Email: <span class="email">distutils-sig@python.org</span> |
| 58 | </p> |
| 59 | <p><i> Anthony Baxter</i></p> |
| 60 | <p><strong>Release 2.4.2</strong><br /> |
| 61 | <strong>28 September 2005</strong></p> |
| 62 | <p></p> |
| 63 | </div> |
| 64 | </div> |
| 65 | |
| 66 | <P> |
| 67 | Copyright © 2001-2004 Python Software Foundation. |
| 68 | All rights reserved. |
| 69 | |
| 70 | <P> |
| 71 | Copyright © 2000 BeOpen.com. |
| 72 | All rights reserved. |
| 73 | |
| 74 | <P> |
| 75 | Copyright © 1995-2000 Corporation for National Research Initiatives. |
| 76 | All rights reserved. |
| 77 | |
| 78 | <P> |
| 79 | Copyright © 1991-1995 Stichting Mathematisch Centrum. |
| 80 | All rights reserved. |
| 81 | |
| 82 | <P> |
| 83 | See the end of this document for complete license and permissions |
| 84 | information. |
| 85 | |
| 86 | <P> |
| 87 | |
| 88 | <H3>Abstract:</H3> |
| 89 | <DIV CLASS="ABSTRACT"> |
| 90 | |
| 91 | This document describes the Python Distribution Utilities |
| 92 | (``Distutils'') from the module developer's point of view, describing |
| 93 | how to use the Distutils to make Python modules and extensions easily |
| 94 | available to a wider audience with very little overhead for |
| 95 | build/release/install mechanics. |
| 96 | </DIV> |
| 97 | <P> |
| 98 | |
| 99 | <P> |
| 100 | |
| 101 | <p><br /></p><hr class='online-navigation' /> |
| 102 | <div class='online-navigation'> |
| 103 | <!--Table of Child-Links--> |
| 104 | <A NAME="CHILD_LINKS"></a> |
| 105 | |
| 106 | <UL CLASS="ChildLinks"> |
| 107 | <LI><A href="intro.html">1. An Introduction to Distutils</a> |
| 108 | <UL> |
| 109 | <LI><A href="concepts.html">1.1 Concepts & Terminology</a> |
| 110 | <LI><A href="simple-example.html">1.2 A Simple Example</a> |
| 111 | <LI><A href="python-terms.html">1.3 General Python terminology</a> |
| 112 | <LI><A href="distutils-term.html">1.4 Distutils-specific terminology</a> |
| 113 | </ul> |
| 114 | <LI><A href="setup-script.html">2. Writing the Setup Script</a> |
| 115 | <UL> |
| 116 | <LI><A href="listing-packages.html">2.1 Listing whole packages</a> |
| 117 | <LI><A href="listing-modules.html">2.2 Listing individual modules</a> |
| 118 | <LI><A href="describing-extensions.html">2.3 Describing extension modules</a> |
| 119 | <UL> |
| 120 | <LI><A href="describing-extensions.html#SECTION002310000000000000000">2.3.1 Extension names and packages</a> |
| 121 | <LI><A href="describing-extensions.html#SECTION002320000000000000000">2.3.2 Extension source files</a> |
| 122 | <LI><A href="describing-extensions.html#SECTION002330000000000000000">2.3.3 Preprocessor options</a> |
| 123 | <LI><A href="describing-extensions.html#SECTION002340000000000000000">2.3.4 Library options</a> |
| 124 | <LI><A href="describing-extensions.html#SECTION002350000000000000000">2.3.5 Other options</a> |
| 125 | </ul> |
| 126 | <LI><A href="node10.html">2.4 Installing Scripts</a> |
| 127 | <LI><A href="node11.html">2.5 Installing Package Data</a> |
| 128 | <LI><A href="node12.html">2.6 Installing Additional Files</a> |
| 129 | <LI><A href="meta-data.html">2.7 Additional meta-data</a> |
| 130 | <LI><A href="node14.html">2.8 Debugging the setup script</a> |
| 131 | </ul> |
| 132 | <LI><A href="setup-config.html">3. Writing the Setup Configuration File</a> |
| 133 | <LI><A href="source-dist.html">4. Creating a Source Distribution</a> |
| 134 | <UL> |
| 135 | <LI><A href="manifest.html">4.1 Specifying the files to distribute</a> |
| 136 | <LI><A href="manifest-options.html">4.2 Manifest-related options</a> |
| 137 | </ul> |
| 138 | <LI><A href="built-dist.html">5. Creating Built Distributions</a> |
| 139 | <UL> |
| 140 | <LI><A href="creating-dumb.html">5.1 Creating dumb built distributions</a> |
| 141 | <LI><A href="creating-rpms.html">5.2 Creating RPM packages</a> |
| 142 | <LI><A href="postinstallation-script.html">5.3 Creating Windows Installers</a> |
| 143 | <UL> |
| 144 | <LI><A href="postinstallation-script.html#SECTION005310000000000000000">5.3.1 The Postinstallation script</a> |
| 145 | </ul> |
| 146 | </ul> |
| 147 | <LI><A href="package-index.html">6. Registering with the Package Index</a> |
| 148 | <LI><A href="examples.html">7. Examples</a> |
| 149 | <UL> |
| 150 | <LI><A href="pure-mod.html">7.1 Pure Python distribution (by module)</a> |
| 151 | <LI><A href="pure-pkg.html">7.2 Pure Python distribution (by package)</a> |
| 152 | <LI><A href="single-ext.html">7.3 Single extension module</a> |
| 153 | </ul> |
| 154 | <LI><A href="extending.html">8. Extending Distutils</a> |
| 155 | <UL> |
| 156 | <LI><A href="node29.html">8.1 Integrating new commands</a> |
| 157 | </ul> |
| 158 | <LI><A href="reference.html">9. Command Reference</a> |
| 159 | <UL> |
| 160 | <LI><A href="install-scripts-cmd.html">9.1 Installing modules: the <code class="du-command">install</code> command family</a> |
| 161 | <UL> |
| 162 | <LI><A href="install-scripts-cmd.html#SECTION009110000000000000000">9.1.1 <code class="du-command">install_data</code></a> |
| 163 | <LI><A href="install-scripts-cmd.html#SECTION009120000000000000000">9.1.2 <code class="du-command">install_scripts</code></a> |
| 164 | </ul> |
| 165 | <LI><A href="sdist-cmd.html">9.2 Creating a source distribution: the |
| 166 | <code class="du-command">sdist</code> command</a> |
| 167 | </ul> |
| 168 | <LI><A href="api-reference.html">10. API Reference</a> |
| 169 | <UL> |
| 170 | <LI><A href="module-distutils.core.html">10.1 <tt class="module">distutils.core</tt> -- Core Distutils functionality</a> |
| 171 | <LI><A href="module-distutils.ccompiler.html">10.2 <tt class="module">distutils.ccompiler</tt> -- CCompiler base class</a> |
| 172 | <LI><A href="module-distutils.unixccompiler.html">10.3 <tt class="module">distutils.unixccompiler</tt> -- Unix C Compiler</a> |
| 173 | <LI><A href="module-distutils.msvccompiler.html">10.4 <tt class="module">distutils.msvccompiler</tt> -- Microsoft Compiler</a> |
| 174 | <LI><A href="module-distutils.bcppcompiler.html">10.5 <tt class="module">distutils.bcppcompiler</tt> -- Borland Compiler</a> |
| 175 | <LI><A href="module-distutils.cygwinccompiler.html">10.6 <tt class="module">distutils.cygwincompiler</tt> -- Cygwin Compiler</a> |
| 176 | <LI><A href="module-distutils.emxccompiler.html">10.7 <tt class="module">distutils.emxccompiler</tt> -- OS/2 EMX Compiler</a> |
| 177 | <LI><A href="module-distutils.mwerkscompiler.html">10.8 <tt class="module">distutils.mwerkscompiler</tt> -- Metrowerks CodeWarrior support</a> |
| 178 | <LI><A href="module-distutils.archiveutil.html">10.9 <tt class="module">distutils.archive_util</tt> -- |
| 179 | Archiving utilities</a> |
| 180 | <LI><A href="module-distutils.deputil.html">10.10 <tt class="module">distutils.dep_util</tt> -- Dependency checking</a> |
| 181 | <LI><A href="module-distutils.dirutil.html">10.11 <tt class="module">distutils.dir_util</tt> -- Directory tree operations</a> |
| 182 | <LI><A href="module-distutils.fileutil.html">10.12 <tt class="module">distutils.file_util</tt> -- Single file operations</a> |
| 183 | <LI><A href="module-distutils.util.html">10.13 <tt class="module">distutils.util</tt> -- Miscellaneous other utility functions</a> |
| 184 | <LI><A href="module-distutils.dist.html">10.14 <tt class="module">distutils.dist</tt> -- The Distribution class</a> |
| 185 | <LI><A href="module-distutils.extension.html">10.15 <tt class="module">distutils.extension</tt> -- The Extension class</a> |
| 186 | <LI><A href="module-distutils.debug.html">10.16 <tt class="module">distutils.debug</tt> -- Distutils debug mode</a> |
| 187 | <LI><A href="module-distutils.errors.html">10.17 <tt class="module">distutils.errors</tt> -- Distutils exceptions</a> |
| 188 | <LI><A href="module-distutils.fancygetopt.html">10.18 <tt class="module">distutils.fancy_getopt</tt> |
| 189 | -- Wrapper around the standard getopt module</a> |
| 190 | <LI><A href="module-distutils.filelist.html">10.19 <tt class="module">distutils.filelist</tt> -- The FileList class</a> |
| 191 | <LI><A href="module-distutils.log.html">10.20 <tt class="module">distutils.log</tt> -- Simple PEP 282-style logging</a> |
| 192 | <LI><A href="module-distutils.spawn.html">10.21 <tt class="module">distutils.spawn</tt> -- Spawn a sub-process</a> |
| 193 | <LI><A href="module-distutils.sysconfig.html">10.22 <tt class="module">distutils.sysconfig</tt> -- |
| 194 | System configuration information</a> |
| 195 | <LI><A href="module-distutils.textfile.html">10.23 <tt class="module">distutils.text_file</tt> -- The TextFile class</a> |
| 196 | <LI><A href="module-distutils.version.html">10.24 <tt class="module">distutils.version</tt> -- Version number classes</a> |
| 197 | <LI><A href="module-distutils.cmd.html">10.25 <tt class="module">distutils.cmd</tt> -- Abstract base class for Distutils commands</a> |
| 198 | <LI><A href="module-distutils.command.html">10.26 <tt class="module">distutils.command</tt> -- Individual Distutils commands</a> |
| 199 | <LI><A href="module-distutils.command.bdist.html">10.27 <tt class="module">distutils.command.bdist</tt> -- Build a binary installer</a> |
| 200 | <LI><A href="module-distutils.command.bdistpackager.html">10.28 <tt class="module">distutils.command.bdist_packager</tt> -- Abstract base class for packagers</a> |
| 201 | <LI><A href="module-distutils.command.bdistdumb.html">10.29 <tt class="module">distutils.command.bdist_dumb</tt> -- Build a ``dumb'' installer</a> |
| 202 | <LI><A href="module-distutils.command.bdistrpm.html">10.30 <tt class="module">distutils.command.bdist_rpm</tt> -- Build a binary distribution as a Redhat RPM and SRPM</a> |
| 203 | <LI><A href="module-distutils.command.bdistwininst.html">10.31 <tt class="module">distutils.command.bdist_wininst</tt> -- Build a Windows installer</a> |
| 204 | <LI><A href="module-distutils.command.sdist.html">10.32 <tt class="module">distutils.command.sdist</tt> -- Build a source distribution</a> |
| 205 | <LI><A href="module-distutils.command.build.html">10.33 <tt class="module">distutils.command.build</tt> -- Build all files of a package</a> |
| 206 | <LI><A href="module-distutils.command.buildclib.html">10.34 <tt class="module">distutils.command.build_clib</tt> -- Build any C libraries in a package</a> |
| 207 | <LI><A href="module-distutils.command.buildext.html">10.35 <tt class="module">distutils.command.build_ext</tt> -- Build any extensions in a package</a> |
| 208 | <LI><A href="module-distutils.command.buildpy.html">10.36 <tt class="module">distutils.command.build_py</tt> -- Build the .py/.pyc files of a package</a> |
| 209 | <LI><A href="module-distutils.command.buildscripts.html">10.37 <tt class="module">distutils.command.build_scripts</tt> -- Build the scripts of a package</a> |
| 210 | <LI><A href="module-distutils.command.clean.html">10.38 <tt class="module">distutils.command.clean</tt> -- Clean a package build area</a> |
| 211 | <LI><A href="module-distutils.command.config.html">10.39 <tt class="module">distutils.command.config</tt> -- Perform package configuration</a> |
| 212 | <LI><A href="module-distutils.command.install.html">10.40 <tt class="module">distutils.command.install</tt> -- Install a package</a> |
| 213 | <LI><A href="module-distutils.command.installdata.html">10.41 <tt class="module">distutils.command.install_data</tt> |
| 214 | -- Install data files from a package</a> |
| 215 | <LI><A href="module-distutils.command.installheaders.html">10.42 <tt class="module">distutils.command.install_headers</tt> |
| 216 | -- Install C/C++ header files from a package</a> |
| 217 | <LI><A href="module-distutils.command.installlib.html">10.43 <tt class="module">distutils.command.install_lib</tt> |
| 218 | -- Install library files from a package</a> |
| 219 | <LI><A href="module-distutils.command.installscripts.html">10.44 <tt class="module">distutils.command.install_scripts</tt> |
| 220 | -- Install script files from a package</a> |
| 221 | <LI><A href="module-distutils.command.register.html">10.45 <tt class="module">distutils.command.register</tt> |
| 222 | -- Register a module with the Python Package Index</a> |
| 223 | <LI><A href="node79.html">10.46 Creating a new Distutils command</a> |
| 224 | </ul> |
| 225 | <LI><A href="modindex.html">Module Index</a> |
| 226 | <LI><A href="genindex.html">Index</a> |
| 227 | <LI><A href="about.html">About this document ...</a> |
| 228 | </ul> |
| 229 | <!--End of Table of Child-Links--> |
| 230 | </div> |
| 231 | |
| 232 | <DIV CLASS="navigation"> |
| 233 | <div class='online-navigation'> |
| 234 | <p></p><hr /> |
| 235 | <table align="center" width="100%" cellpadding="0" cellspacing="2"> |
| 236 | <tr> |
| 237 | <td class='online-navigation'><img src='../icons/previous.png' |
| 238 | border='0' height='32' alt='Previous Page' width='32' /></td> |
| 239 | <td class='online-navigation'><a rel="parent" title="Python Documentation Index" |
| 240 | href="../index.html"><img src='../icons/up.png' |
| 241 | border='0' height='32' alt='Up One Level' width='32' /></A></td> |
| 242 | <td class='online-navigation'><a rel="next" title="1. An Introduction to" |
| 243 | href="intro.html"><img src='../icons/next.png' |
| 244 | border='0' height='32' alt='Next Page' width='32' /></A></td> |
| 245 | <td align="center" width="100%">Distributing Python Modules</td> |
| 246 | <td class='online-navigation'><img src='../icons/blank.png' |
| 247 | border='0' height='32' alt='' width='32' /></td> |
| 248 | <td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png' |
| 249 | border='0' height='32' alt='Module Index' width='32' /></a></td> |
| 250 | <td class='online-navigation'><a rel="index" title="Index" |
| 251 | href="genindex.html"><img src='../icons/index.png' |
| 252 | border='0' height='32' alt='Index' width='32' /></A></td> |
| 253 | </tr></table> |
| 254 | <div class='online-navigation'> |
| 255 | <b class="navlabel">Up:</b> |
| 256 | <a class="sectref" rel="parent" href="../index.html">Python Documentation Index</A> |
| 257 | <b class="navlabel">Next:</b> |
| 258 | <a class="sectref" rel="next" href="intro.html">1. An Introduction to</A> |
| 259 | </div> |
| 260 | </div> |
| 261 | <hr /> |
| 262 | <span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span> |
| 263 | </DIV> |
| 264 | <!--End of Navigation Panel--> |
| 265 | <ADDRESS> |
| 266 | See <i><a href="about.html">About this document...</a></i> for information on suggesting changes. |
| 267 | </ADDRESS> |
| 268 | </BODY> |
| 269 | </HTML> |