Metadata-Version: 2.1
Name: harlequin-wherobots
Version: 0.6.0
Summary: 
Author: Maxime Petazzoni
Author-email: max@wherobots.com
Requires-Python: >=3.9,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: harlequin (>=1.16.2,<2.0.0)
Requires-Dist: wherobots-python-dbapi (>=0.9.1,<0.10.0)
Description-Content-Type: text/markdown

# Wherobots Adapter for Harlequin

This repository provides the Harlequin adapter for WherobotsDB, using
the Wherobots Spatial SQL API and its
[wherobots-python-dbapi-driver](https://github.com/wherobots/wherobots-python-dbapi-driver).

## Installation

```
$ pip install harlequin-wherobots
```

## Usage

Procure an API key from Wherobots, and start Harlequin with the
required parameters:

```
$ harlequin -a wherobots --api-key <key>
```

Alternatively, you can use your session token:

```
$ harlequin -a wherobots --token <token>
```

The Harlequin adapter for Wherobots will automatically start a Wherobots
SQL session with the default runtime (Tiny, 4 executors) in the
default Wherobots public compute region (AWS `us-west-2`). You can
override those defaults with the `--runtime` and `--region` options,
respectively:

```
$ harlequin -a wherobots --api-key <key> --runtime MEDIUM --region AWS_US_WEST_2
```

> [!NOTE]
> Community Edition users of Wherobots Cloud are restricted to the
> "Tiny" runtime size. See our [Pricing](https://www.wherobots.com/pricing)
> for more information.

## Advanced options

If your SQL session is already provisioned and running, you can force
the driver to directly connect to it via its WebSocket URL (without
protocol version):

```
$ harlequin -a wherobots --api-key <key> --ws-url <session-url>
```

You can also specify the base hostname of the Wherobots stack to
interact with as the first positional parameter. By default, the driver
connects to `cloud.wherobots.com`, the official public Wherobots
service.

```
$ harlequin -a wherobots --api-key <key> [host]
```

