Skip to main content

An unofficial Python client for the MyGeotab API

Project description

Build Status Code Coverage PyPI Version PyPI Downloads Documentation Status

An Apache2 Licensed, unofficial Python client for the MyGeotab SDK.

Also bundled is the “myg” command line tool, which is a sandboxed console for quickly querying and operating on MyGeotab data.

Features

  • Automatic serializing and de-serializing of JSON results

  • Clean, Pythonic API for querying data

  • Cross-platform and compatible with Python 2.7.9+, 3.4+, and pypy 4+

Usage

>>> import mygeotab
>>> api = mygeotab.API(username='hello@example.com', password='mypass', database='DemoDB')
>>> api.authenticate()
>>> api.get('Device', search=dict(name='%Test Dev%'))
[{'maxSecondsBetweenLogs': 200.0,
  'activeTo': '2050-01-01',
  'minAccidentSpeed': 3.0,
  'ignoreDownloadsUntil': '1986-01-01',
  'name': 'Test Device',
  'idleMinutes': 3.0,
  ......

Installation

To install the MyGeotab library and command line tool:

$ pip install mygeotab

or for the bleeding-edge version:

$ pip install git+https://github.com/geotab/mygeotab-python

Documentation

Read the docs at http://mygeotab-python.readthedocs.org

Changes

0.5.1 (2017-01-04)

Bug Fixes

  • Fix for search parameter not being properly handled in ‘get()’ call

0.5 (2017-01-02)

Enhancements

  • Deprecated the ‘search()’ and ‘search_async()’ functions. Replaced by folding the previous functionality into ‘run()’.

  • Removed ‘tzlocal’ dependency. Always deal with dates in UTC by default.

  • Prefer functions instead of making static methods in classes.

  • Added helper to run async calls and collect their results

  • Add ability to quickly run simple python scripts from the ‘myg’ console with no need for any authentication handling. Similar to ‘console’, but for running scripts rather than creating an interactive console.

0.4.4 (2016-07-10)

Enhancements

  • Added the ability to make unauthenticated calls (like “GetVersion”) with the static “API.server_call” method

  • Added asyncio-based API query methods (Python 3.5+ only) into the “ext” package

  • Moved the datafeed to the “ext” package, as well

Bug Fixes

  • MyGeotab never returns 3 digits of milliseconds, so follow that format as well to allow the use of “dates.format_iso_datetime” to create MyGeotab URLs

0.4.2 (2016-03-17)

Bug Fixes

  • Use a custom User-Agent when making requests

0.4 (2016-02-25)

Enhancements

  • Extension for facilitating use of the MyGeotab Data Feed

  • Allow Pythonic underscore-separated parameters mapped to camelcase ones

  • Force the use of TLS 1.2 for upcoming strict security requirements in MyGeotab (Note that TLS 1.2 is only supported in Python 2.7.9+ and 3.4+)

Bug Fixes

  • Fixed issue with CLI console startup

  • Use the system’s default user location for config files

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mygeotab-0.5.1.tar.gz (11.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mygeotab-0.5.1-py2.py3-none-any.whl (17.3 kB view details)

Uploaded Python 2Python 3

File details

Details for the file mygeotab-0.5.1.tar.gz.

File metadata

  • Download URL: mygeotab-0.5.1.tar.gz
  • Upload date:
  • Size: 11.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for mygeotab-0.5.1.tar.gz
Algorithm Hash digest
SHA256 fb45437b35741da4789c6d18f3dda70d8a9b1a4ccde74be0a543c17979d78825
MD5 37fca89cb0e030dac8f794758206ce51
BLAKE2b-256 1555a222f942a6562612e9a29afbf7ab58c88ee44b447c5a39e9f491de6b9b07

See more details on using hashes here.

File details

Details for the file mygeotab-0.5.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for mygeotab-0.5.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ea9ffe65a7b15c2b509a3fa8f5ebea19fbcccc0b0911d9b38e90b0712f0829f3
MD5 2a215a301add6cd0b2e4bb961374bfcb
BLAKE2b-256 58dc2d3186913f84fd590a0551eb78198a75a473c9c93935a7c4a93a9bd84832

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page