source: general/prog/python-dependencies/msgpack.xml@ 6a22b91

<?xml version="1.0" encoding="ISO-8859-1"?>
<!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 msgpack-download-http "https://files.pythonhosted.org/packages/source/m/msgpack/msgpack-&msgpack-version;.tar.gz">
  <!ENTITY msgpack-download-ftp  " ">
  <!ENTITY msgpack-md5sum        "&msgpack-md5sum;">
  <!ENTITY msgpack-size          "126 KB">
  <!ENTITY msgpack-buildsize     "1.9 MB (add 0.3 MB for tests)">
  <!ENTITY msgpack-time          "less than 0.1 SBU">
]>

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

    <title>MessagePack-&msgpack-version;</title>

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

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

      <para>
        <application>MessagePack</application> is an efficient binary
        serialization format. It lets you exchange data among multiple
        languages like JSON. But it's faster and smaller. This package
        provides CPython bindings for reading and writing MessagePack data.
      </para>

      &lfs113_checked;

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

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

      <bridgehead renderas="sect5">Required</bridgehead>
      <para role="required">
        <xref linkend="cython"/>,
        <xref linkend="setuptools_scm"/>
      </para>

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

    </sect3>

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

      <para> Build the module: </para>

<screen><userinput>pip3 wheel -w dist --no-build-isolation --no-deps $PWD</userinput></screen>

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

<screen role="root"><userinput>pip3 install --no-index --find-links dist --no-cache-dir --no-user msgpack</userinput></screen>

      <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/msgpack-&msgpack-version;.dist-info,
            /usr/lib/python&python3-majorver;/site-packages/msgpack
          </seg>
        </seglistitem>
      </segmentedlist>

    </sect3>

  </sect2>