vrr/nfstream
2
0
Fork 0
mirror of https://github.com/nfstream/nfstream.git synced 2026-05-19 07:54:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
mirror of https://github.com/nfstream/nfstream https://www.nfstream.org
71 commits 4 branches 78 tags 118 MiB
Find a file
aouinizied 0be315f0b2 Bump version: 0.2.0 → 0.3.0
2019-10-20 05:29:16 +02:00
docs Bump version: 0.2.0 → 0.3.0 2019-10-20 05:29:16 +02:00
nfstream Bump version: 0.2.0 → 0.3.0 2019-10-20 05:29:16 +02:00
tests Add expiration management tests. 2019-10-19 04:32:09 +02:00
.gitignore Add ndpi_wrap binaries. 2019-10-19 21:59:44 +02:00
.travis.yml Fix deployment issue. 2019-10-19 20:45:47 +02:00
CONTRIBUTING.rst Add contributing guideline. 2019-10-18 22:24:30 +02:00
HISTORY.rst Update HISTORY. 2019-10-19 20:49:32 +02:00
LICENSE Initial commit 2019-10-18 17:14:41 +02:00
MANIFEST.in Add MANIFEST.in 2019-10-18 21:27:46 +02:00
README.rst Polish. 2019-10-19 23:01:55 +02:00
requirements.txt Fix doc generation. 2019-10-19 16:53:45 +02:00
setup.cfg Bump version: 0.2.0 → 0.3.0 2019-10-20 05:29:16 +02:00
setup.py Bump version: 0.2.0 → 0.3.0 2019-10-20 05:29:16 +02:00
tests.py Implement user defined callbacks. 2019-10-20 05:18:25 +02:00

README.rst 

========================
|nfstream_logo| nfstream
========================

|release| |build| |coverage| |quality| |doc| |python| |license|

nfstream is a flexible and lightweight network data analysis library.

Getting Started
===============

Prerequisites
-------------

.. code-block:: bash

    apt-get install python-dev libpcap-dev autogen

Installation
------------

using pip
^^^^^^^^^

Binary installers for the latest released version are available:

.. code-block:: bash

    pip3 install nfstream


from source
^^^^^^^^^^^

If you want to build nfstream on your local machine:

.. code-block:: bash

    apt-get autogen
    git clone https://github.com/aouinizied/nfstream.git
    # move to nfstream directory and run
    python3 setup.py install


Contributing
============

Please read Contributing_ for details on our code of conduct, and the process for submitting pull
requests to us.


Authors
=======

`Zied Aouini`_  (`aouinizied`_) created nfstream and `these fine people`_
have contributed.


License
=======

This project is licensed under the GPLv3 License - see the License_ file for details

.. |release| image:: https://img.shields.io/pypi/v/nfstream.svg
              :target: https://pypi.python.org/pypi/nfstream
.. |nfstream_logo| image:: https://github.com/aouinizied/nfstream/blob/master/docs/nfstream_logo.png
.. |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
.. |doc| image:: https://readthedocs.org/projects/nfstream/badge/?version=latest
               :target: https://nfstream.readthedocs.io/en/latest/?badge=latest
.. |license| image:: https://img.shields.io/badge/license-LGPLv3-blue.svg
               :target: LICENSE

.. _License: https://github.com/aouinizied/nfstream/blob/master/LICENSE
.. _Contributing: https://github.com/aouinizied/nfstream/blob/master/CONTRIBUTING.rst
.. _these fine people: https://github.com/aouinizied/nfstream/graphs/contributors
.. _Zied Aouini: https://www.linkedin.com/in/dr-zied-aouini
.. _aouinizied: https://github.com/aouinizied