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 (https://pypi.org/project/qci-client/) into your Python virtual environment using–
- pip install qci-client
Instantiating a Client
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–
- from qci_client import QciClient
- client = QciClient()
Without Environment Variables
Access the API without first defining environment variables by instantiating a QciClient as follows–
- from qci_client import QciClient
- client = QciClient(url="https://api.qci-prod.com", api_token="<secret-token>")
Table of Contents
Version
3.2.1