aliro-honeywell
This is an api to connect to the Honeywell backend
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 1.0.0
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
Requirements.
Python 2.7 and 3.4+
Installation & Usage
pip install
pip install aliro-honeywell
Then import the package:
import aliro_honeywell
Getting Started
Please follow the installation procedure and then run the following:
from __future__ import print_function
import time
import aliro_honeywell
from aliro_honeywell.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://qapi.honeywell.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = aliro_honeywell.Configuration(
host = "https://qapi.honeywell.com/v1"
)
# Enter a context with an instance of the API client
with aliro_honeywell.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = aliro_honeywell.AuthenticationApi(api_client)
login_post_parameters = aliro_honeywell.LoginPostParameters() # LoginPostParameters | (optional)
try:
# This API returns an id-token and a refresh-token.
api_response = api_instance.login_post(login_post_parameters=login_post_parameters)
pprint(api_response)
except ApiException as e:
print("Exception when calling AuthenticationApi->login_post: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to https://qapi.honeywell.com/v1
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AuthenticationApi | login_post | POST /login | This API returns an id-token and a refresh-token. |
| JobApi | job_job_id_cancel_post | POST /job/{job-id}/cancel | Previously submitted quantum job may be canceled using this API |
| JobApi | job_job_id_get | GET /job/{job-id} | Users monitor job status using job status API. In addition to this API, users may set notification preferences via user portal to allow email or text notifications related to job status. These portal-configured notifications are out of scope for this API specification. Different results formatters may be added in the future via additional query string parameters. Current API specification supports raw results only. To retrieve job status and results, the following API is used: |
| JobApi | job_post | POST /job | Quantum job may be submitted using the following API |
| MachineApi | machine_get | GET /machine | This API returns a list of available machine names at that time. |
| MachineApi | machine_name_get | GET /machine/{name} | |
| MeteringApi | metering_get | GET /metering | Metering API is used to retrieve information about the jobs run and the number of QCU consumed within specific period of time. Metering requests can use date range, last X number of days or last Y number of jobs. |
Documentation For Models
- ErrorResponse
- ErrorResponseError
- InlineResponse200
- InlineResponse2001
- InlineResponse2002
- InlineResponse2003
- InlineResponse2003Jobs
- InlineResponseDefault
- InlineResponseDefault1
- JobPostParameters
- JobResponse
- LoginPostParameters
Documentation For Authorization
JwtKeyAuth
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header
Author
Metadata
Release files for aliro-honeywell 1.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| aliro-honeywell-1.0.1.tar.gz | 29.0 kB | Without provenance | Details for aliro-honeywell-1.0.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| aliro_honeywell-1.0.1-py2-none-any.whl | Python 2 | none | any | Details for aliro_honeywell-1.0.1-py2-none-any.whl |
Total release size: 76.4 kB
Release files / aliro-honeywell-1.0.1.tar.gz
| Download URL | aliro-honeywell-1.0.1.tar.gz |
|---|---|
| Size | 29.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a5677ac01cab89b1e487baa1bd113f064d318965bc184c4a8d5390c3a34bd045
|
|
BLAKE2b-256 checksum How to use checksums |
20275d75d9f017c1c66c3d70d88ff48895457bfafbf95dfb52c4743a6ecfcaeb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.7.5
|
Release files / aliro_honeywell-1.0.1-py2-none-any.whl
| Download URL | aliro_honeywell-1.0.1-py2-none-any.whl |
|---|---|
| Size | 47.4 kB |
| Tags | Python 2 |
|
SHA-256 checksum How to use checksums |
6a22d169c96d9abca09861f0c4f606b554a0f5eecc93cdfd79306e7e2dbf883f
|
|
BLAKE2b-256 checksum How to use checksums |
09521b77e1f487b6931d703b8394a9b7f63a55868a4f59ac3229da9213dc8f78
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.7.5
|
Security for aliro-honeywell 1.0.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.