Skip to main content

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.2

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.2
File Size Uploaded
onekey_client-2.0.2.tar.gz 18.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for onekey-client 2.0.2
File Interpreter ABI Platform
onekey_client-2.0.2-py3-none-any.whl Python 3 none any Details

Total release size: 38.4 kB

Release files / onekey_client-2.0.2.tar.gz

Download URL onekey_client-2.0.2.tar.gz
Size 18.8 kB
Tags Source
SHA-256 checksum
How to use checksums
27acdde04e809f729302ecf5199e493fb6b2f6e76ff70887f3b4708d061c7a3f
BLAKE2b-256 checksum
How to use checksums
3aa2b608e6ca86376cfae33cabfb6d8dcd656d36b85e0c041da6657a76354df9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.2.2 CPython/3.11.0 Linux/5.15.0-1023-azure

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

Download URL onekey_client-2.0.2-py3-none-any.whl
Size 19.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ff1ce273c12df021cdf36666e91dcbf791fe141e6bfc23c082a40d035db8b213
BLAKE2b-256 checksum
How to use checksums
688964275f4764822befcc3f271ed3a43f48c00b25856d02225a9a16110d8ce6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.2.2 CPython/3.11.0 Linux/5.15.0-1023-azure

Release history Release notifications | RSS feed

2.9.0

2 release files

2.8.0

2 release files

2.7.0

2 release files

2.6.0

2 release files

2.5.0

2 release files

2.4.0

2 release files

2.3.0

2 release files

2.2.0

2 release files

2.1.1

2 release files

2.1.0

2 release files

2.0.3

2 release files

This release

2.0.2 This release

2 release files

2.0.1

2 release files

2.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page