mirror of
https://github.com/nfstream/nfstream.git
synced 2026-05-20 01:01:34 +00:00
45 lines
1.9 KiB
ReStructuredText
45 lines
1.9 KiB
ReStructuredText
.. nfstream documentation master file, created by
|
|
sphinx-quickstart on Sat Oct 19 16:26:59 2019.
|
|
You can adapt this file completely to your liking, but it should at least
|
|
contain the root `toctree` directive.
|
|
|
|
======================
|
|
nfstream documentation
|
|
======================
|
|
|
|
|release| |build| |coverage| |quality| |python| |license|
|
|
|
|
**nfstream** is a flexible and lightweight network data analysis library.
|
|
|
|
**nfstream main features**
|
|
|
|
* **Performance:** nfstream was designed to be fast, CPU savvy and small memory fingerprint.
|
|
* **Layer-7 visibility:** nfstream dissection is based on nDPI_ (~300 applications including Tor, Messenger, WhatsApp, etc.).
|
|
* **Flexibility:** add a flow metric in 2 lines of code using nfstream plugins method.
|
|
* **Machine Learning oriented:** add your trained model as an NFStream Classifier.
|
|
|
|
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
:caption: Contents:
|
|
|
|
installation
|
|
tutorials
|
|
contributing
|
|
changelog
|
|
|
|
|
|
.. |release| image:: https://img.shields.io/pypi/v/nfstream.svg
|
|
:target: https://pypi.python.org/pypi/nfstream
|
|
.. |build| image:: https://travis-ci.org/aouinizied/nfstream.svg?branch=master
|
|
:target: https://travis-ci.org/aouinizied/nfstream
|
|
.. |coverage| image:: https://codecov.io/gh/aouinizied/nfstream/branch/master/graph/badge.svg
|
|
:target: https://codecov.io/gh/aouinizied/nfstream/
|
|
.. |quality| image:: https://img.shields.io/lgtm/grade/python/github/aouinizied/nfstream.svg?logo=lgtm&logoWidth=18)
|
|
:target: https://lgtm.com/projects/g/aouinizied/nfstream/context:python
|
|
.. |python| image:: https://img.shields.io/badge/python-3.x-blue.svg
|
|
:target: https://travis-ci.org/aouinizied/nfstream
|
|
.. |license| image:: https://img.shields.io/badge/license-LGPLv3-blue.svg
|
|
:target: LICENSE
|
|
|
|
.. _nDPI: https://www.ntop.org/products/deep-packet-inspection/ndpi/
|