Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github
docs
python_hologram_api
tests
.editorconfig
.gitignore
.travis.yml
CONTRIBUTING.rst
HISTORY.rst
LICENSE
MANIFEST.in
Makefile
README.rst
requirements.txt
requirements_dev.txt
setup.cfg
setup.py
tox.ini

README.rst

python-hologram-api

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

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

Installation

pip install python-hologram-api

Documentation

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