Skip to main content

An API wrapper for cumulocity API. Made for researcher. Focus on Measurements and events resources from GEAR data

Project description

This is a Python client for the Cumulocity Data API. The GearAPI package is a wrapper to simplify GET requests and JSON response parsing from the Measurement and Event Resources.

This library abstracts:

  1. API endpoint handling
  2. pagnation handling
  3. API retry
  4. file handling
  5. Handling API from multiple devices

how to use

  1. pip install GearAPI
import Client

client = Client(
    USER = <IoT Platform User Name>
    PASSWORD = <IoT Platform User Password>
    BASE_URL = "https://thegear.jp.cumulocity.com"
    TENANT_ID = "t21092648"
)

date_start = "2024-01-01"
date_end = "2024-01-02"
device_params = {
    "devicetype": "iaq"
}
output_path = "output.csv"

client.download(
    date_start, 
    date_end, 
    output_path = output_path, 
    device_params = device_params)

"""
output: all the iaq devices data from 2024-01-01 to 2024-01-02
"""

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

gearapi-0.13.16.tar.gz (10.9 kB view details)

Uploaded Source

Built Distribution

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

GearAPI-0.13.16-py3-none-any.whl (14.8 kB view details)

Uploaded Python 3

File details

Details for the file gearapi-0.13.16.tar.gz.

File metadata

  • Download URL: gearapi-0.13.16.tar.gz
  • Upload date:
  • Size: 10.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for gearapi-0.13.16.tar.gz
Algorithm Hash digest
SHA256 b6d20ce93f47cd4a909d0fbcd482c2d4ad655b7a81d223a132f30c31345d6845
MD5 b04b2a2f29c062c975cce7b45e88bd8a
BLAKE2b-256 db2615a3ea61a155c442ab9788cd1bc5a950bc43adf40984a1212f7b879394f5

See more details on using hashes here.

File details

Details for the file GearAPI-0.13.16-py3-none-any.whl.

File metadata

  • Download URL: GearAPI-0.13.16-py3-none-any.whl
  • Upload date:
  • Size: 14.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for GearAPI-0.13.16-py3-none-any.whl
Algorithm Hash digest
SHA256 6a8bafec25776d40c6bf1ba1b84cde943022efb8d35baed24688052beb6edc22
MD5 7e9a8cf67f42900b872e99ebc81e88df
BLAKE2b-256 9e1ab31d3dda0d07276d679c98e19c8ff38e098fa328f6aee979d43b759953ff

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