| Name | harlequin-wherobots JSON |
| Version |
0.6.1
JSON |
| download |
| home_page | None |
| Summary | None |
| upload_time | 2025-01-06 17:25:59 |
| maintainer | None |
| docs_url | None |
| author | Maxime Petazzoni |
| requires_python | <4.0,>=3.9 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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]
```
Raw data
{
"_id": null,
"home_page": null,
"name": "harlequin-wherobots",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Maxime Petazzoni",
"author_email": "max@wherobots.com",
"download_url": "https://files.pythonhosted.org/packages/5e/d7/55791a02bf19e7110e6831a88c4b04a4eaf2030d1c4a3a5b90180276bbe5/harlequin_wherobots-0.6.1.tar.gz",
"platform": null,
"description": "# Wherobots Adapter for Harlequin\n\nThis repository provides the Harlequin adapter for WherobotsDB, using\nthe Wherobots Spatial SQL API and its\n[wherobots-python-dbapi-driver](https://github.com/wherobots/wherobots-python-dbapi-driver).\n\n## Installation\n\n```\n$ pip install harlequin-wherobots\n```\n\n## Usage\n\nProcure an API key from Wherobots, and start Harlequin with the\nrequired parameters:\n\n```\n$ harlequin -a wherobots --api-key <key>\n```\n\nAlternatively, you can use your session token:\n\n```\n$ harlequin -a wherobots --token <token>\n```\n\nThe Harlequin adapter for Wherobots will automatically start a Wherobots\nSQL session with the default runtime (Tiny, 4 executors) in the\ndefault Wherobots public compute region (AWS `us-west-2`). You can\noverride those defaults with the `--runtime` and `--region` options,\nrespectively:\n\n```\n$ harlequin -a wherobots --api-key <key> --runtime MEDIUM --region AWS_US_WEST_2\n```\n\n> [!NOTE]\n> Community Edition users of Wherobots Cloud are restricted to the\n> \"Tiny\" runtime size. See our [Pricing](https://www.wherobots.com/pricing)\n> for more information.\n\n## Advanced options\n\nIf your SQL session is already provisioned and running, you can force\nthe driver to directly connect to it via its WebSocket URL (without\nprotocol version):\n\n```\n$ harlequin -a wherobots --api-key <key> --ws-url <session-url>\n```\n\nYou can also specify the base hostname of the Wherobots stack to\ninteract with as the first positional parameter. By default, the driver\nconnects to `cloud.wherobots.com`, the official public Wherobots\nservice.\n\n```\n$ harlequin -a wherobots --api-key <key> [host]\n```\n\n",
"bugtrack_url": null,
"license": null,
"summary": null,
"version": "0.6.1",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d1132b0d9270b744d477eb0b8decd8b151d1623e757798902981f73f5d013c74",
"md5": "3d95f57920f2b77e73b71d626c6c0ef0",
"sha256": "e3d75e67626d6b31251e196844732137956ce4e5e46c8f39b5ed2d25d5c577b0"
},
"downloads": -1,
"filename": "harlequin_wherobots-0.6.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3d95f57920f2b77e73b71d626c6c0ef0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 9829,
"upload_time": "2025-01-06T17:25:57",
"upload_time_iso_8601": "2025-01-06T17:25:57.915271Z",
"url": "https://files.pythonhosted.org/packages/d1/13/2b0d9270b744d477eb0b8decd8b151d1623e757798902981f73f5d013c74/harlequin_wherobots-0.6.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5ed755791a02bf19e7110e6831a88c4b04a4eaf2030d1c4a3a5b90180276bbe5",
"md5": "54996c6bd42a5d10b7201552e32e14fe",
"sha256": "eb5726ce3b3d23ad9029a19de519174f8de01b303ceec6240dadecb78f1ba1ab"
},
"downloads": -1,
"filename": "harlequin_wherobots-0.6.1.tar.gz",
"has_sig": false,
"md5_digest": "54996c6bd42a5d10b7201552e32e14fe",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 8185,
"upload_time": "2025-01-06T17:25:59",
"upload_time_iso_8601": "2025-01-06T17:25:59.156505Z",
"url": "https://files.pythonhosted.org/packages/5e/d7/55791a02bf19e7110e6831a88c4b04a4eaf2030d1c4a3a5b90180276bbe5/harlequin_wherobots-0.6.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-06 17:25:59",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "harlequin-wherobots"
}
