Skip to content
Python client library for AndonApp
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
andonapp
tests
.gitignore
LICENSE
MANIFEST.in
README.rst
requirements.txt
setup.py

README.rst

AndonApp Python Client

Python client library for reporting data to Andon

Install

pip install andonapp

Usage

In order to programmatically connect to Andon's APIs you must first generate an API token. This is done by logging into your Andon account, navigating to the API settings page, and generating a new token. Make sure to record the token, and keep it secret.

Reference Andon's getting started guide and API guide for complete details on these prerequisites

Setting up the Client

Now that you have a token, create a client as follows:

from andonapp import AndonAppClient

client = AndonAppClient(org_name, api_token)

Reporting Data

Here's an example of using the client to report a success:

client.report_data(
    line_name='line 1',
    station_name='station 1',
    pass_result='PASS',
    process_time_seconds=100)

And a failure:

client.report_data(
    line_name='line 1',
    station_name='station 1',
    pass_result='FAIL',
    process_time_seconds=100,
    fail_reason='Test Failure',
    fail_notes='notes')

Updating a Station Status

Here's an example of flipping a station to Red:

client.update_station_status(
    line_name='line 1',
    station_name='station 1',
    status_color='RED',
    status_reason='Missing parts',
    status_notes='notes')

And back to Green:

client.update_station_status(
    line_name='line 1',
    station_name='station 1',
    status_color='GREEN',
    status_notes='notes')

License

Licensed under the MIT license.

You can’t perform that action at this time.