aboutsummaryrefslogtreecommitdiff
path: root/python/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'python/README.rst')
-rw-r--r--python/README.rst44
1 files changed, 44 insertions, 0 deletions
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