4.1b1

HISTORY.rst

@@ -5,7 +5,7 @@ Change Log
 This document records all notable changes to `django-sql-explorer <https://github.com/chrisclark/django-sql-explorer>`_.
 This project adheres to `Semantic Versioning <https://semver.org/>`_.
 
-`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.

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

explorer/__init__.py

@@ -3,7 +3,7 @@
     "minor": 1,
     "patch": 0,
     "releaselevel": "beta",
-    "serial": 0
+    "serial": 1
 }
 
 

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 .

setup.py

@@ -89,6 +89,10 @@ def read(fname):
         ],
         "xls": [
             "xlsxwriter>=1.3.6"
+        ],
+        "assistant": [
+            "openai>=1.6.1",
+            "tiktoken>=0.6"
         ]
     },
     cmdclass={