| Éric Araujo | 3a9f58f | 2011-06-01 20:42:49 +0200 | [diff] [blame] | 1 | :mod:`packaging` --- Packaging support |
| 2 | ====================================== |
| 3 | |
| 4 | .. module:: packaging |
| 5 | :synopsis: Packaging system and building blocks for other packaging systems. |
| 6 | .. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>, distutils and packaging |
| 7 | contributors |
| 8 | |
| 9 | |
| 10 | The :mod:`packaging` package provides support for building, packaging, |
| 11 | distributing and installing additional projects into a Python installation. |
| 12 | Projects may include Python modules, extension modules, packages and scripts. |
| 13 | :mod:`packaging` also provides building blocks for other packaging systems |
| 14 | that are not tied to the command system. |
| 15 | |
| 16 | This manual is the reference documentation for those standalone building |
| 17 | blocks and for extending Packaging. If you're looking for the user-centric |
| 18 | guides to install a project or package your own code, head to `See also`__. |
| 19 | |
| 20 | |
| 21 | Building blocks |
| 22 | --------------- |
| 23 | |
| 24 | .. toctree:: |
| 25 | :maxdepth: 2 |
| Éric Araujo | 3a9f58f | 2011-06-01 20:42:49 +0200 | [diff] [blame] | 26 | |
| 27 | packaging-misc |
| 28 | packaging.version |
| 29 | packaging.metadata |
| 30 | packaging.database |
| 31 | packaging.depgraph |
| 32 | packaging.pypi |
| 33 | packaging.pypi.dist |
| 34 | packaging.pypi.simple |
| 35 | packaging.pypi.xmlrpc |
| 36 | packaging.install |
| 37 | |
| 38 | |
| 39 | The command machinery |
| 40 | --------------------- |
| 41 | |
| 42 | .. toctree:: |
| 43 | :maxdepth: 2 |
| Éric Araujo | 3a9f58f | 2011-06-01 20:42:49 +0200 | [diff] [blame] | 44 | |
| 45 | packaging.dist |
| 46 | packaging.command |
| 47 | packaging.compiler |
| 48 | packaging.fancy_getopt |
| 49 | |
| 50 | |
| 51 | Other utilities |
| 52 | ---------------- |
| 53 | |
| 54 | .. toctree:: |
| 55 | :maxdepth: 2 |
| Éric Araujo | 3a9f58f | 2011-06-01 20:42:49 +0200 | [diff] [blame] | 56 | |
| 57 | packaging.util |
| 58 | packaging.tests.pypi_server |
| 59 | |
| 60 | .. XXX missing: compat config create (dir_util) run pypi.{base,mirrors} |
| 61 | |
| 62 | |
| 63 | .. __: |
| 64 | |
| 65 | .. seealso:: |
| 66 | |
| 67 | :ref:`packaging-index` |
| 68 | The manual for developers of Python projects who want to package and |
| 69 | distribute them. This describes how to use :mod:`packaging` to make |
| 70 | projects easily found and added to an existing Python installation. |
| 71 | |
| 72 | :ref:`packaging-install-index` |
| 73 | A user-centered manual which includes information on adding projects |
| 74 | into an existing Python installation. You do not need to be a Python |
| 75 | programmer to read this manual. |