Client Package for using Qatalyst Optimization Suite
Project description
QCI Client
Getting started
Installation
qci-client
currently supports Python 3.8-12, inclusive, as specified in the
PEP-621-compliant pyproject.toml.
Install qci-client
from the public PyPI server
into your Python virtual environment using--
pip install qci-client
Instantiating a Client for Optimization
With Environment Variables
To access the API, set these environment variables--
- QCI_API_URL - URL for Qatalyst API, Example: "https://api.qci-prod.com"
- QCI_TOKEN - refresh token string for securely accessing Qatalyst API
then instantiate a QciClient
as follows--
# An alias for `from qci_client.optimization.client import Client as QciClient`.
from qci_client import QciClient
client = QciClient()
Without Environment Variables
Access the API without first defining environment variables by instantiating a
QciClient
as follows--
# A alias for `from qci_client.optimization.client import Client as QciClient`.
from qci_client import QciClient
client = QciClient(url="https://api.qci-prod.com", api_token="<secret-token>")
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
qci_client-4.0.0.tar.gz
(31.1 kB
view hashes)
Built Distribution
qci_client-4.0.0-py3-none-any.whl
(33.8 kB
view hashes)
Close
Hashes for qci_client-4.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5fe9bfc78a8180dcc5107b66697b66dc724f3b5c218dd72a21ab83ac5a95917c |
|
MD5 | 5cac189b23cf7d363a21330e67312824 |
|
BLAKE2b-256 | b4a4d388b8528f00ee5cf8d8caf9482e6c852bbf300ef50252d84324d7b453d8 |