From e278a71a5d0008c66f3743e65faa21388a8af1b0 Mon Sep 17 00:00:00 2001 From: Chris Clark Date: Wed, 17 Apr 2024 10:05:12 -0400 Subject: [PATCH] 4.1b1 --- HISTORY.rst | 2 +- README.rst | 13 ++++++++++++- explorer/__init__.py | 2 +- pypi-release-checklist.md | 2 -- setup.py | 4 ++++ 5 files changed, 18 insertions(+), 5 deletions(-) diff --git a/HISTORY.rst b/HISTORY.rst index 444d7367..f63fb2d7 100644 --- a/HISTORY.rst +++ b/HISTORY.rst @@ -5,7 +5,7 @@ Change Log This document records all notable changes to `django-sql-explorer `_. This project adheres to `Semantic Versioning `_. -`4.1.0`_ (TBD) +`4.1.0b1`_ (2024-04-17) =========================== * SQL Assistant: Built in query help via OpenAI (or LLM of choice), with relevant schema automatically injected into the prompt. Enable via setting EXPLORER_AI_API_KEY. diff --git a/README.rst b/README.rst index 3d0e5dd9..4f3fa756 100644 --- a/README.rst +++ b/README.rst @@ -30,14 +30,21 @@ intelligence tool. It will happily connect to any SQL database that Quickly write and share SQL queries in a simple, usable SQL editor, view the results in the browser, and keep the information flowing! +Add an OpenAI (or other provider) API key and get an LLM-powered +SQL assistant that can help write and debug queries. The assistant +will automatically add relevant context and schema into the underlying +LLM prompt. + SQL Explorer values simplicity, intuitive use, unobtrusiveness, -stability, and the principle of least surprise. Sql Explorer is MIT +stability, and the principle of least surprise. The project is MIT licensed, and pull requests are welcome. Some key features include: - Support for multiple connections +- AI-powered SQL assistant - Quick access to schema information to make querying easier + (including autocomplete) - In-browser pivot tables (which can also be shared via URLs) - Ability to snapshot queries on a regular schedule, capturing changing data @@ -59,6 +66,10 @@ Screenshots .. image:: https://sql-explorer.s3.amazonaws.com/4.0-query-with-schema.png +**Using the SQL Assistant** + +.. image:: https://sql-explorer.s3.amazonaws.com/4.1-sql-assistant.png + **Viewing all queries** .. image:: https://sql-explorer.s3.amazonaws.com/4.0-query-list.png diff --git a/explorer/__init__.py b/explorer/__init__.py index ee38d1c5..2437dfe5 100644 --- a/explorer/__init__.py +++ b/explorer/__init__.py @@ -3,7 +3,7 @@ "minor": 1, "patch": 0, "releaselevel": "beta", - "serial": 0 + "serial": 1 } diff --git a/pypi-release-checklist.md b/pypi-release-checklist.md index 9ee8d968..9feee133 100644 --- a/pypi-release-checklist.md +++ b/pypi-release-checklist.md @@ -3,8 +3,6 @@ - [x] Make sure any new files are included in MANIFEST.in - [x] Update version number in `explorer/__init__.py` - [x] Update any package dependencies in `setup.py` -- [x] Run `nvm install` and `nvm use` -- [x] Run `npm install` and `npm run build` - [x] Commit the changes: ``` git add . diff --git a/setup.py b/setup.py index 58a72939..ce26e089 100644 --- a/setup.py +++ b/setup.py @@ -89,6 +89,10 @@ def read(fname): ], "xls": [ "xlsxwriter>=1.3.6" + ], + "assistant": [ + "openai>=1.6.1", + "tiktoken>=0.6" ] }, cmdclass={