Name | datasette-query-assistant JSON |
Version |
0.1a2
JSON |
| download |
home_page | None |
Summary | Query databases and tables with AI assistance |
upload_time | 2024-04-16 20:54:34 |
maintainer | None |
docs_url | None |
author | Simon Willison |
requires_python | >=3.8 |
license | Apache-2.0 |
keywords |
|
VCS |
|
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
# datasette-query-assistant
[![PyPI](https://img.shields.io/pypi/v/datasette-query-assistant.svg)](https://pypi.org/project/datasette-query-assistant/)
[![Changelog](https://img.shields.io/github/v/release/datasette/datasette-query-assistant?include_prereleases&label=changelog)](https://github.com/datasette/datasette-query-assistant/releases)
[![Tests](https://github.com/datasette/datasette-query-assistant/actions/workflows/test.yml/badge.svg)](https://github.com/datasette/datasette-query-assistant/actions/workflows/test.yml)
[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/datasette/datasette-query-assistant/blob/main/LICENSE)
Query databases and tables with AI assistance
**Early alpha**.
## Installation
Install this plugin in the same environment as Datasette.
```bash
datasette install datasette-query-assistant
```
## Configuration
This plugin currently requires you to set the `ANTHROPIC_API_KEY` environment variable to a working [Anthropic API key](https://console.anthropic.com/account/keys).
## Usage
Users with `execute-sql` permission will gain a database action menu item for "Query this database with AI assistance" which will let them ask a question and be redirected to SQL that will hopefully answer it.
## Development
To set up this plugin locally, first checkout the code. Then create a new virtual environment:
```bash
cd datasette-query-assistant
python3 -m venv venv
source venv/bin/activate
```
Now install the dependencies and test dependencies:
```bash
pip install -e '.[test]'
```
To run the tests:
```bash
pytest
```
To re-generate the tests with refreshed examples from the Claude 3 API:
```bash
pytest -x --record-mode=rewrite --inline-snapshot=fix
```
Raw data
{
"_id": null,
"home_page": null,
"name": "datasette-query-assistant",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Simon Willison",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/d2/68/b34e3cabf3260c7da7d33bce79806ee333310562b9dc1718e7ce8a536325/datasette_query_assistant-0.1a2.tar.gz",
"platform": null,
"description": "# datasette-query-assistant\n\n[![PyPI](https://img.shields.io/pypi/v/datasette-query-assistant.svg)](https://pypi.org/project/datasette-query-assistant/)\n[![Changelog](https://img.shields.io/github/v/release/datasette/datasette-query-assistant?include_prereleases&label=changelog)](https://github.com/datasette/datasette-query-assistant/releases)\n[![Tests](https://github.com/datasette/datasette-query-assistant/actions/workflows/test.yml/badge.svg)](https://github.com/datasette/datasette-query-assistant/actions/workflows/test.yml)\n[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/datasette/datasette-query-assistant/blob/main/LICENSE)\n\nQuery databases and tables with AI assistance\n\n**Early alpha**.\n\n## Installation\n\nInstall this plugin in the same environment as Datasette.\n```bash\ndatasette install datasette-query-assistant\n```\n\n## Configuration\n\nThis plugin currently requires you to set the `ANTHROPIC_API_KEY` environment variable to a working [Anthropic API key](https://console.anthropic.com/account/keys).\n\n## Usage\n\nUsers with `execute-sql` permission will gain a database action menu item for \"Query this database with AI assistance\" which will let them ask a question and be redirected to SQL that will hopefully answer it.\n\n## Development\n\nTo set up this plugin locally, first checkout the code. Then create a new virtual environment:\n```bash\ncd datasette-query-assistant\npython3 -m venv venv\nsource venv/bin/activate\n```\nNow install the dependencies and test dependencies:\n```bash\npip install -e '.[test]'\n```\nTo run the tests:\n```bash\npytest\n```\nTo re-generate the tests with refreshed examples from the Claude 3 API:\n```bash\npytest -x --record-mode=rewrite --inline-snapshot=fix\n```\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Query databases and tables with AI assistance",
"version": "0.1a2",
"project_urls": {
"CI": "https://github.com/datasette/datasette-query-assistant/actions",
"Changelog": "https://github.com/datasette/datasette-query-assistant/releases",
"Homepage": "https://github.com/datasette/datasette-query-assistant",
"Issues": "https://github.com/datasette/datasette-query-assistant/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a43c0da9303793c8def306e9e34277161637957f1617f736488aac1c60fcdd1c",
"md5": "6f9462e0b85fd87d74595c6ece567e5d",
"sha256": "e9556cd6a649561caaf03464297bb1a5dbb9ec838e35083343609fe1b2325c89"
},
"downloads": -1,
"filename": "datasette_query_assistant-0.1a2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6f9462e0b85fd87d74595c6ece567e5d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 9911,
"upload_time": "2024-04-16T20:54:32",
"upload_time_iso_8601": "2024-04-16T20:54:32.716225Z",
"url": "https://files.pythonhosted.org/packages/a4/3c/0da9303793c8def306e9e34277161637957f1617f736488aac1c60fcdd1c/datasette_query_assistant-0.1a2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d268b34e3cabf3260c7da7d33bce79806ee333310562b9dc1718e7ce8a536325",
"md5": "81118c376cb3d7f284da73e88bf3ab7b",
"sha256": "0072d1c3e048443c48a8e0d9a1c33d71581530831c34f4a8c9d04f0da3a30808"
},
"downloads": -1,
"filename": "datasette_query_assistant-0.1a2.tar.gz",
"has_sig": false,
"md5_digest": "81118c376cb3d7f284da73e88bf3ab7b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 9894,
"upload_time": "2024-04-16T20:54:34",
"upload_time_iso_8601": "2024-04-16T20:54:34.794880Z",
"url": "https://files.pythonhosted.org/packages/d2/68/b34e3cabf3260c7da7d33bce79806ee333310562b9dc1718e7ce8a536325/datasette_query_assistant-0.1a2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-16 20:54:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "datasette",
"github_project": "datasette-query-assistant",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "datasette-query-assistant"
}