source: general/prog/python-dependencies/pyproject-metadata.xml@ 93218512

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE sect2 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../../general.ent">
  %general-entities;

  <!ENTITY pyproject-metadata-download-http "https://files.pythonhosted.org/packages/source/p/pyproject-metadata/pyproject_metadata-&pyproject-metadata-version;.tar.gz">
  <!ENTITY pyproject-metadata-download-ftp  " ">
  <!ENTITY pyproject-metadata-md5sum        "&pyproject-metadata-md5sum;">
  <!ENTITY pyproject-metadata-size          "8 KB">
  <!ENTITY pyproject-metadata-buildsize     "124 KB">
  <!ENTITY pyproject-metadata-time          "less than 0.1 SBU">
]>

  <sect2 id="pyproject-metadata" xreflabel="pyproject-metadata-&pyproject-metadata-version;">

    <title>Pyproject-Metadata-&pyproject-metadata-version;</title>

    <indexterm zone="pyproject-metadata">
      <primary sortas="a-pyproject-metadata">pyproject-metadata</primary>
    </indexterm>

    <sect3 role="package">
      <title>Introduction to Pyproject-Metadata Module</title>

      <para>
        The <application>Pyproject-Metadata</application> module contains
        a data class for PEP 621 metadata with support for
        <quote>core metadata</quote> (PEP 643) generation.
      </para>

      &lfs121_checked;

      <bridgehead renderas="sect4">Package Information</bridgehead>
      <itemizedlist spacing="compact">
        <listitem>
          <para>
            Download (HTTP): <ulink url="&pyproject-metadata-download-http;"/>
          </para>
        </listitem>
        <listitem>
          <para>
            Download (FTP): <ulink url="&pyproject-metadata-download-ftp;"/>
          </para>
        </listitem>
        <listitem>
          <para>
            Download MD5 sum: &pyproject-metadata-md5sum;
          </para>
        </listitem>
        <listitem>
          <para>
            Download size: &pyproject-metadata-size;
          </para>
        </listitem>
        <listitem>
          <para>
            Estimated disk space required: &pyproject-metadata-buildsize;
          </para>
        </listitem>
        <listitem>
          <para>
            Estimated build time: &pyproject-metadata-time;
          </para>
        </listitem>
      </itemizedlist>

      <bridgehead renderas="sect4">Pyproject-Metadata Dependencies</bridgehead>

      <bridgehead renderas="sect5">Required</bridgehead>
      <para role="required">
        <xref linkend="packaging"/>
      </para>

      <bridgehead renderas="sect5">Optional (for testing)</bridgehead>
      <para role="optional">
        <xref linkend="pytest"/>
      </para>

    </sect3>

    <sect3 role="installation">
      <title>Installation of Pyproject-Metadata</title>

    <para>Build the module: </para>

&build-wheel;

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>&install-wheel; pyproject-metadata</userinput></screen>

    <!-- "pytest-cov[toml]" is referred but it seems not really used -->
    <para>
      To test the installation, issue: <command>pytest</command>.
    </para>

    </sect3>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../../xincludes/pip3-cmd-explain.xml"/>

    <sect3 role="content">
      <title>Contents</title>

      <segmentedlist>
        <segtitle>Installed Programs</segtitle>
        <segtitle>Installed Libraries</segtitle>
        <segtitle>Installed Directories</segtitle>

        <seglistitem>
          <seg>None</seg>
          <seg>None</seg>
          <seg>
            /usr/lib/python&python3-majorver;/site-packages/pyproject_metadata and
            /usr/lib/python&python3-majorver;/site-packages/pyproject_metadata-&pyproject-metadata-version;.dist-info
          </seg>
        </seglistitem>
      </segmentedlist>

    </sect3>

  </sect2>