aboutsummaryrefslogtreecommitdiff
path: root/python/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'python/README.rst')
-rw-r--r--python/README.rst35
1 files changed, 17 insertions, 18 deletions
diff --git a/python/README.rst b/python/README.rst
index dfdce0a25..bb8e51aef 100644
--- a/python/README.rst
+++ b/python/README.rst
@@ -1,44 +1,43 @@
nDPI Python bindings
--------------------
-This directory contains the Python3 bindings for nDPI. We provide both ctypes and cffi based bindings.
+This directory contains the Python3 bindings for nDPI. We provide both cffi and ctypes based bindings.
-**ctypes bindings**
+**cffi bindings**
Files:
-* ndpi_typestruct.py
-* ndpi_wrap.c
-* Makefile.in
+* ndpi.py
-Example:
+Example (using `nfstream <https://github.com/aouinizied/nfstream>`_ package):
.. code-block:: bash
- pip3 install scapy
- python3 ndpi_example.py <interface>
- python3 ndpi_example.py <pcap_file>
+ pip3 install nfstream
+ python3 flow_printer.py <interface>
+ python3 flow_printer.py <pcap_file>
Code courtesy:
-* Massimo Puddu
* Zied Aouini
-**cffi bindings**
+**ctypes bindings**
Files:
-* ndpi.py
-
+* ndpi_typestruct.py
+* ndpi_wrap.c
+* Makefile.in
-Example (using NFStream package):
+Example:
.. code-block:: bash
- pip3 install nfstream
- python3 flow_printer.py <interface>
- python3 flow_printer.py <pcap_file>
+ pip3 install scapy
+ python3 ndpi_example.py <interface>
+ python3 ndpi_example.py <pcap_file>
Code courtesy:
-* Zied Aouini \ No newline at end of file
+* Massimo Puddu
+* Zied Aouini