summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorJustus Winter <justus@sequoia-pgp.org>2018-02-15 18:06:50 +0100
committerJustus Winter <justus@sequoia-pgp.org>2019-01-11 13:23:24 +0100
commit177835be9dba392ab10994254b67aa676be66331 (patch)
tree7682b06cd40bbec88dec091c23a18002a9bfabaa /README.md
parented7d023d5a6a2587ba218910bc1849d0d34adca7 (diff)
ffi: Add preliminary Python bindings.
- The bingings support basic manipulation of OpenPGP data, but are quite incomplete. Furthermore, the Python API is not very pythonic in some places, so expect it to break in the future.
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index 38a2d2f5..590d649a 100644
--- a/README.md
+++ b/README.md
@@ -105,6 +105,20 @@ use `make install`. The latter target honors `PREFIX` and `DESTDIR`.
Finally, to return your source tree to its pristine state, run `make
clean`.
+Bindings
+--------
+
+### Python
+
+The FFI crate contains Python bindings. To disable building, testing,
+and installing the Python bindings, use `make PYTHON=disable`.
+
+To build the Python bindings, you will need cffi and pytest for Python3.
+
+Debian:
+
+ $ apt install python3-cffi python3-pytest
+
Getting help
============