Metadata-Version: 2.1
Name: qci-client
Version: 4.3.0
Summary: Client Package for using Qatalyst Optimization Suite
Author-email: "Quantum Computing Inc." <support@quantumcomputinginc.com>
License: Apache 2.0
Project-URL: documentation, https://quantumcomputinginc.com/learn/reference-documentation
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Requires-Python: <3.13,>=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests<3,>=2.22.1
Requires-Dist: requests-futures<2,>=1.0.0
Requires-Dist: networkx<3,>=2.6.3
Requires-Dist: numpy<2,>=1.21.1
Requires-Dist: scipy<2,>=1.7.3
Provides-Extra: dev
Requires-Dist: black<25,>=24.3.0; extra == "dev"
Requires-Dist: build<0.11,>=0.10.0; extra == "dev"
Requires-Dist: check-manifest<0.49,>=0.48; extra == "dev"
Requires-Dist: coverage[toml]<7,>=6.4.2; extra == "dev"
Requires-Dist: pylint<4,>=3.1.0; extra == "dev"
Requires-Dist: pytest<8,>=7.2.1; extra == "dev"
Requires-Dist: sphinx-rtd-theme>=1.3.0; extra == "dev"
Requires-Dist: twine<4,>=3.7.1; extra == "dev"

# 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](https://pypi.org/)
into your Python virtual environment using--

```bash
pip install qci-client
```

### Instantiating a Client for Optimization

#### With Environment Variables

To access the API, set these environment variables--

<!-- markdown-link-check-disable-next-line -->
- 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--

```python
# 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--

```python
# 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>")
```
