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