https://wiki.softwareheritage.org/index.php?action=history&feed=atom&title=Python_package_layout 2026-04-20T12:35:57Z Revision history for this page on the wiki MediaWiki 1.39.10 https://wiki.softwareheritage.org/index.php?title=Python_package_layout&diff=687&oldid=prev 2017-09-07T13:07:47Z

<p><span dir="auto"><span class="autocomment">Makefile: </span> document &quot;docs&quot; target</span></p> <table style="background-color: #fff; color: #202122;" data-mw="interface"> <col class="diff-marker" /> <col class="diff-content" /> <col class="diff-marker" /> <col class="diff-content" /> <tr class="diff-title" lang="en"> <td colspan="2" style="background-color: #fff; color: #202122; text-align: center;">← Older revision</td> <td colspan="2" style="background-color: #fff; color: #202122; text-align: center;">Revision as of 13:07, 7 September 2017</td> </tr><tr><td colspan="2" class="diff-lineno" id="mw-diff-left-l15">Line 15:</td> <td colspan="2" class="diff-lineno">Line 15:</td></tr> <tr><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>;coverage</div></td><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>;coverage</div></td></tr> <tr><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>:run test suite and verify code coverage</div></td><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>:run test suite and verify code coverage</div></td></tr> <tr><td colspan="2" class="diff-side-deleted"></td><td class="diff-marker" data-marker="+"></td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;">;docs</ins></div></td></tr> <tr><td colspan="2" class="diff-side-deleted"></td><td class="diff-marker" data-marker="+"></td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;">:generate HTML documentation using Sphinx</ins></div></td></tr> <tr><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><br/></td><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><br/></td></tr> <tr><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>=== Generic Python Makefile ===</div></td><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>=== Generic Python Makefile ===</div></td></tr> </table>

StefanoZacchiroli https://wiki.softwareheritage.org/index.php?title=Python_package_layout&diff=233&oldid=prev 2016-07-20T13:02:35Z

<p>1 revision: import public pages from the intranet wiki</p> <table style="background-color: #fff; color: #202122;" data-mw="interface"> <tr class="diff-title" lang="en"> <td colspan="1" style="background-color: #fff; color: #202122; text-align: center;">← Older revision</td> <td colspan="1" style="background-color: #fff; color: #202122; text-align: center;">Revision as of 13:02, 20 July 2016</td> </tr><tr><td colspan="2" class="diff-notice" lang="en"><div class="mw-diff-empty">(No difference)</div> </td></tr></table>

StefanoZacchiroli https://wiki.softwareheritage.org/index.php?title=Python_package_layout&diff=232&oldid=prev 2015-09-23T11:56:18Z

<p></p> <p><b>New page</b></p><div>This page documents the expected layout/behavior of Python packages developed by [[Software Heritage]].<br /> <br /> == Naming convention ==<br /> <br /> * a Git repository called &lt;tt&gt;swh-something-else&lt;/tt&gt; contains the Python package &lt;tt&gt;swh.something.else&lt;/tt&gt;<br /> <br /> == Makefile ==<br /> <br /> Packages should have a top-level &lt;tt&gt;Makefile&lt;/tt&gt; with the following targets:<br /> <br /> ;check<br /> :run static code checks<br /> ;test<br /> :run test suite<br /> ;coverage<br /> :run test suite and verify code coverage<br /> <br /> === Generic Python Makefile ===<br /> <br /> The simplest way to fulfill Makefile requirements is to use the common Python Makefile available in [[swh-environment]], e.g.:<br /> &lt;pre&gt;<br /> $ cd swh-environment/swh-core <br /> $ cat Makefile <br /> # Makefile driver for SWH Python packages. DO NOT CHANGE.<br /> # You can add custom Makefile rules to Makefile.local<br /> <br /> include ../Makefile.python<br /> -include Makefile.local<br /> &lt;/pre&gt;<br /> <br /> == Package metadata ==<br /> <br /> Each Python package should use the following top-level files to capture its metadata:<br /> <br /> ;requirements.txt<br /> :dependencies on other packages, [https://pip.readthedocs.org/en/1.1/requirements.html as expected by pip]<br /> ;setup.py<br /> :[http://pythonhosted.org/setuptools/ setuptools] packaging driver<br /> <br /> == See also ==<br /> <br /> * [[Python style guide]]<br /> <br /> <br /> [[Category:Software development]]<br /> [[Category:Python]]</div>

StefanoZacchiroli