Skip to content

Commit

Permalink
Update to installation docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Legrandin committed Jan 27, 2018
1 parent 6169519 commit 148095d
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 24 deletions.
52 changes: 30 additions & 22 deletions INSTALL.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
Installation
------------

The installation procedure depends on the package you want the library in.
The installation procedure depends on the package you want the library to be in.
PyCryptodome can be used as:

#. **a drop-in replacement for the old PyCrypto library**.
#. **an almost drop-in replacement for the old PyCrypto library**.
You install it with::

pip install pycryptodome
Expand Down Expand Up @@ -36,12 +36,12 @@ The procedures below go a bit more in detail, by explaining
how to setup the environment for compiling the C extensions
for each OS, and how to install the GMP library.

All instructions to follow install PyCryptodome as the ``Cryptodome`` package
(option #2). Change ``pycryptodomex`` to ``pycryptodome`` if you prefer
option #1 (``Crypto`` package).
Compiling in Linux Ubuntu
~~~~~~~~~~~~~~~~~~~~~~~~~

Linux Ubuntu
~~~~~~~~~~~~
.. note::
If you want to install under the ``Crypto`` package, replace
below ``pycryptodomex`` with ``pycryptodome``.

For Python 2.x::

Expand All @@ -61,8 +61,12 @@ For PyPy::
$ pip install pycryptodomex
$ pypy -m Cryptodome.SelfTest

Linux Fedora
~~~~~~~~~~~~
Compiling in Linux Fedora
~~~~~~~~~~~~~~~~~~~~~~~~~

.. note::
If you want to install under the ``Crypto`` package, replace
below ``pycryptodomex`` with ``pycryptodome``.

For Python 2.x::

Expand All @@ -82,20 +86,13 @@ For PyPy::
$ pip install pycryptodomex
$ pypy -m Cryptodome.SelfTest

Windows (pre-compiled)
~~~~~~~~~~~~~~~~~~~~~~

#. Install PyCryptodome as a `wheel <http://pythonwheels.com/>`_::

> pip install pycryptodomex

#. To make sure everything works fine, run the test suite::

> python -m Cryptodome.SelfTest

Windows (from sources, Python 2.x, Python <=3.2)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. note::
If you want to install under the ``Crypto`` package, replace
below ``pycryptodomex`` with ``pycryptodome``.

Windows does not come with a C compiler like most Unix systems.
The simplest way to compile the *Pycryptodome* extensions from
source code is to install the minimum set of Visual Studio
Expand Down Expand Up @@ -141,6 +138,10 @@ components freely made available by Microsoft.
Windows (from sources, Python 3.3 and 3.4)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. note::
If you want to install under the ``Crypto`` package, replace
below ``pycryptodomex`` with ``pycryptodome``.

Windows does not come with a C compiler like most Unix systems.
The simplest way to compile the *Pycryptodome* extensions from
source code is to install the minimum set of Visual Studio
Expand Down Expand Up @@ -186,6 +187,10 @@ components freely made available by Microsoft.
Windows (from sources, Python 3.5 and newer)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. note::
If you want to install under the ``Crypto`` package, replace
below ``pycryptodomex`` with ``pycryptodome``.

Windows does not come with a C compiler like most Unix systems.
The simplest way to compile the *PyCryptodome* extensions from
source code is to install the minimum set of Visual Studio
Expand All @@ -194,11 +199,14 @@ components freely made available by Microsoft.
#. **[Once only]** Download `MS Visual Studio 2015 <https://www.visualstudio.com/en-us/downloads/download-visual-studio-vs.aspx>`_
(Community Edition) and install the C/C++ compilers and the redistributable only.

#. Perform all steps from the section *Windows (pre-compiled)* but add the ``--no-use-wheel``
parameter when calling ``pip``::
#. Compile and install PyCryptodome::

> pip install pycryptodomex --no-use-wheel

#. To make sure everything work fine, run the test suite::

> python -m Cryptodome.SelfTest

Documentation
~~~~~~~~~~~~~

Expand Down
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ cryptographic primitives.

It supports Python 2.4 or newer, all Python 3 versions and PyPy.

The installation procedure depends on the package you want the library in.
The installation procedure depends on the package you want the library to be in.
PyCryptodome can be used as:

#. **a drop-in replacement for the old PyCrypto library**.
#. **an almost drop-in replacement for the old PyCrypto library**.
You install it with::

pip install pycryptodome
Expand Down

0 comments on commit 148095d

Please sign in to comment.