Commit | Line | Data |
---|---|---|
86530b38 AT |
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="examples.html" /> | |
12 | <link rel="prev" href="built-dist.html" /> | |
13 | <link rel="parent" href="dist.html" /> | |
14 | <link rel="next" href="examples.html" /> | |
15 | <meta name='aesop' content='information' /> | |
16 | <title>6. Registering with the Package Index</title> | |
17 | </head> | |
18 | <body> | |
19 | <DIV CLASS="navigation"> | |
20 | <div id='top-navigation-panel' xml:id='top-navigation-panel'> | |
21 | <table align="center" width="100%" cellpadding="0" cellspacing="2"> | |
22 | <tr> | |
23 | <td class='online-navigation'><a rel="prev" title="5.3 Creating Windows Installers" | |
24 | href="postinstallation-script.html"><img src='../icons/previous.png' | |
25 | border='0' height='32' alt='Previous Page' width='32' /></A></td> | |
26 | <td class='online-navigation'><a rel="parent" title="Distributing Python Modules" | |
27 | href="dist.html"><img src='../icons/up.png' | |
28 | border='0' height='32' alt='Up One Level' width='32' /></A></td> | |
29 | <td class='online-navigation'><a rel="next" title="7. Examples" | |
30 | href="examples.html"><img src='../icons/next.png' | |
31 | border='0' height='32' alt='Next Page' width='32' /></A></td> | |
32 | <td align="center" width="100%">Distributing Python Modules</td> | |
33 | <td class='online-navigation'><img src='../icons/blank.png' | |
34 | border='0' height='32' alt='' width='32' /></td> | |
35 | <td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png' | |
36 | border='0' height='32' alt='Module Index' width='32' /></a></td> | |
37 | <td class='online-navigation'><a rel="index" title="Index" | |
38 | href="genindex.html"><img src='../icons/index.png' | |
39 | border='0' height='32' alt='Index' width='32' /></A></td> | |
40 | </tr></table> | |
41 | <div class='online-navigation'> | |
42 | <b class="navlabel">Previous:</b> | |
43 | <a class="sectref" rel="prev" href="postinstallation-script.html">5.3 Creating Windows Installers</A> | |
44 | <b class="navlabel">Up:</b> | |
45 | <a class="sectref" rel="parent" href="dist.html">Distributing Python Modules</A> | |
46 | <b class="navlabel">Next:</b> | |
47 | <a class="sectref" rel="next" href="examples.html">7. Examples</A> | |
48 | </div> | |
49 | <hr /></div> | |
50 | </DIV> | |
51 | <!--End of Navigation Panel--> | |
52 | ||
53 | <H1><A NAME="SECTION006000000000000000000"></A> | |
54 | <A NAME="package-index"></A> | |
55 | <BR> | |
56 | 6. Registering with the Package Index | |
57 | </H1> | |
58 | ||
59 | <P> | |
60 | The Python Package Index (PyPI) holds meta-data describing distributions | |
61 | packaged with distutils. The distutils command <code class="du-command">register</code> is | |
62 | used to submit your distribution's meta-data to the index. It is invoked | |
63 | as follows: | |
64 | ||
65 | <P> | |
66 | <div class="verbatim"><pre> | |
67 | python setup.py register | |
68 | </pre></div> | |
69 | ||
70 | <P> | |
71 | Distutils will respond with the following prompt: | |
72 | ||
73 | <P> | |
74 | <div class="verbatim"><pre> | |
75 | running register | |
76 | We need to know who you are, so please choose either: | |
77 | 1. use your existing login, | |
78 | 2. register as a new user, | |
79 | 3. have the server generate a new password for you (and email it to you), or | |
80 | 4. quit | |
81 | Your selection [default 1]: | |
82 | </pre></div> | |
83 | ||
84 | <P> | |
85 | Note: if your username and password are saved locally, you will | |
86 | not see this menu. | |
87 | ||
88 | <P> | |
89 | If you have not registered with PyPI, then you will need to do so now. You | |
90 | should choose option 2, and enter your details as required. Soon after | |
91 | submitting your details, you will receive an email which will be used to | |
92 | confirm your registration. | |
93 | ||
94 | <P> | |
95 | Once you are registered, you may choose option 1 from the menu. You will | |
96 | be prompted for your PyPI username and password, and <code class="du-command">register</code> | |
97 | will then submit your meta-data to the index. | |
98 | ||
99 | <P> | |
100 | You may submit any number of versions of your distribution to the index. If | |
101 | you alter the meta-data for a particular version, you may submit it again | |
102 | and the index will be updated. | |
103 | ||
104 | <P> | |
105 | PyPI holds a record for each (name, version) combination submitted. The | |
106 | first user to submit information for a given name is designated the Owner | |
107 | of that name. They may submit changes through the <code class="du-command">register</code> | |
108 | command or through the web interface. They may also designate other users | |
109 | as Owners or Maintainers. Maintainers may edit the package information, but | |
110 | not designate other Owners or Maintainers. | |
111 | ||
112 | <P> | |
113 | By default PyPI will list all versions of a given package. To hide certain | |
114 | versions, the Hidden property should be set to yes. This must be edited | |
115 | through the web interface. | |
116 | ||
117 | <P> | |
118 | ||
119 | <DIV CLASS="navigation"> | |
120 | <div class='online-navigation'> | |
121 | <p></p><hr /> | |
122 | <table align="center" width="100%" cellpadding="0" cellspacing="2"> | |
123 | <tr> | |
124 | <td class='online-navigation'><a rel="prev" title="5.3 Creating Windows Installers" | |
125 | href="postinstallation-script.html"><img src='../icons/previous.png' | |
126 | border='0' height='32' alt='Previous Page' width='32' /></A></td> | |
127 | <td class='online-navigation'><a rel="parent" title="Distributing Python Modules" | |
128 | href="dist.html"><img src='../icons/up.png' | |
129 | border='0' height='32' alt='Up One Level' width='32' /></A></td> | |
130 | <td class='online-navigation'><a rel="next" title="7. Examples" | |
131 | href="examples.html"><img src='../icons/next.png' | |
132 | border='0' height='32' alt='Next Page' width='32' /></A></td> | |
133 | <td align="center" width="100%">Distributing Python Modules</td> | |
134 | <td class='online-navigation'><img src='../icons/blank.png' | |
135 | border='0' height='32' alt='' width='32' /></td> | |
136 | <td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png' | |
137 | border='0' height='32' alt='Module Index' width='32' /></a></td> | |
138 | <td class='online-navigation'><a rel="index" title="Index" | |
139 | href="genindex.html"><img src='../icons/index.png' | |
140 | border='0' height='32' alt='Index' width='32' /></A></td> | |
141 | </tr></table> | |
142 | <div class='online-navigation'> | |
143 | <b class="navlabel">Previous:</b> | |
144 | <a class="sectref" rel="prev" href="postinstallation-script.html">5.3 Creating Windows Installers</A> | |
145 | <b class="navlabel">Up:</b> | |
146 | <a class="sectref" rel="parent" href="dist.html">Distributing Python Modules</A> | |
147 | <b class="navlabel">Next:</b> | |
148 | <a class="sectref" rel="next" href="examples.html">7. Examples</A> | |
149 | </div> | |
150 | </div> | |
151 | <hr /> | |
152 | <span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span> | |
153 | </DIV> | |
154 | <!--End of Navigation Panel--> | |
155 | <ADDRESS> | |
156 | See <i><a href="about.html">About this document...</a></i> for information on suggesting changes. | |
157 | </ADDRESS> | |
158 | </BODY> | |
159 | </HTML> |