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 = "2024-08-01"
date_end = "2024-08-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

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.9.tar.gz (18.2 kB view details)

Uploaded Source

Built Distributions

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

gearapi-0.15.9-py3-none-any.whl (19.8 kB view details)

Uploaded Python 3

GearAPI-0.15.9-py3-none-any.whl (23.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gearapi-0.15.9.tar.gz
  • Upload date:
  • Size: 18.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for gearapi-0.15.9.tar.gz
Algorithm Hash digest
SHA256 53a913624e879bc3568566f53142eaff7dfe7a0e3d45841c16aabc3023cb57ea
MD5 9144256e10dc2da5829d3915a70eec65
BLAKE2b-256 f6cf0ef87866edfad08697c1a89ba0ba4f53c8cac1c47faf6b7717b499f6e27f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gearapi-0.15.9-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.9-py3-none-any.whl
Algorithm Hash digest
SHA256 18212f7ed9dead1a4c889ddfff67c627fee32fc4908827b935a8d149cb538c81
MD5 f54956225b6ccb186eeaccc2102b6dc4
BLAKE2b-256 043dbf2ac433ab226bb8aca53924df81b4601a8fb65ddcb6e24bdf2f4fdecf9e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: GearAPI-0.15.9-py3-none-any.whl
  • Upload date:
  • Size: 23.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for GearAPI-0.15.9-py3-none-any.whl
Algorithm Hash digest
SHA256 186f2803fbc9c2fb4d648dddfb66fb6d9a664355f60fbb33b7810c8ca3f847d2
MD5 c42604357907f9f0d658b99cce214df2
BLAKE2b-256 38b7874f2f352e495be154a8c52186ac9b498bcfeed7b65f24d6951b11787605

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