source: general/prog/python-dependencies/meson_python.xml@ 28c578d

<?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 meson_python-download-http "https://files.pythonhosted.org/packages/source/m/meson_python/meson_python-&meson_python-version;.tar.gz">
  <!ENTITY meson_python-download-ftp  " ">
  <!ENTITY meson_python-md5sum        "&meson_python-md5sum;">
  <!ENTITY meson_python-size          "80 KB">
  <!ENTITY meson_python-buildsize     "1.3 MB">
  <!ENTITY meson_python-time          "less than 0.1 SBU">
]>

  <sect2 id="meson_python" xreflabel="meson_python-&meson_python-version;">

    <title>Meson_python-&meson_python-version;</title>

    <indexterm zone="meson_python">
      <primary sortas="a-meson_python">meson_python</primary>
    </indexterm>

    <sect3 role="package">
      <title>Introduction to Meson_python Module</title>

      <para>
        The <application>Meson_python</application> module contains
        a Python build backend (PEP 517) for Meson projects.
      </para>

      &lfs121_checked;

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

      <bridgehead renderas="sect4">Meson_python Dependencies</bridgehead>

      <bridgehead renderas="sect5">Required</bridgehead>
      <para role="required">
        <xref linkend="pyproject-metadata"/>
      </para>

      <bridgehead renderas="sect5">Recommended (Runtime)</bridgehead>
      <para role="runtime">
        <xref linkend="patchelf"/>
      </para>

      <bridgehead renderas="sect5">Optional (for testing)</bridgehead>
      <para role="optional">
        <xref linkend="cython"/>,
        <xref linkend="git"/>,
        <xref linkend="pytest"/>,
        <xref linkend="python3"/> (rebuilt after installing
        <xref role="nodep" linkend="sqlite"/>),
        <ulink url="https://pypi.org/project/build/">build</ulink>,
        <!-- pytest-cov mentioned but it seems not really used unless
             running the "coverage" command explicitly -->
        and
        <ulink url="https://pypi.org/project/pytest-mock/">pytest-mock</ulink>
      </para>
    </sect3>

    <sect3 role="installation">
      <title>Installation of Meson_python</title>

    <para>Build the module: </para>

&build-wheel;

    <para>
      This package does not come with a test suite.
    </para>

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

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

    <para>
      To test the installation, make sure <xref linkend='git'/>,
      <xref linkend='patchelf'/>, and <xref linkend='pytest'/> are
      installed, and <xref linkend='python3'/>
      has been rebuilt after installing <xref linkend='sqlite'/>, then
      issue (<literal>HOME=</literal> prevents the
      <filename>.gitconfig</filename> file in the home directory from
      interfering the tests):
    </para>

<screen remap="test"><userinput>python3 -m venv --system-site-packages testenv &amp;&amp;
testenv/bin/pip3 install 'meson_python[test]'  &amp;&amp;
HOME= testenv/bin/python -m pytest</userinput></screen>

    <!-- https://github.com/mesonbuild/meson-python/issues/619 -->
    <para>
      Two tests named <literal>test_missing_version</literal> and
      <literal>test_pep621</literal> are known to fail with
      pyproject-metadata-0.8.0 or later.
    </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/meson_python and
            /usr/lib/python&python3-majorver;/site-packages/meson_python-&meson_python-version;.dist-info
          </seg>
        </seglistitem>
      </segmentedlist>

    </sect3>

  </sect2>