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
from GearAPI import Client

client = Client(
    user = <IoT Platform User Name>
    password = <IoT Platform User Password>
)

date_start = "2025-03-01"
date_end = "2025-03-02"
device_params = {
    "devicetype": "iaq"
}
output_file_path = "output.csv"

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

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

go to https://github.com/kajimadev-KaTRIS/GearAPI/deployments/github-pages and click on the latest weblink for more information

data in csv

some of the data doesn't open properly in excel .csv (e.g. oura ring heart rate data) due to limited size. please use pandas to visualise the data for now.

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.15.10.tar.gz (14.3 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.15.10-py3-none-any.whl (19.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gearapi-0.15.10.tar.gz
  • Upload date:
  • Size: 14.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for gearapi-0.15.10.tar.gz
Algorithm Hash digest
SHA256 978f5d7a6fe55d403f01c3f29a1ee548af9b0ee3c61dfb2dcd6901b0a74f6430
MD5 06bf8e83152a41c54bca24062ba5c086
BLAKE2b-256 41b542395937add70ae3897ce40a5a07580030f5028cd5733cb4ae8cd2eb3970

See more details on using hashes here.

File details

Details for the file gearapi-0.15.10-py3-none-any.whl.

File metadata

  • Download URL: gearapi-0.15.10-py3-none-any.whl
  • Upload date:
  • Size: 19.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for gearapi-0.15.10-py3-none-any.whl
Algorithm Hash digest
SHA256 e0beeee929207ffe600abe4de57babac8ea7ee46eee20d728650b6ff7e294c8b
MD5 a169150fe92ac4a15a018d4851b81cfd
BLAKE2b-256 02b35463e93f2acbcfac8c168d48650750a6e6e598ac037042dc459e5fe978fc

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