[88149d4d] | 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 |
|
---|
[301c411] | 7 | <!ENTITY pluggy-download-http "https://files.pythonhosted.org/packages/source/p/pluggy/pluggy-&pluggy-version;.tar.gz">
|
---|
[88149d4d] | 8 | <!ENTITY pluggy-download-ftp " ">
|
---|
[569925c7] | 9 | <!ENTITY pluggy-md5sum "&pluggy-md5sum;">
|
---|
[830c353] | 10 | <!ENTITY pluggy-size "50 KB">
|
---|
[72c62e4] | 11 | <!ENTITY pluggy-buildsize "636 KB (add 26 MB for tests)">
|
---|
| 12 | <!ENTITY pluggy-time "less than 0.1 SBU (with tests)">
|
---|
[88149d4d] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect2 id="pluggy" xreflabel="pluggy-&pluggy-version;">
|
---|
| 16 |
|
---|
| 17 | <title>Pluggy-&pluggy-version;</title>
|
---|
| 18 |
|
---|
| 19 | <indexterm zone="pluggy">
|
---|
| 20 | <primary sortas="a-pluggy">pluggy</primary>
|
---|
| 21 | </indexterm>
|
---|
| 22 |
|
---|
| 23 | <sect3 role="package">
|
---|
| 24 | <title>Introduction to Pluggy Module</title>
|
---|
| 25 |
|
---|
| 26 | <para>
|
---|
[830c353] | 27 | The <application>Pluggy</application> package gives users the ability
|
---|
| 28 | to extend or modify the behaviour of a host program by installing a
|
---|
| 29 | plugin for that program. The plugin code will run as part of normal
|
---|
| 30 | program execution, changing or enhancing certain aspects of it. In
|
---|
| 31 | essence, <application>pluggy</application> enables function hooking
|
---|
| 32 | so a user can build <quote>pluggable</quote> systems.
|
---|
[88149d4d] | 33 | </para>
|
---|
| 34 |
|
---|
[ed345e7] | 35 | &lfs120_checked;
|
---|
[88149d4d] | 36 |
|
---|
| 37 | <bridgehead renderas="sect4">Package Information</bridgehead>
|
---|
| 38 | <itemizedlist spacing="compact">
|
---|
| 39 | <listitem>
|
---|
| 40 | <para>
|
---|
| 41 | Download (HTTP): <ulink url="&pluggy-download-http;"/>
|
---|
| 42 | </para>
|
---|
| 43 | </listitem>
|
---|
| 44 | <listitem>
|
---|
| 45 | <para>
|
---|
| 46 | Download (FTP): <ulink url="&pluggy-download-ftp;"/>
|
---|
| 47 | </para>
|
---|
| 48 | </listitem>
|
---|
| 49 | <listitem>
|
---|
| 50 | <para>
|
---|
| 51 | Download MD5 sum: &pluggy-md5sum;
|
---|
| 52 | </para>
|
---|
| 53 | </listitem>
|
---|
| 54 | <listitem>
|
---|
| 55 | <para>
|
---|
| 56 | Download size: &pluggy-size;
|
---|
| 57 | </para>
|
---|
| 58 | </listitem>
|
---|
| 59 | <listitem>
|
---|
| 60 | <para>
|
---|
| 61 | Estimated disk space required: &pluggy-buildsize;
|
---|
| 62 | </para>
|
---|
| 63 | </listitem>
|
---|
| 64 | <listitem>
|
---|
| 65 | <para>
|
---|
| 66 | Estimated build time: &pluggy-time;
|
---|
| 67 | </para>
|
---|
| 68 | </listitem>
|
---|
| 69 | </itemizedlist>
|
---|
| 70 |
|
---|
[830c353] | 71 | <bridgehead renderas="sect4">Pluggy Dependencies</bridgehead>
|
---|
| 72 |
|
---|
| 73 | <bridgehead renderas="sect5">Recommended</bridgehead>
|
---|
| 74 | <para role="recommended">
|
---|
| 75 | <xref linkend="setuptools_scm"/>
|
---|
| 76 | </para>
|
---|
| 77 |
|
---|
[ef6402e] | 78 | <bridgehead renderas="sect5">Optional (for testing)</bridgehead>
|
---|
| 79 | <para role="optional">
|
---|
| 80 | <xref linkend="pytest"/> and
|
---|
| 81 | <ulink url="https://pypi.org/project/pytest-benchmark/">pytest-benchmark</ulink>
|
---|
| 82 | </para>
|
---|
[830c353] | 83 |
|
---|
[88149d4d] | 84 | </sect3>
|
---|
| 85 |
|
---|
| 86 | <sect3 role="installation">
|
---|
| 87 | <title>Installation of Pluggy</title>
|
---|
| 88 |
|
---|
| 89 | <para>Build the module: </para>
|
---|
| 90 |
|
---|
[082e722] | 91 | &build-wheel;
|
---|
[88149d4d] | 92 |
|
---|
| 93 | <para>
|
---|
[ef6402e] | 94 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
[88149d4d] | 95 | </para>
|
---|
| 96 |
|
---|
[082e722] | 97 | <screen role="root"><userinput>&install-wheel; pluggy</userinput></screen>
|
---|
[ef6402e] | 98 |
|
---|
[88149d4d] | 99 | <para>
|
---|
[ef6402e] | 100 | Assuming <xref linkend="pytest"/> is installed, but the other optional
|
---|
| 101 | dependencies are not, the installation can be tested with the following
|
---|
| 102 | commands:
|
---|
[88149d4d] | 103 | </para>
|
---|
| 104 |
|
---|
[ef6402e] | 105 | <screen remap="test"><userinput>python3 -m venv --system-site-packages testenv &&
|
---|
| 106 | source testenv/bin/activate &&
|
---|
| 107 | pip3 install pytest-benchmark &&
|
---|
| 108 | python3 /usr/bin/pytest<!-- no && in case there is an error -->
|
---|
| 109 | deactivate</userinput></screen>
|
---|
[88149d4d] | 110 |
|
---|
| 111 | </sect3>
|
---|
| 112 |
|
---|
| 113 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 114 | href="../../../xincludes/pip3-cmd-explain.xml"/>
|
---|
| 115 |
|
---|
| 116 | <sect3 role="content">
|
---|
| 117 | <title>Contents</title>
|
---|
| 118 |
|
---|
| 119 | <segmentedlist>
|
---|
| 120 | <segtitle>Installed Programs</segtitle>
|
---|
| 121 | <segtitle>Installed Libraries</segtitle>
|
---|
| 122 | <segtitle>Installed Directories</segtitle>
|
---|
| 123 |
|
---|
| 124 | <seglistitem>
|
---|
| 125 | <seg>None</seg>
|
---|
| 126 | <seg>None</seg>
|
---|
| 127 | <seg>
|
---|
| 128 | /usr/lib/python&python3-majorver;/site-packages/pluggy and
|
---|
| 129 | /usr/lib/python&python3-majorver;/site-packages/pluggy-&pluggy-version;.dist-info
|
---|
| 130 | </seg>
|
---|
| 131 | </seglistitem>
|
---|
| 132 | </segmentedlist>
|
---|
| 133 |
|
---|
| 134 | </sect3>
|
---|
| 135 |
|
---|
| 136 | </sect2>
|
---|