[381cfd18] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect2 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
| 7 | <!-- cannot access, page for 0.12.11 has unreadably long hashes and I cannot paste it
|
---|
| 8 | <!ENTITY cachecontrol-download-http "https://files.pythonhosted.org/packages/source/c/CacheControl/CacheControl-&cachecontrol-version;.tar.gz">
|
---|
| 9 | Latest version is 0.12.12 but NOT at pypi, has at least one issue
|
---|
[2b533f75] | 10 | https://github.com/ionrock/cachecontrol/issues/285 and github only has tags -->
|
---|
[d3cf76e] | 11 | <!ENTITY cachecontrol-download-http "https://github.com/psf/cachecontrol/archive/refs/tags/v&cachecontrol-version;/cachecontrol-&cachecontrol-version;.tar.gz">
|
---|
[381cfd18] | 12 | <!ENTITY cachecontrol-download-ftp " ">
|
---|
| 13 | <!ENTITY cachecontrol-md5sum "&cachecontrol-md5sum;">
|
---|
[d3cf76e] | 14 | <!ENTITY cachecontrol-size "44 KB">
|
---|
[023dffb] | 15 | <!ENTITY cachecontrol-buildsize "344 KB">
|
---|
[381cfd18] | 16 | <!ENTITY cachecontrol-time "less than 0.1 SBU">
|
---|
| 17 | ]>
|
---|
| 18 |
|
---|
| 19 | <sect2 id="cachecontrol" xreflabel="CacheControl-&cachecontrol-version;">
|
---|
| 20 |
|
---|
| 21 | <title>CacheControl-&cachecontrol-version;</title>
|
---|
| 22 |
|
---|
| 23 | <indexterm zone="cachecontrol">
|
---|
| 24 | <primary sortas="a-cachecontrol">cachecontrol</primary>
|
---|
| 25 | </indexterm>
|
---|
| 26 |
|
---|
| 27 | <sect3 role="package">
|
---|
| 28 | <title>Introduction to CacheControl Module</title>
|
---|
| 29 |
|
---|
| 30 | <para>
|
---|
| 31 | <application>CacheControl</application> is a port of the caching
|
---|
| 32 | algorithms in httplib2 for use with requests session object. It was
|
---|
[a8c1294] | 33 | written because httplib2's better support for caching is often
|
---|
[381cfd18] | 34 | mitigated by its lack of thread safety. The same is true of requests
|
---|
| 35 | in terms of caching.
|
---|
| 36 | </para>
|
---|
| 37 |
|
---|
[282a0eb] | 38 | &lfs120_checked;
|
---|
[381cfd18] | 39 |
|
---|
| 40 | <bridgehead renderas="sect4">Package Information</bridgehead>
|
---|
| 41 | <itemizedlist spacing="compact">
|
---|
| 42 | <listitem>
|
---|
| 43 | <para>
|
---|
| 44 | Download (HTTP): <ulink url="&cachecontrol-download-http;"/>
|
---|
| 45 | </para>
|
---|
| 46 | </listitem>
|
---|
| 47 | <listitem>
|
---|
| 48 | <para>
|
---|
| 49 | Download (FTP): <ulink url="&cachecontrol-download-ftp;"/>
|
---|
| 50 | </para>
|
---|
| 51 | </listitem>
|
---|
| 52 | <listitem>
|
---|
| 53 | <para>
|
---|
| 54 | Download MD5 sum: &cachecontrol-md5sum;
|
---|
| 55 | </para>
|
---|
| 56 | </listitem>
|
---|
| 57 | <listitem>
|
---|
| 58 | <para>
|
---|
| 59 | Download size: &cachecontrol-size;
|
---|
| 60 | </para>
|
---|
| 61 | </listitem>
|
---|
| 62 | <listitem>
|
---|
| 63 | <para>
|
---|
| 64 | Estimated disk space required: &cachecontrol-buildsize;
|
---|
| 65 | </para>
|
---|
| 66 | </listitem>
|
---|
| 67 | <listitem>
|
---|
| 68 | <para>
|
---|
| 69 | Estimated build time: &cachecontrol-time;
|
---|
| 70 | </para>
|
---|
| 71 | </listitem>
|
---|
| 72 | </itemizedlist>
|
---|
| 73 |
|
---|
| 74 | <bridgehead renderas="sect4">CacheControl Dependencies</bridgehead>
|
---|
| 75 |
|
---|
| 76 | <bridgehead renderas="sect5">Required</bridgehead>
|
---|
| 77 | <para role="required">
|
---|
[a8c1294] | 78 | <xref linkend="msgpack"/> and
|
---|
[381cfd18] | 79 | <xref linkend="requests"/>
|
---|
| 80 | </para>
|
---|
| 81 |
|
---|
| 82 | <!-- commented in case fixed in newer version
|
---|
| 83 | <bridgehead renderas="sect5">Optional (for testing)</bridgehead>
|
---|
| 84 | <para role="optional">
|
---|
| 85 | <xref linkend="pluggy"/>,
|
---|
| 86 | <xref linkend="pytests"/>
|
---|
| 87 | </para> -->
|
---|
| 88 |
|
---|
| 89 | </sect3>
|
---|
| 90 |
|
---|
| 91 | <sect3 role="installation">
|
---|
| 92 | <title>Installation of CacheControl</title>
|
---|
| 93 |
|
---|
| 94 | <para> Build the module: </para>
|
---|
| 95 |
|
---|
| 96 | <screen><userinput>pip3 wheel -w dist --no-build-isolation --no-deps $PWD</userinput></screen>
|
---|
| 97 |
|
---|
| 98 | <para>
|
---|
| 99 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 100 | </para>
|
---|
| 101 |
|
---|
| 102 | <screen role="root"><userinput>pip3 install --no-index --find-links dist --no-cache-dir --no-user cachecontrol</userinput></screen>
|
---|
| 103 |
|
---|
| 104 | <para>
|
---|
| 105 | <!-- tests run with plain 'pytest', but 0 items are selected,
|
---|
| 106 | resulting in non-zero status -->
|
---|
| 107 | This module does not have a working test suite.
|
---|
| 108 | </para>
|
---|
| 109 |
|
---|
| 110 | </sect3>
|
---|
| 111 |
|
---|
| 112 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 113 | href="../../../xincludes/pip3-cmd-explain.xml"/>
|
---|
| 114 |
|
---|
| 115 | <sect3 role="content">
|
---|
| 116 | <title>Contents</title>
|
---|
| 117 |
|
---|
| 118 | <segmentedlist>
|
---|
| 119 | <segtitle>Installed Programs</segtitle>
|
---|
| 120 | <segtitle>Installed Libraries</segtitle>
|
---|
| 121 | <segtitle>Installed Directories</segtitle>
|
---|
| 122 |
|
---|
| 123 | <seglistitem>
|
---|
| 124 | <seg>
|
---|
| 125 | doesitcache
|
---|
| 126 | </seg>
|
---|
| 127 | <seg>None</seg>
|
---|
| 128 | <seg>
|
---|
[a8c1294] | 129 | /usr/lib/python&python3-majorver;/site-packages/CacheControl-&cachecontrol-version;.dist-info and
|
---|
[381cfd18] | 130 | /usr/lib/python&python3-majorver;/site-packages/cachecontrol
|
---|
| 131 | </seg>
|
---|
| 132 | </seglistitem>
|
---|
| 133 | </segmentedlist>
|
---|
| 134 |
|
---|
| 135 | <variablelist>
|
---|
| 136 | <bridgehead renderas="sect5">Short Descriptions</bridgehead>
|
---|
| 137 | <?dbfo list-presentation="list"?>
|
---|
| 138 | <?dbhtml list-presentation="table"?>
|
---|
| 139 |
|
---|
| 140 | <varlistentry id="doesitcache">
|
---|
| 141 | <term><command>doesitcache</command></term>
|
---|
| 142 | <listitem>
|
---|
| 143 | <para>
|
---|
| 144 | is an undocumented command line script.
|
---|
| 145 | <!-- debian patch this out as undocumented and unnecessary -->
|
---|
| 146 | </para>
|
---|
| 147 | <indexterm zone="cachecontrol">
|
---|
| 148 | <primary sortas="b-cachecontrol">doesitcache</primary>
|
---|
| 149 | </indexterm>
|
---|
| 150 | </listitem>
|
---|
| 151 | </varlistentry>
|
---|
| 152 |
|
---|
| 153 | </variablelist>
|
---|
| 154 |
|
---|
| 155 | </sect3>
|
---|
| 156 |
|
---|
| 157 | </sect2>
|
---|