CINXE.COM

PEP 314 – Metadata for Python Software Packages 1.1 | peps.python.org

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="color-scheme" content="light dark"> <title>PEP 314 – Metadata for Python Software Packages 1.1 | peps.python.org</title> <link rel="shortcut icon" href="../_static/py.png"> <link rel="canonical" href="https://peps.python.org/pep-0314/"> <link rel="stylesheet" href="../_static/style.css" type="text/css"> <link rel="stylesheet" href="../_static/mq.css" type="text/css"> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" media="(prefers-color-scheme: light)" id="pyg-light"> <link rel="stylesheet" href="../_static/pygments_dark.css" type="text/css" media="(prefers-color-scheme: dark)" id="pyg-dark"> <link rel="alternate" type="application/rss+xml" title="Latest PEPs" href="https://peps.python.org/peps.rss"> <meta property="og:title" content='PEP 314 – Metadata for Python Software Packages 1.1 | peps.python.org'> <meta property="og:description" content="This PEP describes a mechanism for adding metadata to Python packages. It includes specifics of the field names, and their semantics and usage."> <meta property="og:type" content="website"> <meta property="og:url" content="https://peps.python.org/pep-0314/"> <meta property="og:site_name" content="Python Enhancement Proposals (PEPs)"> <meta property="og:image" content="https://peps.python.org/_static/og-image.png"> <meta property="og:image:alt" content="Python PEPs"> <meta property="og:image:width" content="200"> <meta property="og:image:height" content="200"> <meta name="description" content="This PEP describes a mechanism for adding metadata to Python packages. It includes specifics of the field names, and their semantics and usage."> <meta name="theme-color" content="#3776ab"> </head> <body> <svg xmlns="http://www.w3.org/2000/svg" style="display: none;"> <symbol id="svg-sun-half" viewBox="0 0 24 24" pointer-events="all"> <title>Following system colour scheme</title> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"> <circle cx="12" cy="12" r="9"></circle> <path d="M12 3v18m0-12l4.65-4.65M12 14.3l7.37-7.37M12 19.6l8.85-8.85"></path> </svg> </symbol> <symbol id="svg-moon" viewBox="0 0 24 24" pointer-events="all"> <title>Selected dark colour scheme</title> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"> <path stroke="none" d="M0 0h24v24H0z" fill="none"></path> <path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z"></path> </svg> </symbol> <symbol id="svg-sun" viewBox="0 0 24 24" pointer-events="all"> <title>Selected light colour scheme</title> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"> <circle cx="12" cy="12" r="5"></circle> <line x1="12" y1="1" x2="12" y2="3"></line> <line x1="12" y1="21" x2="12" y2="23"></line> <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line> <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line> <line x1="1" y1="12" x2="3" y2="12"></line> <line x1="21" y1="12" x2="23" y2="12"></line> <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line> <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line> </svg> </symbol> </svg> <script> document.documentElement.dataset.colour_scheme = localStorage.getItem("colour_scheme") || "auto" </script> <section id="pep-page-section"> <header> <h1>Python Enhancement Proposals</h1> <ul class="breadcrumbs"> <li><a href="https://www.python.org/" title="The Python Programming Language">Python</a> &raquo; </li> <li><a href="../pep-0000/">PEP Index</a> &raquo; </li> <li>PEP 314</li> </ul> <button id="colour-scheme-cycler" onClick="setColourScheme(nextColourScheme())"> <svg aria-hidden="true" class="colour-scheme-icon-when-auto"><use href="#svg-sun-half"></use></svg> <svg aria-hidden="true" class="colour-scheme-icon-when-dark"><use href="#svg-moon"></use></svg> <svg aria-hidden="true" class="colour-scheme-icon-when-light"><use href="#svg-sun"></use></svg> <span class="visually-hidden">Toggle light / dark / auto colour theme</span> </button> </header> <article> <section id="pep-content"> <h1 class="page-title">PEP 314 – Metadata for Python Software Packages 1.1</h1> <dl class="rfc2822 field-list simple"> <dt class="field-odd">Author<span class="colon">:</span></dt> <dd class="field-odd">A.M. Kuchling, Richard Jones</dd> <dt class="field-even">Discussions-To<span class="colon">:</span></dt> <dd class="field-even"><a class="reference external" href="https://mail.python.org/archives/list/distutils-sig&#64;python.org/">Distutils-SIG list</a></dd> <dt class="field-odd">Status<span class="colon">:</span></dt> <dd class="field-odd"><abbr title="Replaced by another succeeding PEP">Superseded</abbr></dd> <dt class="field-even">Type<span class="colon">:</span></dt> <dd class="field-even"><abbr title="Normative PEP with a new feature for Python, implementation change for CPython or interoperability standard for the ecosystem">Standards Track</abbr></dd> <dt class="field-odd">Topic<span class="colon">:</span></dt> <dd class="field-odd"><a class="reference external" href="../topic/packaging/">Packaging</a></dd> <dt class="field-even">Created<span class="colon">:</span></dt> <dd class="field-even">12-Apr-2003</dd> <dt class="field-odd">Python-Version<span class="colon">:</span></dt> <dd class="field-odd">2.5</dd> <dt class="field-even">Post-History<span class="colon">:</span></dt> <dd class="field-even">29-Apr-2003</dd> <dt class="field-odd">Replaces<span class="colon">:</span></dt> <dd class="field-odd"><a class="reference external" href="../pep-0241/">241</a></dd> <dt class="field-even">Superseded-By<span class="colon">:</span></dt> <dd class="field-even"><a class="reference external" href="../pep-0345/">345</a></dd> </dl> <hr class="docutils" /> <section id="contents"> <details><summary>Table of Contents</summary><ul class="simple"> <li><a class="reference internal" href="#introduction">Introduction</a></li> <li><a class="reference internal" href="#including-metadata-in-packages">Including Metadata in Packages</a></li> <li><a class="reference internal" href="#fields">Fields</a><ul> <li><a class="reference internal" href="#metadata-version">Metadata-Version</a></li> <li><a class="reference internal" href="#name">Name</a></li> <li><a class="reference internal" href="#version">Version</a></li> <li><a class="reference internal" href="#platform-multiple-use">Platform (multiple use)</a></li> <li><a class="reference internal" href="#supported-platform-multiple-use">Supported-Platform (multiple use)</a></li> <li><a class="reference internal" href="#summary">Summary</a></li> <li><a class="reference internal" href="#description-optional">Description (optional)</a></li> <li><a class="reference internal" href="#keywords-optional">Keywords (optional)</a></li> <li><a class="reference internal" href="#home-page-optional">Home-page (optional)</a></li> <li><a class="reference internal" href="#download-url">Download-URL</a></li> <li><a class="reference internal" href="#author-optional">Author (optional)</a></li> <li><a class="reference internal" href="#author-email">Author-email</a></li> <li><a class="reference internal" href="#license">License</a></li> <li><a class="reference internal" href="#classifier-multiple-use">Classifier (multiple use)</a></li> <li><a class="reference internal" href="#requires-multiple-use">Requires (multiple use)</a></li> <li><a class="reference internal" href="#provides-multiple-use">Provides (multiple use)</a></li> <li><a class="reference internal" href="#obsoletes-multiple-use">Obsoletes (multiple use)</a></li> </ul> </li> <li><a class="reference internal" href="#summary-of-differences-from-pep-241">Summary of Differences From PEP 241</a></li> <li><a class="reference internal" href="#open-issues">Open issues</a></li> <li><a class="reference internal" href="#acknowledgements">Acknowledgements</a></li> <li><a class="reference internal" href="#references">References</a></li> <li><a class="reference internal" href="#copyright">Copyright</a></li> </ul> </details></section> <div class="pep-banner canonical-pypa-spec sticky-banner admonition attention"> <p class="admonition-title">Attention</p> <p>This PEP is a historical document. The up-to-date, canonical spec, <a class="reference external" href="https://packaging.python.org/en/latest/specifications/core-metadata/#core-metadata" title="(in Python Packaging User Guide)"><span>Core metadata specifications</span></a>, is maintained on the <a class="reference external" href="https://packaging.python.org/en/latest/specifications/">PyPA specs page</a>.</p> <p class="close-button">×</p> <p>See the <a class="reference external" href="https://www.pypa.io/en/latest/specifications/#handling-fixes-and-other-minor-updates">PyPA specification update process</a> for how to propose changes.</p> </div> <section id="introduction"> <h2><a class="toc-backref" href="#introduction" role="doc-backlink">Introduction</a></h2> <p>This PEP describes a mechanism for adding metadata to Python packages. It includes specifics of the field names, and their semantics and usage.</p> <p>This document specifies version 1.1 of the metadata format. Version 1.0 is specified in <a class="pep reference internal" href="../pep-0241/" title="PEP 241 – Metadata for Python Software Packages">PEP 241</a>.</p> </section> <section id="including-metadata-in-packages"> <h2><a class="toc-backref" href="#including-metadata-in-packages" role="doc-backlink">Including Metadata in Packages</a></h2> <p>The Distutils <code class="docutils literal notranslate"><span class="pre">sdist</span></code> command will extract the metadata fields from the arguments and write them to a file in the generated zipfile or tarball. This file will be named PKG-INFO and will be placed in the top directory of the source distribution (where the README, INSTALL, and other files usually go).</p> <p>Developers may not provide their own PKG-INFO file. The <code class="docutils literal notranslate"><span class="pre">sdist</span></code> command will, if it detects an existing PKG-INFO file, terminate with an appropriate error message. This should prevent confusion caused by the PKG-INFO and setup.py files being out of sync.</p> <p>The PKG-INFO file format is a single set of <span class="target" id="index-0"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc822.html"><strong>RFC 822</strong></a> headers parseable by the rfc822.py module. The field names listed in the following section are used as the header names.</p> </section> <section id="fields"> <h2><a class="toc-backref" href="#fields" role="doc-backlink">Fields</a></h2> <p>This section specifies the names and semantics of each of the supported metadata fields.</p> <p>Fields marked with “(Multiple use)” may be specified multiple times in a single PKG-INFO file. Other fields may only occur once in a PKG-INFO file. Fields marked with “(optional)” are not required to appear in a valid PKG-INFO file; all other fields must be present.</p> <section id="metadata-version"> <h3><a class="toc-backref" href="#metadata-version" role="doc-backlink">Metadata-Version</a></h3> <p>Version of the file format; currently “1.0” and “1.1” are the only legal values here.</p> <p>Example:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Metadata</span><span class="o">-</span><span class="n">Version</span><span class="p">:</span> <span class="mf">1.1</span> </pre></div> </div> </section> <section id="name"> <h3><a class="toc-backref" href="#name" role="doc-backlink">Name</a></h3> <p>The name of the package.</p> <p>Example:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Name</span><span class="p">:</span> <span class="n">BeagleVote</span> </pre></div> </div> </section> <section id="version"> <h3><a class="toc-backref" href="#version" role="doc-backlink">Version</a></h3> <p>A string containing the package’s version number. This field should be parseable by one of the Version classes (StrictVersion or LooseVersion) in the distutils.version module.</p> <p>Example:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Version</span><span class="p">:</span> <span class="mf">1.0</span><span class="n">a2</span> </pre></div> </div> </section> <section id="platform-multiple-use"> <h3><a class="toc-backref" href="#platform-multiple-use" role="doc-backlink">Platform (multiple use)</a></h3> <p>A comma-separated list of platform specifications, summarizing the operating systems supported by the package which are not listed in the “Operating System” Trove classifiers. See “Classifier” below.</p> <p>Example:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Platform</span><span class="p">:</span> <span class="n">ObscureUnix</span><span class="p">,</span> <span class="n">RareDOS</span> </pre></div> </div> </section> <section id="supported-platform-multiple-use"> <h3><a class="toc-backref" href="#supported-platform-multiple-use" role="doc-backlink">Supported-Platform (multiple use)</a></h3> <p>Binary distributions containing a PKG-INFO file will use the Supported-Platform field in their metadata to specify the OS and CPU for which the binary package was compiled. The semantics of the Supported-Platform field are not specified in this PEP.</p> <p>Example:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Supported</span><span class="o">-</span><span class="n">Platform</span><span class="p">:</span> <span class="n">RedHat</span> <span class="mf">7.2</span> <span class="n">Supported</span><span class="o">-</span><span class="n">Platform</span><span class="p">:</span> <span class="n">i386</span><span class="o">-</span><span class="n">win32</span><span class="o">-</span><span class="mi">2791</span> </pre></div> </div> </section> <section id="summary"> <h3><a class="toc-backref" href="#summary" role="doc-backlink">Summary</a></h3> <p>A one-line summary of what the package does.</p> <p>Example:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Summary</span><span class="p">:</span> <span class="n">A</span> <span class="n">module</span> <span class="k">for</span> <span class="n">collecting</span> <span class="n">votes</span> <span class="kn">from</span> <span class="nn">beagles.</span> </pre></div> </div> </section> <section id="description-optional"> <h3><a class="toc-backref" href="#description-optional" role="doc-backlink">Description (optional)</a></h3> <p>A longer description of the package that can run to several paragraphs. Software that deals with metadata should not assume any maximum size for this field, though people shouldn’t include their instruction manual as the description.</p> <p>The contents of this field can be written using reStructuredText markup <a class="footnote-reference brackets" href="#id2" id="id1">[1]</a>. For programs that work with the metadata, supporting markup is optional; programs can also display the contents of the field as-is. This means that authors should be conservative in the markup they use.</p> <p>Example:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Description</span><span class="p">:</span> <span class="n">This</span> <span class="n">module</span> <span class="n">collects</span> <span class="n">votes</span> <span class="kn">from</span> <span class="nn">beagles</span> <span class="ow">in</span> <span class="n">order</span> <span class="n">to</span> <span class="n">determine</span> <span class="n">their</span> <span class="n">electoral</span> <span class="n">wishes</span><span class="o">.</span> <span class="n">Do</span> <span class="o">*</span><span class="ow">not</span><span class="o">*</span> <span class="k">try</span> <span class="n">to</span> <span class="n">use</span> <span class="n">this</span> <span class="n">module</span> <span class="k">with</span> <span class="n">basset</span> <span class="n">hounds</span><span class="p">;</span> <span class="n">it</span> <span class="n">makes</span> <span class="n">them</span> <span class="n">grumpy</span><span class="o">.</span> </pre></div> </div> </section> <section id="keywords-optional"> <h3><a class="toc-backref" href="#keywords-optional" role="doc-backlink">Keywords (optional)</a></h3> <p>A list of additional keywords to be used to assist searching for the package in a larger catalog.</p> <p>Example:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Keywords</span><span class="p">:</span> <span class="n">dog</span> <span class="n">puppy</span> <span class="n">voting</span> <span class="n">election</span> </pre></div> </div> </section> <section id="home-page-optional"> <h3><a class="toc-backref" href="#home-page-optional" role="doc-backlink">Home-page (optional)</a></h3> <p>A string containing the URL for the package’s home page.</p> <p>Example:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Home</span><span class="o">-</span><span class="n">page</span><span class="p">:</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">www</span><span class="o">.</span><span class="n">example</span><span class="o">.</span><span class="n">com</span><span class="o">/~</span><span class="n">cschultz</span><span class="o">/</span><span class="n">bvote</span><span class="o">/</span> </pre></div> </div> </section> <section id="download-url"> <h3><a class="toc-backref" href="#download-url" role="doc-backlink">Download-URL</a></h3> <p>A string containing the URL from which this version of the package can be downloaded. (This means that the URL can’t be something like “…/package-latest.tgz”, but instead must be “../package-0.45.tgz”.)</p> </section> <section id="author-optional"> <h3><a class="toc-backref" href="#author-optional" role="doc-backlink">Author (optional)</a></h3> <p>A string containing the author’s name at a minimum; additional contact information may be provided.</p> <p>Example:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Author</span><span class="p">:</span> <span class="n">C</span><span class="o">.</span> <span class="n">Schultz</span><span class="p">,</span> <span class="n">Universal</span> <span class="n">Features</span> <span class="n">Syndicate</span><span class="p">,</span> <span class="n">Los</span> <span class="n">Angeles</span><span class="p">,</span> <span class="n">CA</span> <span class="o">&lt;</span><span class="n">cschultz</span><span class="nd">@peanuts</span><span class="o">.</span><span class="n">example</span><span class="o">.</span><span class="n">com</span><span class="o">&gt;</span> </pre></div> </div> </section> <section id="author-email"> <h3><a class="toc-backref" href="#author-email" role="doc-backlink">Author-email</a></h3> <p>A string containing the author’s e-mail address. It can contain a name and e-mail address in the legal forms for a <span class="target" id="index-1"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc822.html"><strong>RFC 822</strong></a> ‘From:’ header. It’s not optional because cataloging systems can use the e-mail portion of this field as a unique key representing the author. A catalog might provide authors the ability to store their GPG key, personal home page, and other additional metadata <em>about the author</em>, and optionally the ability to associate several e-mail addresses with the same person. Author-related metadata fields are not covered by this PEP.</p> <p>Example:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Author</span><span class="o">-</span><span class="n">email</span><span class="p">:</span> <span class="s2">&quot;C. Schultz&quot;</span> <span class="o">&lt;</span><span class="n">cschultz</span><span class="nd">@example</span><span class="o">.</span><span class="n">com</span><span class="o">&gt;</span> </pre></div> </div> </section> <section id="license"> <h3><a class="toc-backref" href="#license" role="doc-backlink">License</a></h3> <p>Text indicating the license covering the package where the license is not a selection from the “License” Trove classifiers. See “Classifier” below.</p> <p>Example:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">License</span><span class="p">:</span> <span class="n">This</span> <span class="n">software</span> <span class="n">may</span> <span class="n">only</span> <span class="n">be</span> <span class="n">obtained</span> <span class="n">by</span> <span class="n">sending</span> <span class="n">the</span> <span class="n">author</span> <span class="n">a</span> <span class="n">postcard</span><span class="p">,</span> <span class="ow">and</span> <span class="n">then</span> <span class="n">the</span> <span class="n">user</span> <span class="n">promises</span> <span class="ow">not</span> <span class="n">to</span> <span class="n">redistribute</span> <span class="n">it</span><span class="o">.</span> </pre></div> </div> </section> <section id="classifier-multiple-use"> <h3><a class="toc-backref" href="#classifier-multiple-use" role="doc-backlink">Classifier (multiple use)</a></h3> <p>Each entry is a string giving a single classification value for the package. Classifiers are described in <a class="pep reference internal" href="../pep-0301/" title="PEP 301 – Package Index and Metadata for Distutils">PEP 301</a>.</p> <p>Examples:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Classifier</span><span class="p">:</span> <span class="n">Development</span> <span class="n">Status</span> <span class="p">::</span> <span class="mi">4</span> <span class="o">-</span> <span class="n">Beta</span> <span class="n">Classifier</span><span class="p">:</span> <span class="n">Environment</span> <span class="p">::</span> <span class="n">Console</span> <span class="p">(</span><span class="n">Text</span> <span class="n">Based</span><span class="p">)</span> </pre></div> </div> </section> <section id="requires-multiple-use"> <h3><a class="toc-backref" href="#requires-multiple-use" role="doc-backlink">Requires (multiple use)</a></h3> <p>Each entry contains a string describing some other module or package required by this package.</p> <p>The format of a requirement string is identical to that of a module or package name usable with the ‘import’ statement, optionally followed by a version declaration within parentheses.</p> <p>A version declaration is a series of conditional operators and version numbers, separated by commas. Conditional operators must be one of “&lt;”, “&gt;”, “&lt;=”, “&gt;=”, “==”, and “!=”. Version numbers must be in the format accepted by the distutils.version.StrictVersion class: two or three dot-separated numeric components, with an optional “pre-release” tag on the end consisting of the letter ‘a’ or ‘b’ followed by a number. Example version numbers are “1.0”, “2.3a2”, “1.3.99”,</p> <p>Any number of conditional operators can be specified, e.g. the string “&gt;1.0, !=1.3.4, &lt;2.0” is a legal version declaration.</p> <p>All of the following are possible requirement strings: “rfc822”, “zlib (&gt;=1.1.4)”, “zope”.</p> <p>There’s no canonical list of what strings should be used; the Python community is left to choose its own standards.</p> <p>Example:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Requires</span><span class="p">:</span> <span class="n">re</span> <span class="n">Requires</span><span class="p">:</span> <span class="n">sys</span> <span class="n">Requires</span><span class="p">:</span> <span class="n">zlib</span> <span class="n">Requires</span><span class="p">:</span> <span class="n">xml</span><span class="o">.</span><span class="n">parsers</span><span class="o">.</span><span class="n">expat</span> <span class="p">(</span><span class="o">&gt;</span><span class="mf">1.0</span><span class="p">)</span> <span class="n">Requires</span><span class="p">:</span> <span class="n">psycopg</span> </pre></div> </div> </section> <section id="provides-multiple-use"> <h3><a class="toc-backref" href="#provides-multiple-use" role="doc-backlink">Provides (multiple use)</a></h3> <p>Each entry contains a string describing a package or module that will be provided by this package once it is installed. These strings should match the ones used in Requirements fields. A version declaration may be supplied (without a comparison operator); the package’s version number will be implied if none is specified.</p> <p>Example:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Provides</span><span class="p">:</span> <span class="n">xml</span> <span class="n">Provides</span><span class="p">:</span> <span class="n">xml</span><span class="o">.</span><span class="n">utils</span> <span class="n">Provides</span><span class="p">:</span> <span class="n">xml</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">iso8601</span> <span class="n">Provides</span><span class="p">:</span> <span class="n">xml</span><span class="o">.</span><span class="n">dom</span> <span class="n">Provides</span><span class="p">:</span> <span class="n">xmltools</span> <span class="p">(</span><span class="mf">1.3</span><span class="p">)</span> </pre></div> </div> </section> <section id="obsoletes-multiple-use"> <h3><a class="toc-backref" href="#obsoletes-multiple-use" role="doc-backlink">Obsoletes (multiple use)</a></h3> <p>Each entry contains a string describing a package or module that this package renders obsolete, meaning that the two packages should not be installed at the same time. Version declarations can be supplied.</p> <p>The most common use of this field will be in case a package name changes, e.g. Gorgon 2.3 gets subsumed into Torqued Python 1.0. When you install Torqued Python, the Gorgon package should be removed.</p> <p>Example:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Obsoletes</span><span class="p">:</span> <span class="n">Gorgon</span> </pre></div> </div> </section> </section> <section id="summary-of-differences-from-pep-241"> <h2><a class="toc-backref" href="#summary-of-differences-from-pep-241" role="doc-backlink">Summary of Differences From PEP 241</a></h2> <ul class="simple"> <li>Metadata-Version is now 1.1.</li> <li>Added the Classifiers field from <a class="pep reference internal" href="../pep-0301/" title="PEP 301 – Package Index and Metadata for Distutils">PEP 301</a>.</li> <li>The License and Platform files should now only be used if the platform or license can’t be handled by an appropriate Classifier value.</li> <li>Added fields: Download-URL, Requires, Provides, Obsoletes.</li> </ul> </section> <section id="open-issues"> <h2><a class="toc-backref" href="#open-issues" role="doc-backlink">Open issues</a></h2> <p>None.</p> </section> <section id="acknowledgements"> <h2><a class="toc-backref" href="#acknowledgements" role="doc-backlink">Acknowledgements</a></h2> <p>None.</p> </section> <section id="references"> <h2><a class="toc-backref" href="#references" role="doc-backlink">References</a></h2> <aside class="footnote-list brackets"> <aside class="footnote brackets" id="id2" role="doc-footnote"> <dt class="label" id="id2">[<a href="#id1">1</a>]</dt> <dd>reStructuredText <a class="reference external" href="http://docutils.sourceforge.net/">http://docutils.sourceforge.net/</a></aside> </aside> </section> <section id="copyright"> <h2><a class="toc-backref" href="#copyright" role="doc-backlink">Copyright</a></h2> <p>This document has been placed in the public domain.</p> </section> </section> <hr class="docutils" /> <p>Source: <a class="reference external" href="https://github.com/python/peps/blob/main/peps/pep-0314.rst">https://github.com/python/peps/blob/main/peps/pep-0314.rst</a></p> <p>Last modified: <a class="reference external" href="https://github.com/python/peps/commits/main/peps/pep-0314.rst">2024-10-06 16:27:00 GMT</a></p> </article> <nav id="pep-sidebar"> <h2>Contents</h2> <ul> <li><a class="reference internal" href="#introduction">Introduction</a></li> <li><a class="reference internal" href="#including-metadata-in-packages">Including Metadata in Packages</a></li> <li><a class="reference internal" href="#fields">Fields</a><ul> <li><a class="reference internal" href="#metadata-version">Metadata-Version</a></li> <li><a class="reference internal" href="#name">Name</a></li> <li><a class="reference internal" href="#version">Version</a></li> <li><a class="reference internal" href="#platform-multiple-use">Platform (multiple use)</a></li> <li><a class="reference internal" href="#supported-platform-multiple-use">Supported-Platform (multiple use)</a></li> <li><a class="reference internal" href="#summary">Summary</a></li> <li><a class="reference internal" href="#description-optional">Description (optional)</a></li> <li><a class="reference internal" href="#keywords-optional">Keywords (optional)</a></li> <li><a class="reference internal" href="#home-page-optional">Home-page (optional)</a></li> <li><a class="reference internal" href="#download-url">Download-URL</a></li> <li><a class="reference internal" href="#author-optional">Author (optional)</a></li> <li><a class="reference internal" href="#author-email">Author-email</a></li> <li><a class="reference internal" href="#license">License</a></li> <li><a class="reference internal" href="#classifier-multiple-use">Classifier (multiple use)</a></li> <li><a class="reference internal" href="#requires-multiple-use">Requires (multiple use)</a></li> <li><a class="reference internal" href="#provides-multiple-use">Provides (multiple use)</a></li> <li><a class="reference internal" href="#obsoletes-multiple-use">Obsoletes (multiple use)</a></li> </ul> </li> <li><a class="reference internal" href="#summary-of-differences-from-pep-241">Summary of Differences From PEP 241</a></li> <li><a class="reference internal" href="#open-issues">Open issues</a></li> <li><a class="reference internal" href="#acknowledgements">Acknowledgements</a></li> <li><a class="reference internal" href="#references">References</a></li> <li><a class="reference internal" href="#copyright">Copyright</a></li> </ul> <br> <a id="source" href="https://github.com/python/peps/blob/main/peps/pep-0314.rst">Page Source (GitHub)</a> </nav> </section> <script src="../_static/colour_scheme.js"></script> <script src="../_static/wrap_tables.js"></script> <script src="../_static/sticky_banner.js"></script> </body> </html>

Pages: 1 2 3 4 5 6 7 8 9 10