source: general/prog/python-dependencies/urllib3.xml

trunk
Last change on this file was 99c90fa, checked in by Douglas R. Reno <renodr@…>, 4 months ago

Lots of tags

  • Property mode set to 100644
File size: 5.0 KB
RevLine 
[ab4fdfc]1<?xml version="1.0" encoding="UTF-8"?>
[036821b]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
[301c411]7 <!ENTITY urllib3-download-http "https://files.pythonhosted.org/packages/source/u/urllib3/urllib3-&urllib3-version;.tar.gz">
[036821b]8 <!ENTITY urllib3-download-ftp " ">
[569925c7]9 <!ENTITY urllib3-md5sum "&urllib3-md5sum;">
[bc0b251]10 <!ENTITY urllib3-size "272 KB">
[b112f043]11 <!ENTITY urllib3-buildsize "3.2 MB (add 49 MB for tests)">
[bc0b251]12 <!ENTITY urllib3-time "less than 0.1 SBU (1.6 SBU for tests)">
[036821b]13]>
14
15 <sect2 id="urllib3" xreflabel="urllib3-&urllib3-version;">
16
[b3e18015]17 <title>Urllib3-&urllib3-version;</title>
[036821b]18
19 <indexterm zone="urllib3">
20 <primary sortas="a-urllib3">urllib3</primary>
21 </indexterm>
22
23 <sect3 role="package">
[b3e18015]24 <title>Introduction to Urllib3 Module</title>
[036821b]25
26 <para>
[b3e18015]27 The <application>Urllib3</application> module is a powerful,
28 user-friendly HTTP client for Python. It brings many critical
29 features that are missing from the Python standard libraries.
[036821b]30 </para>
31
[99c90fa]32 &lfs121_checked;
[036821b]33
34 <bridgehead renderas="sect4">Package Information</bridgehead>
35 <itemizedlist spacing="compact">
36 <listitem>
37 <para>
38 Download (HTTP): <ulink url="&urllib3-download-http;"/>
39 </para>
40 </listitem>
41 <listitem>
42 <para>
43 Download (FTP): <ulink url="&urllib3-download-ftp;"/>
44 </para>
45 </listitem>
46 <listitem>
47 <para>
48 Download MD5 sum: &urllib3-md5sum;
49 </para>
50 </listitem>
51 <listitem>
52 <para>
53 Download size: &urllib3-size;
54 </para>
55 </listitem>
56 <listitem>
57 <para>
58 Estimated disk space required: &urllib3-buildsize;
59 </para>
60 </listitem>
61 <listitem>
62 <para>
63 Estimated build time: &urllib3-time;
64 </para>
65 </listitem>
66 </itemizedlist>
67
[74434cc]68 <bridgehead renderas="sect4">Urllib3 Dependencies</bridgehead>
69
[35087ed]70 <bridgehead renderas="sect5">Required</bridgehead>
71 <para role="required">
72 <xref linkend="hatchling"/>
73 </para>
74
[74434cc]75 <bridgehead renderas="sect5">Optional (for tests)</bridgehead>
76 <para role="optional">
77 <xref linkend="pytest"/>,
78 <ulink url="https://pypi.org/project/mock/">mock</ulink>,
79 <ulink url="https://pypi.org/project/PySocks/">PySocks</ulink>,
[bc0b251]80 <!-- <ulink url="https://pypi.org/project/pytest-freezegun/">pytest-freezegun</ulink>,-->
[74434cc]81 <ulink url="https://pypi.org/project/pytest-timeout/">pytest-timeout</ulink>,
82 <ulink url="https://pypi.org/project/python-dateutil/">python-dateutil</ulink>,
83 <ulink url="https://pypi.org/project/tornado/">tornado</ulink>, and
84 <ulink url="https://pypi.org/project/trustme/">trustme</ulink>
85 </para>
86
[036821b]87 </sect3>
88
89 <sect3 role="installation">
[acd69075]90 <title>Installation of Urllib3</title>
[036821b]91
[bc0b251]92 <para> If you want to run the tests, remove some that may hang: </para>
93
94<screen><userinput>rm -v test/test_retry.py \
95 test/contrib/test_pyopenssl.py \
96 test/contrib/test_securetransport.py \
97 test/with_dummyserver/test_socketlevel.py</userinput></screen>
98
[036821b]99 <para> Build the module: </para>
100
[082e722]101&build-wheel;
[036821b]102
103 <para>
[74434cc]104 Now, as the <systemitem class="username">root</systemitem> user:
[036821b]105 </para>
106
[082e722]107<screen role="root"><userinput>&install-wheel; urllib3</userinput></screen>
[74434cc]108
[bc0b251]109 <note>
110 <para>
111 Running the tests may result in the procedure below hanging and are
[e440af5]112 not recommended.
[bc0b251]113 </para>
114 </note>
115
[036821b]116 <para>
[74434cc]117 Assuming <xref linkend="pytest"/> is installed, but the other optional
118 dependencies are not, the installation can be tested with the following
119 commands:
[036821b]120 </para>
121
[74434cc]122<screen remap="test"><userinput>python3 -m venv --system-site-packages testenv &amp;&amp;
123source testenv/bin/activate &amp;&amp;
124pip3 install trustme \
125 tornado \
126 python-dateutil \
127 mock \
128 pysocks \
[bc0b251]129 pytest-timeout &amp;&amp;
[74434cc]130python3 /usr/bin/pytest<!-- no && because of a possible error -->
131deactivate</userinput></screen>
132
133 <para>
134 A few errors are known to occur.
135 </para>
[036821b]136
137 </sect3>
138
139 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
140 href="../../../xincludes/pip3-cmd-explain.xml"/>
141
142 <sect3 role="content">
143 <title>Contents</title>
144
145 <segmentedlist>
146 <segtitle>Installed Programs</segtitle>
147 <segtitle>Installed Libraries</segtitle>
148 <segtitle>Installed Directories</segtitle>
149
150 <seglistitem>
151 <seg>None</seg>
152 <seg>None</seg>
153 <seg>
154 /usr/lib/python&python3-majorver;/site-packages/urllib3 and
155 /usr/lib/python&python3-majorver;/site-packages/urllib3-&urllib3-version;.dist-info
156 </seg>
157 </seglistitem>
158 </segmentedlist>
159
160 </sect3>
161
162 </sect2>
Note: See TracBrowser for help on using the repository browser.