Skip to content

Latest commit

 

History

History
92 lines (64 loc) · 2.57 KB

README.md

File metadata and controls

92 lines (64 loc) · 2.57 KB
Raw

OpenBMP API Message Python Library

This library implements the OpenBMP message bus specification as defined at MESSAGE_BUS_API.md.

Messages from kafka (headers and content) are parsed and made available in Map and String/JSON.

API supports Python 2.7

Current Schema supported is 1.3

Install Dependencies:

sudo apt-get install python-dev python-pip libsnappy-dev
sudo pip install python-snappy
sudo pip install kafka-python
sudo pip install pyyaml

Python2 and Python3

git clone https://github.com/OpenBMP/openbmp-python-api-message.git
cd openbmp-python-api-message
sudo pip install .

### You can also use the below instead of pip install:
#sudo python setup.py install

Package for install or distribution (works for both python2 and python3)

git clone https://github.com/OpenBMP/openbmp-python-api-message.git
cd openbmp-python-api-message
python setup.py bdist_wheel
cd dist
pip install openbmp_python_api_message-1.0-py2-none-any.whl

NOTE: The above defaults for python2. Change python to python3 and pip to pip3.

Usage

Use this library in any existing python project.

Code

from openbmp.api.parsed.message import Message
from openbmp.api.parsed.message import Peer

raw_kafka_message_data = '...';

msg = Message(raw_kafka_message_data)

#Parse the content data by its type
peer = Peer(msg);

#Do something with peer.getRowMap() or peer.toJson() or peer.toJsonPretty()

Message

Normally the first thing to do is parse the raw Kafka received message by using the Message class. This class will parse the headers and content data.

Message Specific Classes

Each message type, such as Router, Peer, UnicastPrefix, LsPrefix, LsNode, LsLink, Collector, BmpStat, BaseAttribute are parsed based on MESSAGE_BUS_API.md. This is why there is a separate class for each type. All classes return the same data for use by your application.

    def getRowMap(self):
        """
        Get rowMap as array of dictionaries.
    
        :return: parsed rowMap is returned as an array of dictionaries.
        """
    
    def toJson(self):
        """
        Get rowMap as Json
        
        :return: JSON String representing the parsed rowMap
        """

    def toJsonPretty(self):
        """
        Get rowMap as Pretty Json.
    
        :return: Pretty formatted JSON String representing the parsed rowMap.
        """