datasette-agent 0.1a0__tar.gz

datasette_agent-0.1a0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

datasette_agent-0.1a0/PKG-INFO

@@ -0,0 +1,220 @@
+Metadata-Version: 2.4
+Name: datasette-agent
+Version: 0.1a0
+Summary: An LLM-powered agent assistant for Datasette
+Author: Simon Willison
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/datasette/datasette-agent
+Project-URL: Changelog, https://github.com/datasette/datasette-agent/releases
+Project-URL: Issues, https://github.com/datasette/datasette-agent/issues
+Project-URL: CI, https://github.com/datasette/datasette-agent/actions
+Classifier: Framework :: Datasette
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: datasette>=1.0a28
+Requires-Dist: datasette-llm>=0.1a7
+Requires-Dist: llm>=0.32a2
+Requires-Dist: python-ulid
+Dynamic: license-file
+
+# datasette-agent
+
+[![PyPI](https://img.shields.io/pypi/v/datasette-agent.svg)](https://pypi.org/project/datasette-agent/)
+[![Changelog](https://img.shields.io/github/v/release/datasette/datasette-agent?include_prereleases&label=changelog)](https://github.com/datasette/datasette-agent/releases)
+[![Tests](https://github.com/datasette/datasette-agent/actions/workflows/test.yml/badge.svg)](https://github.com/datasette/datasette-agent/actions/workflows/test.yml)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/datasette/datasette-agent/blob/main/LICENSE)
+
+An LLM-powered agent assistant for Datasette
+
+## Installation
+
+Install this plugin in the same environment as Datasette.
+```bash
+datasette install datasette-agent
+```
+## Usage
+
+Visit `/-/agent` to start a conversation with the chat assistant.
+
+The agent uses [datasette-llm](https://github.com/datasette/datasette-llm) to call language models. Configure a default model for it before visiting `/-/agent`, for example in `datasette.yml`:
+
+```yaml
+plugins:
+  datasette-llm:
+    default_model: gpt-5.4-mini
+```
+
+The "Explore with AI agent" entries that appear in the database and table action menus launch a background agent that explores the selected database or table and writes a report. Reports live under `/-/agent/explore/`.
+
+Visit `/-/agent/background` to launch background agents directly. Each one is given a goal and runs toward it without further input. The listing includes a Stop button for cancelling agents that are still running.
+
+### Permissions
+
+This plugin registers two independent permissions:
+
+- `datasette-agent` — required to use the chat assistant under `/-/agent`.
+- `datasette-agent-explore` — required to see the "Explore with AI agent" entries in the database/table action menus and to use the explorer routes under `/-/agent/explore/`.
+
+The two permissions are independent: an actor may hold one without the other. The `--root` user has both.
+
+## Registering additional tools from plugins
+
+Other Datasette plugins can register additional tools for the agent using the `register_agent_tools` plugin hook.
+
+### Defining a tool
+
+Create a Datasette plugin that implements the `register_agent_tools` hook, returning a list of `AgentTool` instances:
+
+```python
+from datasette import hookimpl
+from datasette_agent.tools import AgentTool
+
+
+@hookimpl
+def register_agent_tools(datasette):
+    return [
+        AgentTool(
+            name="my_tool",
+            description="Description of what this tool does, used by the LLM to decide when to call it.",
+            input_schema={
+                "type": "object",
+                "properties": {
+                    "query": {
+                        "type": "string",
+                        "description": "The query to run",
+                    },
+                    "style": {
+                        "type": "string",
+                        "enum": ["brief", "detailed"],
+                        "description": "Output style",
+                    },
+                },
+                "required": ["query"],
+            },
+            fn=my_tool_handler,
+        ),
+    ]
+```
+
+### Tool handler function
+
+Each tool's `fn` must be an async function that accepts `datasette` and `actor` as keyword arguments, plus any parameters defined in `input_schema`. It must return a JSON string:
+
+```python
+import json
+
+
+async def my_tool_handler(datasette, actor, query, style=None):
+    # Do work here...
+    return json.dumps({
+        "result": "Tool output that the LLM will see",
+    })
+```
+
+To render rich HTML inline in the chat UI, include an `_html` key in the returned JSON. Any top-level key whose name starts with `_` is removed before the tool result is sent to the LLM, so the HTML is shown to the user but not passed back to the model:
+
+```python
+return json.dumps({
+    "_html": '<div class="my-widget">Rich content here</div>',
+    "summary": "Widget rendered successfully",
+})
+```
+
+## Rendering custom HTML from tools
+
+Tool plugins can render rich HTML inline in the chat UI by returning a JSON object with an `_html` key. The HTML is rendered directly in the conversation. The remaining keys are returned to the LLM as the tool result, with any key whose name starts with `_` removed first.
+
+Example tool implementation:
+
+```python
+import json
+
+async def _render_widget(datasette, actor, database, sql):
+    html = (
+        '<script src="/-/static-plugins/my-plugin/widget.js" type="module"></script>\n'
+        '<my-widget>\n'
+        f'<script type="application/json">{json.dumps({"database": database, "sql": sql})}</script>\n'
+        '</my-widget>'
+    )
+    return json.dumps({
+        "_html": html,
+        "database": database,
+        "sql": sql,
+        "summary": "Widget rendered successfully",
+    })
+```
+
+The `_html` value is inserted into the chat as raw HTML, so it can include custom elements, scripts, and styles. The other keys (`database`, `sql`, and `summary` in this example) are what the LLM receives as the tool result.
+
+### Example plugins
+
+- [datasette-agent-charts](https://github.com/datasette/datasette-agent-charts) - renders charts from SQL query results using Observable Plot
+- [datasette-agent-openai-imagegen](https://github.com/datasette/datasette-agent-openai-imagegen) - generates images using OpenAI's image generation API
+
+## CLI commands
+
+### Interactive chat
+
+Start an interactive chat session with the agent from the command line:
+
+```bash
+datasette agent chat mydata.db
+```
+
+You can pass multiple database files, use `:memory:` for an in-memory database, specify a model, or send a single prompt:
+
+```bash
+datasette agent chat mydata.db -m gpt-5.4-mini
+datasette agent chat mydata.db -m gpt-5.4-mini -p "List all tables"
+```
+
+Options:
+
+- `-p`, `--prompt` — Send a single prompt and exit (non-interactive mode)
+- `-m`, `--model` — LLM model to use
+
+### Listing available tools
+
+To see all registered agent tools, grouped by plugin:
+
+```bash
+datasette agent tools
+```
+
+Output:
+
+```
+agent:
+  list_databases_and_tables
+    List all available databases and their tables
+  describe_table
+    Get column names, types, and foreign keys for a table
+  sql_query
+    Execute a read-only SQL query against a database
+```
+
+Add `--json` for machine-readable output:
+
+```bash
+datasette agent tools --json
+```
+
+## Development
+
+To set up this plugin locally, first checkout the code. Run the tests like this:
+```bash
+cd datasette-agent
+uv run pytest
+```
+To run the development server with a persistent internal database and GPT-5.5 as the model:
+```bash
+uv run datasette --internal internal.db \
+  --root --secret 1 \
+  -s plugins.datasette-llm.default_model gpt-5.5
+```
+Add extra database files to that command to enable the agent to query them.
+
+## Credits
+
+This plugin vendors [streaming-markdown](https://github.com/thetarnav/streaming-markdown) by Damian Tarnawski, MIT licensed.

datasette_agent-0.1a0/README.md

@@ -0,0 +1,200 @@
+# datasette-agent
+
+[![PyPI](https://img.shields.io/pypi/v/datasette-agent.svg)](https://pypi.org/project/datasette-agent/)
+[![Changelog](https://img.shields.io/github/v/release/datasette/datasette-agent?include_prereleases&label=changelog)](https://github.com/datasette/datasette-agent/releases)
+[![Tests](https://github.com/datasette/datasette-agent/actions/workflows/test.yml/badge.svg)](https://github.com/datasette/datasette-agent/actions/workflows/test.yml)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/datasette/datasette-agent/blob/main/LICENSE)
+
+An LLM-powered agent assistant for Datasette
+
+## Installation
+
+Install this plugin in the same environment as Datasette.
+```bash
+datasette install datasette-agent
+```
+## Usage
+
+Visit `/-/agent` to start a conversation with the chat assistant.
+
+The agent uses [datasette-llm](https://github.com/datasette/datasette-llm) to call language models. Configure a default model for it before visiting `/-/agent`, for example in `datasette.yml`:
+
+```yaml
+plugins:
+  datasette-llm:
+    default_model: gpt-5.4-mini
+```
+
+The "Explore with AI agent" entries that appear in the database and table action menus launch a background agent that explores the selected database or table and writes a report. Reports live under `/-/agent/explore/`.
+
+Visit `/-/agent/background` to launch background agents directly. Each one is given a goal and runs toward it without further input. The listing includes a Stop button for cancelling agents that are still running.
+
+### Permissions
+
+This plugin registers two independent permissions:
+
+- `datasette-agent` — required to use the chat assistant under `/-/agent`.
+- `datasette-agent-explore` — required to see the "Explore with AI agent" entries in the database/table action menus and to use the explorer routes under `/-/agent/explore/`.
+
+The two permissions are independent: an actor may hold one without the other. The `--root` user has both.
+
+## Registering additional tools from plugins
+
+Other Datasette plugins can register additional tools for the agent using the `register_agent_tools` plugin hook.
+
+### Defining a tool
+
+Create a Datasette plugin that implements the `register_agent_tools` hook, returning a list of `AgentTool` instances:
+
+```python
+from datasette import hookimpl
+from datasette_agent.tools import AgentTool
+
+
+@hookimpl
+def register_agent_tools(datasette):
+    return [
+        AgentTool(
+            name="my_tool",
+            description="Description of what this tool does, used by the LLM to decide when to call it.",
+            input_schema={
+                "type": "object",
+                "properties": {
+                    "query": {
+                        "type": "string",
+                        "description": "The query to run",
+                    },
+                    "style": {
+                        "type": "string",
+                        "enum": ["brief", "detailed"],
+                        "description": "Output style",
+                    },
+                },
+                "required": ["query"],
+            },
+            fn=my_tool_handler,
+        ),
+    ]
+```
+
+### Tool handler function
+
+Each tool's `fn` must be an async function that accepts `datasette` and `actor` as keyword arguments, plus any parameters defined in `input_schema`. It must return a JSON string:
+
+```python
+import json
+
+
+async def my_tool_handler(datasette, actor, query, style=None):
+    # Do work here...
+    return json.dumps({
+        "result": "Tool output that the LLM will see",
+    })
+```
+
+To render rich HTML inline in the chat UI, include an `_html` key in the returned JSON. Any top-level key whose name starts with `_` is removed before the tool result is sent to the LLM, so the HTML is shown to the user but not passed back to the model:
+
+```python
+return json.dumps({
+    "_html": '<div class="my-widget">Rich content here</div>',
+    "summary": "Widget rendered successfully",
+})
+```
+
+## Rendering custom HTML from tools
+
+Tool plugins can render rich HTML inline in the chat UI by returning a JSON object with an `_html` key. The HTML is rendered directly in the conversation. The remaining keys are returned to the LLM as the tool result, with any key whose name starts with `_` removed first.
+
+Example tool implementation:
+
+```python
+import json
+
+async def _render_widget(datasette, actor, database, sql):
+    html = (
+        '<script src="/-/static-plugins/my-plugin/widget.js" type="module"></script>\n'
+        '<my-widget>\n'
+        f'<script type="application/json">{json.dumps({"database": database, "sql": sql})}</script>\n'
+        '</my-widget>'
+    )
+    return json.dumps({
+        "_html": html,
+        "database": database,
+        "sql": sql,
+        "summary": "Widget rendered successfully",
+    })
+```
+
+The `_html` value is inserted into the chat as raw HTML, so it can include custom elements, scripts, and styles. The other keys (`database`, `sql`, and `summary` in this example) are what the LLM receives as the tool result.
+
+### Example plugins
+
+- [datasette-agent-charts](https://github.com/datasette/datasette-agent-charts) - renders charts from SQL query results using Observable Plot
+- [datasette-agent-openai-imagegen](https://github.com/datasette/datasette-agent-openai-imagegen) - generates images using OpenAI's image generation API
+
+## CLI commands
+
+### Interactive chat
+
+Start an interactive chat session with the agent from the command line:
+
+```bash
+datasette agent chat mydata.db
+```
+
+You can pass multiple database files, use `:memory:` for an in-memory database, specify a model, or send a single prompt:
+
+```bash
+datasette agent chat mydata.db -m gpt-5.4-mini
+datasette agent chat mydata.db -m gpt-5.4-mini -p "List all tables"
+```
+
+Options:
+
+- `-p`, `--prompt` — Send a single prompt and exit (non-interactive mode)
+- `-m`, `--model` — LLM model to use
+
+### Listing available tools
+
+To see all registered agent tools, grouped by plugin:
+
+```bash
+datasette agent tools
+```
+
+Output:
+
+```
+agent:
+  list_databases_and_tables
+    List all available databases and their tables
+  describe_table
+    Get column names, types, and foreign keys for a table
+  sql_query
+    Execute a read-only SQL query against a database
+```
+
+Add `--json` for machine-readable output:
+
+```bash
+datasette agent tools --json
+```
+
+## Development
+
+To set up this plugin locally, first checkout the code. Run the tests like this:
+```bash
+cd datasette-agent
+uv run pytest
+```
+To run the development server with a persistent internal database and GPT-5.5 as the model:
+```bash
+uv run datasette --internal internal.db \
+  --root --secret 1 \
+  -s plugins.datasette-llm.default_model gpt-5.5
+```
+Add extra database files to that command to enable the agent to query them.
+
+## Credits
+
+This plugin vendors [streaming-markdown](https://github.com/thetarnav/streaming-markdown) by Damian Tarnawski, MIT licensed.