Metadata-Version: 2.0
Name: sbp
Version: 2.6.3
Summary: Python bindings for Swift Binary Protocol
Home-page: https://github.com/swift-nav/libsbp
Author: Swift Navigation
Author-email: dev@swiftnav.com
License: UNKNOWN
Platform: linux
Platform: osx
Platform: win32
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python
Classifier: Topic :: Scientific/Engineering :: Interface Engine/Protocol Translator
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.7
Requires-Dist: construct (==2.9.33)
Requires-Dist: llvmlite (==0.26.0)
Requires-Dist: numba (==0.41.0)
Requires-Dist: numpy (==1.16.2)
Requires-Dist: pybase64
Requires-Dist: pyftdi (==0.13.4)
Requires-Dist: pylibftdi
Requires-Dist: pyserial
Requires-Dist: requests (>=2.8.1)
Requires-Dist: ujson

SBP Bindings for Python
=======================

Python client for Swift Binary Protocol (SBP).

Setup
-----

You must have `python` and `pip` installed.

Install dependencies only::

  $ sudo pip install -r requirements.txt

Install from repo::

  $ sudo python setup.py install

Install package from pypi::

  $ sudo pip install sbp

Setup using a virtual environment
---------------------------------

Setup and activate the `virtualenv`::

   $ virtualenv .env && source .env/bin/activate

Install `py.test` in the virtualenv::

   $ pip install pytest-virtualenv

Install the `pt.test` coverage tools::

   $ pip install pytest-cov

Finally, proceed to the standard setup instructions.

Usage Examples
--------------

Simple example
~~~~~~~~~~~~~~

Receives SBP messages over a serial port, decodes MSG_BASELINE
messages and prints them out. See `simple.py`_ .

Run this example with::

  $ python -m sbp.client.examples.simple -p /path/to/serial/port

Sending SBP messages over UDP
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Receives SBP messages over a serial port and sends all incoming
messages to a UDP socket. See `udp.py`_ .

Run this example with::

  $ python -m sbp.client.examples.udp -s /path/to/serial/port

Testing
--------------

To run the tests and check for coverage::

  $  py.test -v --cov sbp tests/

To run the tests without suppressing stdout output:

  $  py.test -v -s --cov sbp tests/

License
-------

Copyright © 2015 Swift Navigation

Distributed under LGPLv3.0.

.. _simple.py: https://github.com/swift-nav/libsbp/blob/master/python/sbp/client/examples/simple.py
.. _udp.py: https://github.com/swift-nav/libsbp/blob/master/python/sbp/client/examples/udp.py


