Edit File: packageindex.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>6. The Python Package Index (PyPI) — Python 2.7.5 documentation</title> <link rel="stylesheet" href="../_static/default.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: '../', VERSION: '2.7.5', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true }; </script> <script type="text/javascript" src="../_static/jquery.js"></script> <script type="text/javascript" src="../_static/underscore.js"></script> <script type="text/javascript" src="../_static/doctools.js"></script> <script type="text/javascript" src="../_static/sidebar.js"></script> <link rel="search" type="application/opensearchdescription+xml" title="Search within Python 2.7.5 documentation" href="../_static/opensearch.xml"/> <link rel="author" title="About these documents" href="../about.html" /> <link rel="copyright" title="Copyright" href="../copyright.html" /> <link rel="top" title="Python 2.7.5 documentation" href="../index.html" /> <link rel="up" title="Distributing Python Modules" href="index.html" /> <link rel="next" title="7. Examples" href="examples.html" /> <link rel="prev" title="5. Creating Built Distributions" href="builtdist.html" /> <link rel="shortcut icon" type="image/png" href="../_static/py.png" /> <script type="text/javascript" src="../_static/copybutton.js"></script> </head> <body> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../genindex.html" title="General Index" accesskey="I">index</a></li> <li class="right" > <a href="../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="examples.html" title="7. Examples" accesskey="N">next</a> |</li> <li class="right" > <a href="builtdist.html" title="5. Creating Built Distributions" accesskey="P">previous</a> |</li> <li><img src="../_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="http://www.python.org/">Python</a> »</li> <li> <a href="../index.html">Python 2.7.5 documentation</a> » </li> <li><a href="index.html" accesskey="U">Distributing Python Modules</a> »</li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body"> <div class="section" id="the-python-package-index-pypi"> <span id="package-index"></span><span id="index-0"></span><h1>6. The Python Package Index (PyPI)<a class="headerlink" href="#the-python-package-index-pypi" title="Permalink to this headline">¶</a></h1> <p>The <a class="reference external" href="http://pypi.python.org/">Python Package Index (PyPI)</a> holds <a class="reference internal" href="setupscript.html#meta-data"><em>meta-data</em></a> describing distributions packaged with distutils, as well as package data like distribution files if the package author wishes.</p> <p>Distutils exposes two commands for submitting package data to PyPI: the <a class="reference internal" href="#package-register"><em>register</em></a> command for submitting meta-data to PyPI and the <a class="reference internal" href="#package-upload"><em>upload</em></a> command for submitting distribution files. Both commands read configuration data from a special file called the <a class="reference internal" href="#pypirc"><em>.pypirc file</em></a>. PyPI <a class="reference internal" href="#package-display"><em>displays a home page</em></a> for each package created from the <tt class="docutils literal"><span class="pre">long_description</span></tt> submitted by the <strong class="command">register</strong> command.</p> <div class="section" id="registering-packages"> <span id="package-register"></span><h2>6.1. Registering Packages<a class="headerlink" href="#registering-packages" title="Permalink to this headline">¶</a></h2> <p>The distutils command <strong class="command">register</strong> is used to submit your distribution’s meta-data to the index. It is invoked as follows:</p> <div class="highlight-python"><pre>python setup.py register</pre> </div> <p>Distutils will respond with the following prompt:</p> <div class="highlight-python"><pre>running register We need to know who you are, so please choose either: 1. use your existing login, 2. register as a new user, 3. have the server generate a new password for you (and email it to you), or 4. quit Your selection [default 1]:</pre> </div> <p>Note: if your username and password are saved locally, you will not see this menu.</p> <p>If you have not registered with PyPI, then you will need to do so now. You should choose option 2, and enter your details as required. Soon after submitting your details, you will receive an email which will be used to confirm your registration.</p> <p>Once you are registered, you may choose option 1 from the menu. You will be prompted for your PyPI username and password, and <strong class="command">register</strong> will then submit your meta-data to the index.</p> <p>You may submit any number of versions of your distribution to the index. If you alter the meta-data for a particular version, you may submit it again and the index will be updated.</p> <p>PyPI holds a record for each (name, version) combination submitted. The first user to submit information for a given name is designated the Owner of that name. They may submit changes through the <strong class="command">register</strong> command or through the web interface. They may also designate other users as Owners or Maintainers. Maintainers may edit the package information, but not designate other Owners or Maintainers.</p> <p>By default PyPI displays only the newest version of a given package. The web interface lets one change this default behavior and manually select which versions to display and hide.</p> </div> <div class="section" id="uploading-packages"> <span id="package-upload"></span><h2>6.2. Uploading Packages<a class="headerlink" href="#uploading-packages" title="Permalink to this headline">¶</a></h2> <p class="versionadded"> <span class="versionmodified">New in version 2.5.</span></p> <p>The distutils command <strong class="command">upload</strong> pushes the distribution files to PyPI.</p> <p>The command is invoked immediately after building one or more distribution files. For example, the command</p> <div class="highlight-python"><pre>python setup.py sdist bdist_wininst upload</pre> </div> <p>will cause the source distribution and the Windows installer to be uploaded to PyPI. Note that these will be uploaded even if they are built using an earlier invocation of <tt class="file docutils literal"><span class="pre">setup.py</span></tt>, but that only distributions named on the command line for the invocation including the <strong class="command">upload</strong> command are uploaded.</p> <p>The <strong class="command">upload</strong> command uses the username, password, and repository URL from the <tt class="file docutils literal"><span class="pre">$HOME/.pypirc</span></tt> file (see section <a class="reference internal" href="#pypirc"><em>The .pypirc file</em></a> for more on this file). If a <strong class="command">register</strong> command was previously called in the same command, and if the password was entered in the prompt, <strong class="command">upload</strong> will reuse the entered password. This is useful if you do not want to store a clear text password in the <tt class="file docutils literal"><span class="pre">$HOME/.pypirc</span></tt> file.</p> <p>You can specify another PyPI server with the <tt class="docutils literal"><span class="pre">--repository=url</span></tt> option:</p> <div class="highlight-python"><pre>python setup.py sdist bdist_wininst upload -r http://example.com/pypi</pre> </div> <p>See section <a class="reference internal" href="#pypirc"><em>The .pypirc file</em></a> for more on defining several servers.</p> <p>You can use the <tt class="docutils literal"><span class="pre">--sign</span></tt> option to tell <strong class="command">upload</strong> to sign each uploaded file using GPG (GNU Privacy Guard). The <strong class="program">gpg</strong> program must be available for execution on the system <span class="target" id="index-1"></span><tt class="xref std std-envvar docutils literal"><span class="pre">PATH</span></tt>. You can also specify which key to use for signing using the <tt class="docutils literal"><span class="pre">--identity=name</span></tt> option.</p> <p>Other <strong class="command">upload</strong> options include <tt class="docutils literal"><span class="pre">--repository=url</span></tt> or <tt class="docutils literal"><span class="pre">--repository=section</span></tt> where <em>url</em> is the url of the server and <em>section</em> the name of the section in <tt class="file docutils literal"><span class="pre">$HOME/.pypirc</span></tt>, and <tt class="docutils literal"><span class="pre">--show-response</span></tt> (which displays the full response text from the PyPI server for help in debugging upload problems).</p> </div> <div class="section" id="the-pypirc-file"> <span id="pypirc"></span><span id="index-2"></span><h2>6.3. The .pypirc file<a class="headerlink" href="#the-pypirc-file" title="Permalink to this headline">¶</a></h2> <p>The format of the <tt class="file docutils literal"><span class="pre">.pypirc</span></tt> file is as follows:</p> <div class="highlight-python"><pre>[distutils] index-servers = pypi [pypi] repository: <repository-url> username: <username> password: <password></pre> </div> <p>The <em>distutils</em> section defines a <em>index-servers</em> variable that lists the name of all sections describing a repository.</p> <p>Each section describing a repository defines three variables:</p> <ul> <li><dl class="first docutils"> <dt><em>repository</em>, that defines the url of the PyPI server. Defaults to</dt> <dd><p class="first last"><tt class="docutils literal"><span class="pre">http://www.python.org/pypi</span></tt>.</p> </dd> </dl> </li> <li><p class="first"><em>username</em>, which is the registered username on the PyPI server.</p> </li> <li><dl class="first docutils"> <dt><em>password</em>, that will be used to authenticate. If omitted the user</dt> <dd><p class="first last">will be prompt to type it when needed.</p> </dd> </dl> </li> </ul> <p>If you want to define another server a new section can be created and listed in the <em>index-servers</em> variable:</p> <div class="highlight-python"><pre>[distutils] index-servers = pypi other [pypi] repository: <repository-url> username: <username> password: <password> [other] repository: http://example.com/pypi username: <username> password: <password></pre> </div> <p><strong class="command">register</strong> can then be called with the -r option to point the repository to work with:</p> <div class="highlight-python"><pre>python setup.py register -r http://example.com/pypi</pre> </div> <p>For convenience, the name of the section that describes the repository may also be used:</p> <div class="highlight-python"><pre>python setup.py register -r other</pre> </div> </div> <div class="section" id="pypi-package-display"> <span id="package-display"></span><h2>6.4. PyPI package display<a class="headerlink" href="#pypi-package-display" title="Permalink to this headline">¶</a></h2> <p>The <tt class="docutils literal"><span class="pre">long_description</span></tt> field plays a special role at PyPI. It is used by the server to display a home page for the registered package.</p> <p>If you use the <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> syntax for this field, PyPI will parse it and display an HTML output for the package home page.</p> <p>The <tt class="docutils literal"><span class="pre">long_description</span></tt> field can be attached to a text file located in the package:</p> <div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">distutils.core</span> <span class="kn">import</span> <span class="n">setup</span> <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="s">'README.txt'</span><span class="p">)</span> <span class="k">as</span> <span class="nb">file</span><span class="p">:</span> <span class="n">long_description</span> <span class="o">=</span> <span class="nb">file</span><span class="o">.</span><span class="n">read</span><span class="p">()</span> <span class="n">setup</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s">'Distutils'</span><span class="p">,</span> <span class="n">long_description</span><span class="o">=</span><span class="n">long_description</span><span class="p">)</span> </pre></div> </div> <p>In that case, <tt class="file docutils literal"><span class="pre">README.txt</span></tt> is a regular reStructuredText text file located in the root of the package besides <tt class="file docutils literal"><span class="pre">setup.py</span></tt>.</p> <p>To prevent registering broken reStructuredText content, you can use the <strong class="program">rst2html</strong> program that is provided by the <tt class="xref py py-mod docutils literal"><span class="pre">docutils</span></tt> package and check the <tt class="docutils literal"><span class="pre">long_description</span></tt> from the command line:</p> <div class="highlight-python"><pre>$ python setup.py --long-description | rst2html.py > output.html</pre> </div> <p><tt class="xref py py-mod docutils literal"><span class="pre">docutils</span></tt> will display a warning if there’s something wrong with your syntax. Because PyPI applies additional checks (e.g. by passing <tt class="docutils literal"><span class="pre">--no-raw</span></tt> to <tt class="docutils literal"><span class="pre">rst2html.py</span></tt> in the command above), being able to run the command above without warnings does not guarantee that PyPI will convert the content successfully.</p> </div> </div> </div> </div> </div> <div class="sphinxsidebar"> <div class="sphinxsidebarwrapper"> <h3><a href="../contents.html">Table Of Contents</a></h3> <ul> <li><a class="reference internal" href="#">6. The Python Package Index (PyPI)</a><ul> <li><a class="reference internal" href="#registering-packages">6.1. Registering Packages</a></li> <li><a class="reference internal" href="#uploading-packages">6.2. Uploading Packages</a></li> <li><a class="reference internal" href="#the-pypirc-file">6.3. The .pypirc file</a></li> <li><a class="reference internal" href="#pypi-package-display">6.4. PyPI package display</a></li> </ul> </li> </ul> <h4>Previous topic</h4> <p class="topless"><a href="builtdist.html" title="previous chapter">5. Creating Built Distributions</a></p> <h4>Next topic</h4> <p class="topless"><a href="examples.html" title="next chapter">7. Examples</a></p> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="../bugs.html">Report a Bug</a></li> <li><a href="../_sources/distutils/packageindex.txt" rel="nofollow">Show Source</a></li> </ul> <div id="searchbox" style="display: none"> <h3>Quick search</h3> <form class="search" action="../search.html" method="get"> <input type="text" name="q" /> <input type="submit" value="Go" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> <p class="searchtip" style="font-size: 90%"> Enter search terms or a module, class or function name. </p> </div> <script type="text/javascript">$('#searchbox').show(0);</script> </div> </div> <div class="clearer"></div> </div> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../genindex.html" title="General Index" >index</a></li> <li class="right" > <a href="../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="examples.html" title="7. Examples" >next</a> |</li> <li class="right" > <a href="builtdist.html" title="5. Creating Built Distributions" >previous</a> |</li> <li><img src="../_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="http://www.python.org/">Python</a> »</li> <li> <a href="../index.html">Python 2.7.5 documentation</a> » </li> <li><a href="index.html" >Distributing Python Modules</a> »</li> </ul> </div> <div class="footer"> © <a href="../copyright.html">Copyright</a> 1990-2020, Python Software Foundation. <br /> The Python Software Foundation is a non-profit corporation. <a href="http://www.python.org/psf/donations/">Please donate.</a> <br /> Last updated on Oct 13, 2020. <a href="../bugs.html">Found a bug</a>? <br /> Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3. </div> </body> </html>