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.11.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.11-py3-none-any.whl (19.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gearapi-0.15.11.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.11.tar.gz
Algorithm Hash digest
SHA256 5dd07418c91cd1d7f343986b0dd688c432b60bb2683b4f33c41325a48aab02e9
MD5 7515cb014dda4f4b19f59b4100bd8ab9
BLAKE2b-256 6dfb45316be626e485e9bf5a08283f9b83624f3ce2ad447e0cf2ea8dbe03d770

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gearapi-0.15.11-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.11-py3-none-any.whl
Algorithm Hash digest
SHA256 5baae07bf80c363210212f1b0557c2a1215160f7bacefcc1e270d546076e31ef
MD5 307b86c148af61a95ebca6cfe8adaf7c
BLAKE2b-256 2fd10ec2537fa4602ba30dbd6c417149fcdabe48df49b7631a41f4bab62ccc79

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