ONEKEY API Client

This is the official Python client for the ONEKEY public API.

Usage

First, you have to log in and select a tenant:

from onekey_client import Client

YOUR_API_URL = "https://demo.onekey.com/api"

client = Client(api_url=YOUR_API_URL)

client.login(EMAIL, PASSWORD)
tenant = client.get_tenant("Environment name")
client.use_tenant(tenant)

After you logged in and selected the tenant, you can query the GraphQL API

GET_ALL_FIRMWARES = """
query {
  allFirmwares {
    id
    name
  }
}
"""
res = client.query(GET_ALL_FIRMWARES)
print(res)

GET_PRODUCT_GROUPS = """
query {
  allProductGroups {
    id
    name
  }
}
"""
res = client.query(GET_PRODUCT_GROUPS)
default_product_group = next(pg for pg in res["allProductGroups"] if pg["name"] == "Default")

You can upload firmwares:

metadata = FirmwareMetadata(
    name="myFirmware",
    vendor_name="myVendor",
    product_name="myProduct",
    product_group_id=default_product_group["id"],
)

firmware_path = Path("/path/to/firmware.bin")
res = client.upload_firmware(metadata, firmware_path, enable_monitoring=True)
print(res)

Support

You can create a new issue in this repo or contact us at support@onekey.com.

Metadata

Release files for onekey-client 2.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for onekey-client 2.0.1
File	Size	Uploaded
onekey_client-2.0.1.tar.gz	19.0 kB	Jun 17, 2022	Details

Built distribution (wheel)

Table of built distributions (wheels) for onekey-client 2.0.1
File	Interpreter	ABI	Platform	Reset
onekey_client-2.0.1-py3-none-any.whl 19.5 kB Jun 17, 2022	Python 3	none	any	Details

Total release size: 38.5 kB

Release files / onekey_client-2.0.1.tar.gz

Download URL	onekey_client-2.0.1.tar.gz
Size	19.0 kB
Tags	Source
SHA-256 checksum How to use checksums	`7e7cba99584923212f947b79dd688d86c9cf33403a39ffbe14d86598af967094`
BLAKE2b-256 checksum How to use checksums	`da3b9c20ec9dc785092fda21edb82c7ff21948e9f9009240662d922ee590c817`
Upload date	Jun 17, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.1.13 CPython/3.10.5 Linux/5.13.0-1029-azure`

Release files / onekey_client-2.0.1-py3-none-any.whl

Download URL	onekey_client-2.0.1-py3-none-any.whl
Size	19.5 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`a4012534fb8e623ee8915c857a401494c8008a6bf21bae3257080ce4e83639ba`
BLAKE2b-256 checksum How to use checksums	`655fb493a3aebf9a2965cb7807cd0b4d09e87aedf799627e577c6cd0045fd8ab`
Upload date	Jun 17, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.1.13 CPython/3.10.5 Linux/5.13.0-1029-azure`