Skip to main content

Python client for https://dashboard.hologram.io/api.

Project description

python-hologram-api

Python client for https://dashboard.hologram.io/api.

https://img.shields.io/pypi/v/python-hologram-api.svg https://img.shields.io/travis/vicyap/python-hologram-api.svg https://coveralls.io/repos/github/vicyap/python-hologram-api/badge.svg?branch=master Documentation Status

Installation

pip install python-hologram-api

Usage

HologramClient is the main class you should use. Most of its methods are sub-categorized based on the endpoint that the method interfaces with. For example, user account management is under client.user.

To use python-hologram-api in a project:

import os
from python_hologram_api.client import HologramClient

HOLOGRAM_API_KEY = os.environ.get('HOLOGRAM_API_KEY')
client = HologramClient(HOLOGRAM_API_KEY)

Example Usages:

# List Devices
resp = client.devices.list()
if resp.get('success'):
    devices = resp.get('data')

# Get a Device
device_id = 1234
resp = client.devices.get(device_id)
if resp.get('success'):
    device = resp.get('data')

# Activate SIMs
sims = ['99990000000012345678']
plan = 73
tier = 1
resp = client.cell.activate_sims(sims, plan, tier)
assert resp.get('success') is not None

The following submodules are available:

  • Device Management
    • client.devices
    • client.cell
    • client.tags
    • client.data_plans
  • Hologram Cloud
    • client.csr
    • client.sms
    • client.cloud
    • client.spacebridge
  • Account Management
    • client.user
    • client.org

License

  • Free software: MIT license

History

0.1.6 (2017-10-27)

  • Add coverage to travis
  • Add coveralls to travis and README

0.1.5 (2017-10-27)

  • Update README formatting/highlighting

0.1.4 (2017-10-23)

  • Add python_hologram_api.rst to documentation

0.1.3 (2017-10-23)

  • Update documentation

0.1.2 (2017-10-23)

0.1.1 (2017-10-23)

  • Travis Errors

0.1.0 (2017-10-20)

  • Mistakes were made.

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

python_hologram_api-0.1.6.tar.gz (18.2 kB view hashes)

Uploaded source

Built Distribution

python_hologram_api-0.1.6-py2.py3-none-any.whl (13.2 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page