summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorAlex Gaynor <alex.gaynor@gmail.com>2022-05-01 10:59:05 -0600
committerGitHub <noreply@github.com>2022-05-01 10:59:05 -0600
commit2d20a7e24bd85bd8a22262062b307a58f6d585c5 (patch)
tree62e7f3ec8e4d4e8c8d58531e7938e1891d0f1982 /README.rst
parent1e0e8a91cd5c441865f6c474a5b85ba07c566b91 (diff)
downloadpy-bcrypt-git-2d20a7e24bd85bd8a22262062b307a58f6d585c5.tar.gz
Switch to a Rust implementation of cryptographic primitives (#294)
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst16
1 files changed, 12 insertions, 4 deletions
diff --git a/README.rst b/README.rst
index 84f3759..ecd247d 100644
--- a/README.rst
+++ b/README.rst
@@ -20,25 +20,26 @@ To install bcrypt, simply:
$ pip install bcrypt
-Note that bcrypt should build very easily on Linux provided you have a C compiler, headers for Python (if you're not using pypy), and headers for the libffi libraries available on your system.
+Note that bcrypt should build very easily on Linux provided you have a C
+compiler and a Rust compiler (the minimum supported Rust version is 1.56.0).
For Debian and Ubuntu, the following command will ensure that the required dependencies are installed:
.. code:: bash
- $ sudo apt-get install build-essential libffi-dev python-dev
+ $ sudo apt-get install build-essential cargo
For Fedora and RHEL-derivatives, the following command will ensure that the required dependencies are installed:
.. code:: bash
- $ sudo yum install gcc libffi-devel python-devel
+ $ sudo yum install gcc cargo
For Alpine, the following command will ensure that the required dependencies are installed:
.. code:: bash
- $ apk add --update musl-dev gcc libffi-dev
+ $ apk add --update musl-dev gcc cargo
Alternatives
@@ -49,6 +50,13 @@ While bcrypt remains a good choice for password storage depending on your specif
Changelog
=========
+UNRELEASED
+----------
+
+* ``bcrypt`` is now implemented in Rust. Users building from source will need
+ to have a Rust compiler available. Nothing will change for users downloading
+ wheels.
+
3.2.1
-----