• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1.. _reference:
2
3*****************
4Command Reference
5*****************
6
7.. include:: ./_setuptools_disclaimer.rst
8
9.. % \section{Building modules: the \protect\command{build} command family}
10.. % \label{build-cmds}
11.. % \subsubsection{\protect\command{build}}
12.. % \label{build-cmd}
13.. % \subsubsection{\protect\command{build\_py}}
14.. % \label{build-py-cmd}
15.. % \subsubsection{\protect\command{build\_ext}}
16.. % \label{build-ext-cmd}
17.. % \subsubsection{\protect\command{build\_clib}}
18.. % \label{build-clib-cmd}
19
20
21.. _install-cmd:
22
23Installing modules: the :command:`install` command family
24=========================================================
25
26The install command ensures that the build commands have been run and then runs
27the subcommands :command:`install_lib`, :command:`install_data` and
28:command:`install_scripts`.
29
30.. % \subsubsection{\protect\command{install\_lib}}
31.. % \label{install-lib-cmd}
32
33
34.. _install-data-cmd:
35
36:command:`install_data`
37-----------------------
38
39This command installs all data files provided with the distribution.
40
41
42.. _install-scripts-cmd:
43
44:command:`install_scripts`
45--------------------------
46
47This command installs all (Python) scripts in the distribution.
48
49.. % \subsection{Cleaning up: the \protect\command{clean} command}
50.. % \label{clean-cmd}
51
52
53.. _sdist-cmd:
54
55Creating a source distribution: the :command:`sdist` command
56============================================================
57
58.. XXX fragment moved down from above: needs context!
59
60The manifest template commands are:
61
62+-------------------------------------------+-----------------------------------------------+
63| Command                                   | Description                                   |
64+===========================================+===============================================+
65| :command:`include pat1 pat2 ...`          | include all files matching any of the listed  |
66|                                           | patterns                                      |
67+-------------------------------------------+-----------------------------------------------+
68| :command:`exclude pat1 pat2 ...`          | exclude all files matching any of the listed  |
69|                                           | patterns                                      |
70+-------------------------------------------+-----------------------------------------------+
71| :command:`recursive-include dir pat1 pat2 | include all files under *dir* matching any of |
72| ...`                                      | the listed patterns                           |
73+-------------------------------------------+-----------------------------------------------+
74| :command:`recursive-exclude dir pat1 pat2 | exclude all files under *dir* matching any of |
75| ...`                                      | the listed patterns                           |
76+-------------------------------------------+-----------------------------------------------+
77| :command:`global-include pat1 pat2 ...`   | include all files anywhere in the source tree |
78|                                           | matching --- & any of the listed patterns     |
79+-------------------------------------------+-----------------------------------------------+
80| :command:`global-exclude pat1 pat2 ...`   | exclude all files anywhere in the source tree |
81|                                           | matching --- & any of the listed patterns     |
82+-------------------------------------------+-----------------------------------------------+
83| :command:`prune dir`                      | exclude all files under *dir*                 |
84+-------------------------------------------+-----------------------------------------------+
85| :command:`graft dir`                      | include all files under *dir*                 |
86+-------------------------------------------+-----------------------------------------------+
87
88The patterns here are Unix-style "glob" patterns: ``*`` matches any sequence of
89regular filename characters, ``?`` matches any single regular filename
90character, and ``[range]`` matches any of the characters in *range* (e.g.,
91``a-z``, ``a-zA-Z``, ``a-f0-9_.``).  The definition of "regular filename
92character" is platform-specific: on Unix it is anything except slash; on Windows
93anything except backslash or colon.
94
95.. XXX Windows support not there yet
96
97.. % \section{Creating a built distribution: the
98.. % \protect\command{bdist} command family}
99.. % \label{bdist-cmds}
100
101.. % \subsection{\protect\command{bdist}}
102.. % \subsection{\protect\command{bdist\_dumb}}
103.. % \subsection{\protect\command{bdist\_rpm}}
104.. % \subsection{\protect\command{bdist\_wininst}}
105
106
107