aboutsummaryrefslogtreecommitdiffstats
path: root/doc/manual/python.rst
diff options
context:
space:
mode:
authorlloyd <[email protected]>2015-02-16 20:12:38 +0000
committerlloyd <[email protected]>2015-02-16 20:12:38 +0000
commit3b9a0c1535e40f8f9fc4cfbc734144ee229df65d (patch)
tree30c1d4363b4c85561204d26344f40de3e78f6d9d /doc/manual/python.rst
parent85caef829c9eeb7c224ad3b2e3ffbcfe981c2428 (diff)
Add new module `ffi` which provides a plain C interface, plus a new
ctypes Python wrapper that uses it. The API is intentionally designed to have a very simple ABI (extern "C", all structs are opaque, no memory ownership passing the FFI boundary, limited set of simple types as args) so the ctypes wrapper is quite simple. Currently ffi provides ciphers, hashes, MACs, RNGs, PBKDF, KDF, bcrypt, and most public key operations. Remove the old boost.python wrapper and all the build code for it.
Diffstat (limited to 'doc/manual/python.rst')
-rw-r--r--doc/manual/python.rst19
1 files changed, 4 insertions, 15 deletions
diff --git a/doc/manual/python.rst b/doc/manual/python.rst
index b8fd59b9a..f851cbaca 100644
--- a/doc/manual/python.rst
+++ b/doc/manual/python.rst
@@ -2,20 +2,9 @@
Python Binding
========================================
-.. highlight:: python
-
-.. note::
-
- The Python binding should be considered alpha software, and the
- interfaces may change in the future.
-
-Botan includes a binding for Python, implemented using Boost.Python.
+.. versionadded:: 1.11.14
-As you can see, it is not currently documented, though there are a few
-examples under `src/scripts/examples`, such as RSA:
-
-.. literalinclude:: ../../src/scripts/examples/rsa.py
-
-and EAX encryption using a passphrase:
+.. highlight:: python
-.. literalinclude:: ../../src/scripts/examples/cipher.py
+The Python binding is based on the `ffi` module of botan and the
+`ctypes` module of the Python standard library.