Metadata-Version: 1.1
Name: yabgp
Version: 0.1.0
Summary: Yet Another Border Gateway Protocol Python Implementation
Home-page: http://smartbgp.github.io/
Author: SmartBGP project team
Author-email: xiaoquwl@gmail.com
License: Apache License 2.0
Description: YABGP
        =====
        
        |Join Chat| |License| |Build Status| |Code Health| |Documentation Status| |Test Coverage|
        
        What is yabgp?
        ~~~~~~~~~~~~~~
        
        YABGP is a yet another Python implementation for BGP Protocol. It can be used to establish BGP connections with all kinds
        of routers (include real Cisco/HuaWei/Juniper routers and some router
        simulators like GNS3) and receive/parse BGP messages for
        future analysis.
        
        We write it in strict accordance with the specifications of RFCs.
        
        This software can be used on Linux/Unix, Mac OS and Windows systems.
        
        Features
        ~~~~~~~~
        
        -  It can establish BGP session based on IPv4 address (TCP Layer) in
           active mode(as TCP client);
        
        -  Support TCP MD5 authentication(IPv4 and does not support Windows
           now);
        
        -  BGP capabilities support: 4 Bytes ASN, IPv4 address family, Route
           Refresh(Cisco Route Refresh);
        
        -  Decode all BGP messages to human readable strings and write files to
           disk(configurable);
        
        -  Support basic RESTFUL API.
        
        Quick Start
        ~~~~~~~~~~~
        
        We recommend run ``yabgp`` through python virtual-env from source
        code or pip install
        
        Use yabgp from source code:
        
        .. code:: bash
        
            $ virtualenv yabgp-virl
            $ source yabgp-virl/bin/activate
            $ git clone https://github.com/smartbgp/yabgp
            $ cd yabgp
            $ pip install -r requirements.txt
            $ cd bin
            $ python yabgpd -h
        
        Use pip install
        
        .. code:: bash
        
            $ virtualenv yabgp-virl
            $ source yabgp-virl/bin/activate
            $ pip install yabgp
            $ which yabgpd
            /home/yabgp/yabgp-virl/bin/yabgpd
            $ yabgpd -h
        
        For example:
        
        .. code:: bash
        
            $ yabgpd --bgp-local_addr=1.1.1.1 --bgp-local_as=65001 --bgp-remote_addr=1.1.1.2 --bgp-remote_as=65001 --bgp-md5=test --config-file=../etc/yabgp/yabgp.ini
        
        BGP message example:
        
        in ``yabgp.ini``, you can point out if you want to store the parsing
        BGP message to local disk and where you want to put them in.
        
        More information please see the documentation http://yabgp.readthedocs.org
        
        Support
        ~~~~~~~
        
        Send email to xiaoquwl@gmail.com, or use GitHub issue system.
        
        TODO
        ~~~~
        
        -  support more address family (flowspec, IPv6, VPNv4, VPNv6, etc.)
        -  more unittest
        -  others
        
        Contribute
        ~~~~~~~~~~
        
        Please create Github Pull Request https://github.com/smartbgp/yabgp/pulls
        
        More details please read HACKING.rst.
        
        Thanks
        ~~~~~~
        
        For core files like fsm, protocol, we copy some of the code from
        https://github.com/wikimedia/PyBal/blob/master/pybal/bgp.py,
        
        and message parsing, we reference from
        https://github.com/Exa-Networks/exabgp
        
        .. |License| image:: https://img.shields.io/hexpm/l/plug.svg
           :target: https://github.com/smartbgp/yabgp/blob/master/LICENSE
        .. |Build Status| image:: https://travis-ci.org/smartbgp/yabgp.svg?branch=master
           :target: https://travis-ci.org/smartbgp/yabgp
        
        .. |Join Chat| image:: https://badges.gitter.im/Join%20Chat.svg
           :target: https://gitter.im/smartbgp/yabgp?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
        
        .. |Code Health| image:: https://landscape.io/github/smartbgp/yabgp/master/landscape.svg?style=flat
           :target: https://landscape.io/github/smartbgp/yabgp/master
        
        .. |Documentation Status| image:: https://readthedocs.org/projects/yabgp/badge/?version=latest
           :target: https://readthedocs.org/projects/yabgp/?badge=latest
        
        .. |Test Coverage| image:: https://coveralls.io/repos/smartbgp/yabgp/badge.svg?branch=master 
           :target: https://coveralls.io/r/smartbgp/yabgp
        
        
Keywords: BGP
SDN
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Topic :: System :: Networking
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Operating System :: Unix
