source: archive/pycryptodome.xml@ 3ff7901

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 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;

  <!ENTITY pycryptodome-download-http "https://github.com/Legrandin/pycryptodome/archive/v&pycryptodome-version;/pycryptodome-&pycryptodome-version;.tar.gz">
  <!ENTITY pycryptodome-download-ftp  " ">
  <!ENTITY pycryptodome-md5sum        "37301ba099375e05db0dfb4d1800d6fe">
  <!ENTITY pycryptodome-size          "16 MB">
  <!ENTITY pycryptodome-buildsize     "54 MB">
  <!ENTITY pycryptodome-time          "0.1 SBU">
]>

  <!-- Begin pycryptodome -->
  <sect2 id="pycryptodome" xreflabel="PyCryptodome-&pycryptodome-version;">

    <title>PyCryptodome-&pycryptodome-version;</title>

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

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

      <para>
        <application>PyCryptodome</application> is a collection of both secure
        hash functions (such as SHA256 and RIPEMD160), and various encryption
        algorithms (AES, DES, RSA, ElGamal, etc.), and is a drop-in replacement
        for PyCrypto.
      </para>

      &lfs120_checked;

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

    </sect3>

    <sect3 role="installation">
      <title>Installation of PyCryptodome</title>

      <para>
        To build <application>PyCryptodome</application> as a Python 3
        module, run the following command:
      </para>

&build-wheel;

      <para>
        To install the module, run the following command as the &root; user:
      </para>

<screen role="root"><userinput>&install-wheel; pycryptodome</userinput></screen>

    </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>
            None
          </seg>
          <seg>
            None
          </seg>
          <seg>
            /usr/lib/python&python3-majorver;/site-packages/Crypto
            /usr/lib/python&python3-majorver;/site-packages/pycryptodome-&pycryptodome-version;.dist-info
          </seg>
        </seglistitem>
      </segmentedlist>

    </sect3>

  </sect2>