Metadata-Version: 2.4
Name: resq-client
Version: 0.1.0rc1
Summary: Python client for the ResQ network topology, e2e connection and routing/compute remote API.
Author: nodeQ Limited
License-Expression: Apache-2.0
Project-URL: Documentation, https://docs.resq.nodequantum.com
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: NOTICE
Requires-Dist: httpx>=0.26
Requires-Dist: geographiclib>=2.0
Provides-Extra: analysis
Requires-Dist: pandas>=2.0; extra == "analysis"
Provides-Extra: plotting
Requires-Dist: matplotlib>=3.5; extra == "plotting"
Requires-Dist: networkx>=3.0; extra == "plotting"
Requires-Dist: scipy>=1.10; extra == "plotting"
Dynamic: license-file

# resq-client

`resq-client` is the Python interface for running routing and resource
computations with ResQ. Use it to build or generate PQC, QKD, and Q networks
with their end-to-end connection demands, inspect the exact request before
sending it, run one or many computations, and turn the results into pandas
tables and plots.

## Requirements

- Python 3.11 or newer
- A ResQ API key to run computations. Building networks and inspecting
  requests works without one.

## Installation

```bash
pip install resq-client
```

Optional extras add features. Name them in brackets after the package name:

```bash
pip install "resq-client[analysis,plotting]"
```

| Extra | Adds |
|---|---|
| `analysis` | pandas tables of results |
| `plotting` | network and result plots |

Geographic maps are not available from the published package: their geography
is a separate package, `resq-client-mapdata`, which is not published.

## Example

This builds a two-node PQC network with one demand and prints the compute
request without sending it. No API key is needed for this step.

```python
from resq_client import (
    Client, Connection, E2EConnections, Link, NetworkBundle,
    NetworkType, Node, Topology,
)

topology = Topology(NetworkType.PQC, label="pqc-demo")
alice = Node.pqc_endpoint_profile("Alice")
bob = Node.pqc_endpoint_profile("Bob")
topology.add_node(alice)
topology.add_node(bob)
topology.add_link(Link.pqc_link("Alice-Bob", alice, bob, bandwidth=100.0))

connections = E2EConnections(
    topology_id=topology.topology_id,
    network_type=topology.network_type,
    label="pqc-connections",
)
connections.add_connection(
    Connection.pqc_unicast(
        alice, bob, demand=10.0, unit="Mbps", security_level=5,
        SIG="mldsa87", KEM="mlkem1024", SYM="aes-256-gcm",
    )
)
bundle = NetworkBundle(topology, connections, label="pqc-demo")
policy = {"routing_protocol": "shortest_path", "num_paths": 1}

with Client(
    api_key="offline-placeholder",
    base_url="https://resq.nodequantum.com",
) as client:
    payload = client.compute.run(bundle, policy=policy, dry_run=True)

print("Nodes:", len(payload["topology"]["node"]))
print("Links:", len(payload["topology"]["link"]))
print("Connections:", len(payload["connections"]))
```

## Documentation

<https://docs.resq.nodequantum.com>

## License

Copyright (c) 2026 nodeQ Limited.

The SDK is licensed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).
You may use it in your applications, modify it, and redistribute it under the
license's terms. The distribution includes `LICENSE` with the full license and
`NOTICE` with attribution information. Preserve the required license and
attribution notices when redistributing the SDK.

## Hosted API access

The SDK's software license does not grant access to the hosted ResQ API.
External hosted access will require an individually assigned, nontransferable
API key, sufficient credits for the requested operations, and acceptance of
the separate service agreement. Do not share or redistribute API keys with
the SDK.
