Metadata-Version: 1.1
Name: mrtparse
Version: 1.5
Summary: MRT format data parser
Home-page: https://github.com/YoshiyukiYamauchi/mrtparse
Author: Tetsumune KISO, Yoshiyuki YAMAUCHI, Nobuhiro ITOU
Author-email: t2mune@gmail.com, info@greenhippo.co.jp, js333123@gmail.com
License: Apache License 2.0
Description: mrtparse
        ========
        
        | mrtparse is a module to read and analyze the MRT format data.
        | The MRT format can be used to export routing protocol messages, state changes, and routing information base contents, and is defined in RFC6396_.
        | Programs like Quagga_ / Zebra_, BIRD_, OpenBGPD_ and PyRT_ can dump the MRT format data.
        | You can also download archives from `the Route Views Projects`_, `RIPE NCC`_.
        
        .. _RFC6396: https://tools.ietf.org/html/rfc6396
        .. _Quagga: http://www.nongnu.org/quagga/
        .. _Zebra: https://www.gnu.org/software/zebra/
        .. _BIRD: http://bird.network.cz/
        .. _OpenBGPD: http://www.openbgpd.org/
        .. _PyRT: https://github.com/mor1/pyrt
        .. _`the Route Views Projects`: http://archive.routeviews.org/
        .. _`RIPE NCC`: https://www.ripe.net/analyse/internet-measurements/routing-information-service-ris/ris-raw-data
        
        Supported MRT types
        -------------------
        
        +-------------------+---------+
        | Name              | Value   |
        +===================+=========+
        | Table\_Dump       | 12      |
        +-------------------+---------+
        | Table\_Dump\_V2   | 13      |
        +-------------------+---------+
        | BGP4MP            | 16      |
        +-------------------+---------+
        | BGP4MP\_ET        | 17      |
        +-------------------+---------+
        
        Supported BGP capabilities
        --------------------------
        
        +--------------------------------------------+---------+
        | Name                                       | Value   |
        +============================================+=========+
        | Multiprotocol Extensions for BGP-4         | 1       |
        +--------------------------------------------+---------+
        | Route Refresh Capability for BGP-4         | 2       |
        +--------------------------------------------+---------+
        | Outbound Route Filtering Capability        | 3       |
        +--------------------------------------------+---------+
        | Graceful Restart Capability                | 64      |
        +--------------------------------------------+---------+
        | Support for 4-octet AS number capability   | 65      |
        +--------------------------------------------+---------+
        | ADD-PATH Capability                        | 69      |
        +--------------------------------------------+---------+
        
        Supported BGP attributes
        ------------------------
        
        +-------------------------+---------+
        | Name                    | Value   |
        +=========================+=========+
        | ORIGIN                  | 1       |
        +-------------------------+---------+
        | AS\_PATH                | 2       |
        +-------------------------+---------+
        | NEXT\_HOP               | 3       |
        +-------------------------+---------+
        | MULTI\_EXIT\_DISC       | 4       |
        +-------------------------+---------+
        | LOCAL\_PREF             | 5       |
        +-------------------------+---------+
        | ATOMIC\_AGGREGATE       | 6       |
        +-------------------------+---------+
        | AGGREGATOR              | 7       |
        +-------------------------+---------+
        | COMMUNITY               | 8       |
        +-------------------------+---------+
        | ORIGINATOR\_ID          | 9       |
        +-------------------------+---------+
        | CLUSTER\_LIST           | 10      |
        +-------------------------+---------+
        | MP\_REACH\_NLRI         | 14      |
        +-------------------------+---------+
        | MP\_UNREACH\_NLRI       | 15      |
        +-------------------------+---------+
        | EXTENDED\_COMMUNITIES   | 16      |
        +-------------------------+---------+
        | AS4\_PATH               | 17      |
        +-------------------------+---------+
        | AS4\_AGGREGATOR         | 18      |
        +-------------------------+---------+
        | AIGP                    | 26      |
        +-------------------------+---------+
        | LARGE\_COMMUNITY        | 32      |
        +-------------------------+---------+
        | ATTR\_SET               | 128     |
        +-------------------------+---------+
        
        Requirements
        ------------
        
        Python2 or Python3 or PyPy or PyPy3
        
        Installation
        ------------
        
        ::
        
            $ pip install mrtparse
        
        or
        
        ::
        
            $ git clone https://github.com/YoshiyukiYamauchi/mrtparse.git
            $ cd mrtparse
            $ python setup.py install
            running install
            running build
            running build_py
            running install_lib
            copying build/lib/mrtparse.py -> /Library/Python/2.7/site-packages
            byte-compiling /Library/Python/2.7/site-packages/mrtparse.py to mrtparse.pyc
            running install_egg_info
            Writing /Library/Python/2.7/site-packages/mrtparse-0.8-py2.7.egg-info
        
        Usage
        -----
        
        ::
        
            from mrtparse import *
        
        or
        
        ::
        
            import mrtparse
        
        Programming
        -----------
        
        First, import the module.
        
        ::
        
            from mrtparse import *
        
        | And pass a MRT format data as a filepath string or file object to a class Reader().
        | It is also supported gzip and bzip2 format.
        | You can retrieve each entry from the returned object using a loop and then process it.
        
        ::
        
            d = Reader(f)
            for m in d:
                <statements>
        
        We have prepared some example scripts and sample data in `"examples"`_ and `"samples"`_ directory.
        
        .. _`"examples"`: https://github.com/YoshiyukiYamauchi/mrtparse/tree/master/examples
        .. _`"samples"`: https://github.com/YoshiyukiYamauchi/mrtparse/tree/master/samples
        
        Authors
        -------
        
        | Tetsumune KISO t2mune@gmail.com
        | Yoshiyuki YAMAUCHI info@greenhippo.co.jp
        | Nobuhiro ITOU js333123@gmail.com
        
        License
        -------
        
        | Licensed under the `Apache License, Version 2.0`_
        | Copyright © 2016 `greenHippo, LLC.`_
        
        .. _`Apache License, Version 2.0`: http://www.apache.org/licenses/LICENSE-2.0
        .. _`GreenHippo, LLC.`: http://greenhippo.co.jp
        
Keywords: mrt bgp
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Intended Audience :: Telecommunications Industry
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Internet
Classifier: Topic :: System :: Networking
