glfs/general/prog/python-modules/cachecontrol.xml

<?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;

 <!-- cannot access, page for 0.12.11 has unreadably long hashes and I cannot paste it
  <!ENTITY cachecontrol-download-http "https://files.pythonhosted.org/packages/source/c/CacheControl/CacheControl-&cachecontrol-version;.tar.gz">
  Latest version is 0.12.12 but NOT at pypi, has at least one issue
   https://github.com/ionrock/cachecontrol/issues/285 and github only has tags -->
  <!ENTITY cachecontrol-download-http "https://github.com/psf/cachecontrol/archive/refs/tags/v&cachecontrol-version;/cachecontrol-&cachecontrol-version;.tar.gz">
  <!ENTITY cachecontrol-download-ftp  " ">
  <!ENTITY cachecontrol-md5sum        "&cachecontrol-md5sum;">
  <!ENTITY cachecontrol-size          "44 KB">
  <!ENTITY cachecontrol-buildsize     "344 KB">
  <!ENTITY cachecontrol-time          "less than 0.1 SBU">
]>

  <sect2 id="cachecontrol" xreflabel="CacheControl-&cachecontrol-version;">

    <title>CacheControl-&cachecontrol-version;</title>

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

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

      <para>
        <application>CacheControl</application> is a port of the caching
        algorithms in httplib2 for use with requests session object. It was
        written because httplib2's better support for caching is often
        mitigated by its lack of thread safety. The same is true of requests
        in terms of caching.
      </para>

      &lfs120_checked;

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

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

      <bridgehead renderas="sect5">Required</bridgehead>
      <para role="required">
        <xref linkend="msgpack"/> and
        <xref linkend="requests"/>
      </para>

      <!-- commented in case fixed in newer version
      <bridgehead renderas="sect5">Optional (for testing)</bridgehead>
      <para role="optional">
        <xref linkend="pluggy"/>,
        <xref linkend="pytests"/>
      </para> -->

    </sect3>

    <sect3 role="installation">
      <title>Installation of CacheControl</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; cachecontrol</userinput></screen>

      <para>
        <!-- tests run with plain 'pytest', but 0 items are selected,
             resulting in non-zero status -->
        This module does not have a working test suite.
      </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>
            doesitcache
          </seg>
          <seg>None</seg>
          <seg>
            /usr/lib/python&python3-majorver;/site-packages/CacheControl-&cachecontrol-version;.dist-info and
            /usr/lib/python&python3-majorver;/site-packages/cachecontrol
          </seg>
        </seglistitem>
      </segmentedlist>

      <variablelist>
        <bridgehead renderas="sect5">Short Descriptions</bridgehead>
        <?dbfo list-presentation="list"?>
        <?dbhtml list-presentation="table"?>

        <varlistentry id="doesitcache">
          <term><command>doesitcache</command></term>
          <listitem>
            <para>
              is an undocumented command line script.
              <!-- debian patch this out as undocumented and unnecessary -->
            </para>
            <indexterm zone="cachecontrol">
              <primary sortas="b-cachecontrol">doesitcache</primary>
            </indexterm>
          </listitem>
        </varlistentry>

      </variablelist>

    </sect3>

  </sect2>