From a95cfcc98906c1807acf6707c838cc49d15ae39b Mon Sep 17 00:00:00 2001
From: aouinizied <aouinizied@gmail.com>
Date: Thu, 28 Nov 2019 03:09:13 +0100
Subject: Implement cffi bindings.

---
 python/README.rst | 44 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 44 insertions(+)
 create mode 100644 python/README.rst

(limited to 'python/README.rst')

diff --git a/python/README.rst b/python/README.rst
new file mode 100644
index 000000000..dfdce0a25
--- /dev/null
+++ b/python/README.rst
@@ -0,0 +1,44 @@
+nDPI Python bindings
+--------------------
+
+This directory contains the Python3 bindings for nDPI. We provide both ctypes and cffi based bindings.
+
+**ctypes bindings**
+
+Files:
+
+* ndpi_typestruct.py
+* ndpi_wrap.c
+* Makefile.in
+
+Example:
+
+.. code-block:: bash
+
+    pip3 install scapy
+    python3 ndpi_example.py <interface>
+    python3 ndpi_example.py <pcap_file>
+
+Code courtesy:
+
+* Massimo Puddu
+* Zied Aouini
+
+**cffi bindings**
+
+Files:
+
+* ndpi.py
+
+
+Example (using NFStream package):
+
+.. code-block:: bash
+
+    pip3 install nfstream
+    python3 flow_printer.py <interface>
+    python3 flow_printer.py <pcap_file>
+
+Code courtesy:
+
+* Zied Aouini
\ No newline at end of file
-- 
cgit v1.2.3