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.1.0.tar.gz
(31.5 kB
view hashes)
Built Distribution
qci_client-4.1.0-py3-none-any.whl
(34.1 kB
view hashes)
Close
Hashes for qci_client-4.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 16da7bfd6347812a19ed22f91c1b2e910cb591af674d0ba555d9881487d92467 |
|
MD5 | 8130fc5da84eea69ba050efca6c8079d |
|
BLAKE2b-256 | 669adcb740dd5e5e9a7867cace97560a57d4a0d69e3ff6aadc4e63013004fcce |