Metadata-Version: 1.1
Name: netdiff
Version: 0.3
Summary: Calculates a diff of a network topology
Home-page: https://github.com/ninuxorg/netdiff
Author: Federico Capoano (nemesisdesign)
Author-email: ninux-dev@ml.ninux.org
License: MIT
Description: netdiff
        =======
        
        .. image:: https://travis-ci.org/ninuxorg/netdiff.png
           :target: https://travis-ci.org/ninuxorg/netdiff
        
        .. image:: https://coveralls.io/repos/ninuxorg/netdiff/badge.png
          :target: https://coveralls.io/r/ninuxorg/netdiff
        
        .. image:: https://landscape.io/github/ninuxorg/netdiff/master/landscape.png
           :target: https://landscape.io/github/ninuxorg/netdiff/master
           :alt: Code Health
        
        .. image:: https://requires.io/github/ninuxorg/netdiff/requirements.png?branch=master
           :target: https://requires.io/github/ninuxorg/netdiff/requirements/?branch=master
           :alt: Requirements Status
        
        .. image:: https://badge.fury.io/py/netdiff.png
           :target: http://badge.fury.io/py/netdiff
        
        .. image:: https://img.shields.io/pypi/dm/netdiff.svg
           :target: https://pypi.python.org/pypi/netdiff
        
        ------------
        
        Netdiff is an experimental Python library that provides utilities for parsing network topologies
        of open source dynamic routing protocols and calculating changes in these topologies.
        
        It was developed to abstract the differences between the different JSON structures of the
        open source dynamic routing protocols (like **OLSR** and **batman-advanced**).
        
        Install stable version from pypi
        --------------------------------
        
        Install from pypi:
        
        .. code-block:: shell
        
            pip install netdiff
        
        Install development version
        ---------------------------
        
        Install tarball:
        
        .. code-block:: shell
        
            pip install https://github.com/ninuxorg/netdiff/tarball/master
        
        Alternatively you can install via pip using git:
        
        .. code-block:: shell
        
            pip install -e git+git://github.com/ninuxorg/netdiff#egg=netdiff
        
        If you want to contribute, install your cloned fork:
        
        .. code-block:: shell
        
            git clone git@github.com:<your_fork>/netdiff.git
            cd netdiff
            python setup.py develop
        
        Basic Usage Example
        -------------------
        
        Calculate diff of an OLSR 0.6.x topology:
        
        .. code-block:: python
        
            from netdiff import OlsrParser
            from netdiff import diff
        
            stored = OlsrParser('./stored-olsr.json')
            latest = OlsrParser('telnet://127.0.0.1:9090')
            diff(stored, latest)
        
        The output will be a dictionary with the following structure:
        
        .. code-block:: python
        
            {
                "added": []
                "removed": []
            }
        
        Parsers
        -------
        
        Parsers are classes that extend ``netdiff.base.BaseParser`` and implement a ``parse`` method
        which is in charge of converting a python data structure into ``networkx.Graph`` object.
        
        Parsers also have a ``json`` method which returns valid `NetJSON output <https://github.com/ninuxorg/netdiff#netjson-output>`__.
        
        The available parsers are:
        
        * ``netdiff.OlsrParser``: parser for the `olsrd jsoninfo plugin <http://www.olsr.org/?q=jsoninfo_plugin>`__
        * ``netdiff.BatmanParser``: parser for the `batman-advanced alfred tool <http://www.open-mesh.org/projects/open-mesh/wiki/Alfred>`__
        * ``netdiff.Bmx6Parser``: parser for the BMX6 `b6m tool <http://dev.qmp.cat/projects/b6m>`__
        * ``netdiff.CnmlParser``: parser for `CNML 0.1 <http://cnml.info/>`__
        * ``netdiff.NetJsonParser``: parser for the ``NetworkGraph`` `NetJSON object <https://github.com/interop-dev/json-for-networks#network-graph>`__.
        
        Parsers must be initialized with a string which can represent one of the following:
        
        * path to JSON file
        * HTTP url to JSON file
        * telnet url to JSON file
        * JSON formatted string
        * python dictionary representing a JSON structure
        
        Local file example:
        
        .. code-block:: python
        
            from netdiff import BatmanParser
            BatmanParser('./my-stored-topology.json')
        
        HTTP example:
        
        .. code-block:: python
        
            from netdiff import NetJsonParser
            url = 'https://raw.githubusercontent.com/interop-dev/json-for-networks/master/examples/network-graph.json'
            NetJsonParser(url)
        
        NetJSON output
        --------------
        
        Netdiff parsers can return a valid `NetJSON <https://github.com/interop-dev/json-for-networks>`__
        ``NetworkGraph`` object:
        
        .. code-block:: python
        
            from netdiff import OlsrParser
        
            olsr = OlsrParser('telnet://127.0.0.1:9090')
        
            # will return a dict
            olsr.json(dict=True)
        
            # will return a JSON formatted string
            print(olsr.json(indent=4))
        
        Output:
        
        .. code-block:: javascript
        
            {
                "type": "NetworkGraph",
                "protocol": "OLSR",
                "version": "0.6.6",
                "revision": "5031a799fcbe17f61d57e387bc3806de",
                "metric": "ETX",
                "nodes": [
                    {
                        "id": "10.150.0.3"
                    },
                    {
                        "id": "10.150.0.2"
                    },
                    {
                        "id": "10.150.0.4"
                    }
                ],
                "links": [
                    {
                        "source": "10.150.0.3",
                        "target": "10.150.0.2",
                        "weight": 28334
                    },
                    {
                        "source": "10.150.0.3",
                        "target": "10.150.0.4",
                        "weight": 1024
                    }
                ]
            }
        
        Running tests
        -------------
        
        Install your forked repo:
        
        .. code-block:: shell
        
            git clone git://github.com/<your_fork>/netdiff
            cd diff/
            python setup.py develop
        
        Install test requirements:
        
        .. code-block:: shell
        
            pip install -r requirements-test.txt
        
        Run tests with:
        
        .. code-block:: shell
        
            ./runtests.py
        
        Alternatively, you can use the ``nose`` command (which has a ton of available options):
        
        .. code-block:: shell
        
            nosetests
            nosetests tests.olsr
            nosetests tests.olsr:TestOlsrParser
            nosetests tests.olsr:TestOlsrParser.test_parse
        
        See test coverage with:
        
        .. code-block:: shell
        
            coverage run --source=netdiff runtests.py && coverage report
        
        Contribute
        ----------
        
        1. Join the `ninux-dev mailing list`_
        2. Fork this repo and install it
        3. Follow `PEP8, Style Guide for Python Code`_
        4. Write code
        5. Write tests for your code
        6. Ensure all tests pass
        7. Ensure test coverage is not under 90%
        8. Document your changes
        9. Send pull request
        
        .. _PEP8, Style Guide for Python Code: http://www.python.org/dev/peps/pep-0008/
        .. _ninux-dev mailing list: http://ml.ninux.org/mailman/listinfo/ninux-dev
        
Platform: UNKNOWN
Classifier: Development Status :: 1 - Planning
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: System :: Networking
