QCI Client
Getting started
Installation
qci-client currently supports Python 3.9-13, inclusive, as specified in the
PEP-621-compliant pyproject.toml file.
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
Optionally, set this environment variable--
- QCI_SSL_VERIFY - set to "false" to disable server TLS/SSL certificate verification (needed for self-signed certificates; insecure). Defaults to "true".
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>")
1 maintainer
Metadata
1 maintainer
Release files for qci-client 5.0.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| qci_client-5.0.3.tar.gz | 36.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| qci_client-5.0.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 76.1 kB
Release files / qci_client-5.0.3.tar.gz
| Download URL | qci_client-5.0.3.tar.gz |
|---|---|
| Size | 36.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c3eea244cecfcf8bf03e6ac1d96f3a1fec0f01d0ab326141c299ab480060c29a
|
|
BLAKE2b-256 checksum How to use checksums |
c0cdb9a0388185e7624dd1e4d6c5b135079c67247159101dc6e9992242ea6323
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
Release files / qci_client-5.0.3-py3-none-any.whl
| Download URL | qci_client-5.0.3-py3-none-any.whl |
|---|---|
| Size | 39.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
fc3b29c45116900ef70709b7fbb9b9c676adb75b7cd8a04b0ef7730b8906c3e3
|
|
BLAKE2b-256 checksum How to use checksums |
c68d1f1f7c9e4f1180aa57e335ea73a78f4351ac816b373f66f1e7ec1c0f024d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
