fleetglue-client 2.0.1

Python client for FleetGlue API

FleetGlue API Python Client

A Python library for interfacing with the FleetGlue REST API in a Pythonic way, presenting Accounts, Devices, Alerts, and other objects as instances of Python classes. Currently only supports reading from the API ("GET" requests).

Installation

$ pip(3) install fleetglue-client

Simple API examples

Instantiating the API

With a token and secret:

from fleetglue_client import FleetGlueClient
client = FleetGlueClient(token = "TXXX", secret = "Sxxx")

With a username and password:

from fleetglue_client import FleetGlueClient
client = FleetGlueClient(username = "[e-mail]", password = "foo")

With a saved credentials file:

from fleetglue_client import FleetGlueClient
client = FleetGlueClient()

The file should be in ~/.fleetglue/credentials and contain a JSON structure with token and secret fields, e.g. {"token":"TXXX", "secret":"SXXX"}.

Manipulating accounts

Getting a list of accounts you have access to:

for account in client.accounts:
    print(account)

Manipulating devices

Getting a list of devices in the first account you have access to:

for device in client.accounts[0].devices:
    print(device.name)

You can fetch a specific device by its ID:

device = client.accounts[0].device("Dxxxxxxxxxxxx")

or search for it by its name, assuming that name is unique:

device = client.accounts[0].find_device("myrobot")

Getting data from devices

Getting the most recent value from a ROS topic:

device = client.accounts[0].find_device("myrobot")
print(device.last_data("/gps/fix"))

Getting full data from a time interval:

device = client.accounts[0].find_device("myrobot")

# fetch last 1000 s of data
for message in device.data("/gps/fix", start = time.time() - 1000, end = time.time()):
    print(message)

Advanced API examples

See the demo_.py files. (TODO: more data analysis demos.)

Distribution

First you will need to have a local ~/.pypirc file with the configurations for both Test PyPi and the production one. E.g.

[testpypi]
  username = __token__
  password = <request for original token>

[pypi]
  username = __token__
  password = <request for original token>

Steps

• Publish to testpypi:

REPOSITORY=testpypi ./publish_to_pypi.sh

• Check that it's working properly:

pip install --index-url https://test.pypi.org/simple fleetglue_client

• Push to actual PyPi

REPOSITORY=pypi ./publish_to_pypi.sh