jl-db-comp 0.1.0__py3-none-any.whl

jl_db_comp-0.1.0.dist-info/METADATA

@@ -0,0 +1,440 @@
+Metadata-Version: 2.4
+Name: jl_db_comp
+Version: 0.1.0
+Summary: A JupyterLab extension to complete db queries in jupyterlab notebooks
+Project-URL: Homepage, https://github.com/Ben-Herz/jl_db_completer
+Project-URL: Bug Tracker, https://github.com/Ben-Herz/jl_db_completer/issues
+Project-URL: Repository, https://github.com/Ben-Herz/jl_db_completer.git
+Author-email: jl_db_completer <herzben@pm.me>
+License: BSD 3-Clause License
+        
+        Copyright (c) 2025, jl_db_completer
+        All rights reserved.
+        
+        Redistribution and use in source and binary forms, with or without
+        modification, are permitted provided that the following conditions are met:
+        
+        1. Redistributions of source code must retain the above copyright notice, this
+           list of conditions and the following disclaimer.
+        
+        2. Redistributions in binary form must reproduce the above copyright notice,
+           this list of conditions and the following disclaimer in the documentation
+           and/or other materials provided with the distribution.
+        
+        3. Neither the name of the copyright holder nor the names of its
+           contributors may be used to endorse or promote products derived from
+           this software without specific prior written permission.
+        
+        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+License-File: LICENSE
+Keywords: jupyter,jupyterlab,jupyterlab-extension
+Classifier: Framework :: Jupyter
+Classifier: Framework :: Jupyter :: JupyterLab
+Classifier: Framework :: Jupyter :: JupyterLab :: 4
+Classifier: Framework :: Jupyter :: JupyterLab :: Extensions
+Classifier: Framework :: Jupyter :: JupyterLab :: Extensions :: Prebuilt
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.10
+Requires-Dist: jupyter-server<3,>=2.4.0
+Requires-Dist: psycopg2-binary>=2.9.0
+Provides-Extra: dev
+Requires-Dist: jupyterlab>=4; extra == 'dev'
+Provides-Extra: test
+Requires-Dist: coverage; extra == 'test'
+Requires-Dist: pytest; extra == 'test'
+Requires-Dist: pytest-asyncio; extra == 'test'
+Requires-Dist: pytest-cov; extra == 'test'
+Requires-Dist: pytest-jupyter[server]>=0.6.0; extra == 'test'
+Description-Content-Type: text/markdown
+
+# jl_db_comp
+
+[![Github Actions Status](https://github.com/Ben-Herz/jl_db_completer/workflows/Build/badge.svg)](https://github.com/Ben-Herz/jl_db_completer/actions/workflows/build.yml)
+
+A JupyterLab extension that provides PostgreSQL table and column name autocompletion when typing SQL queries in notebooks and editors.
+
+## Features
+
+- **Smart SQL Detection**: Automatically activates when SQL keywords (SELECT, FROM, JOIN, etc.) are detected
+- **PostgreSQL Integration**: Queries table and column names from PostgreSQL databases
+- **Client-Side Caching**: 5-minute TTL cache to minimize database calls
+- **Configurable**: Database connection via environment variable or settings
+- **Schema Support**: Query specific database schemas (defaults to 'public')
+
+This extension is composed of a Python package named `jl_db_comp`
+for the server extension and a NPM package named `jl_db_comp`
+for the frontend extension.
+
+## Requirements
+
+- JupyterLab >= 4.0.0
+- PostgreSQL database
+- Python >= 3.10
+
+## Install
+
+To install the extension, execute:
+
+```bash
+pip install jl_db_comp
+```
+
+## Configuration
+
+### Database Connection
+
+There are two ways to configure your PostgreSQL database connection:
+
+#### Option 1: Environment Variable (Recommended)
+
+Set the `POSTGRES_URL` environment variable before starting JupyterLab:
+
+```bash
+export POSTGRES_URL="postgresql://user:password@localhost:5432/dbname"
+jupyter lab
+```
+
+#### Option 2: JupyterLab Settings
+
+1. Open JupyterLab Settings (Settings → Settings Editor)
+2. Search for "PostgreSQL Database Completer"
+3. Configure:
+   - **Database URL**: PostgreSQL connection string
+   - **Schema**: Database schema to query (default: 'public')
+   - **Enabled**: Toggle completions on/off
+
+### Connection String Format
+
+```
+postgresql://[user[:password]@][host][:port][/dbname]
+```
+
+**Examples:**
+
+```bash
+# Local database
+postgresql://postgres:example@localhost:5432/ehrexample
+
+# Remote database with SSL
+postgresql://user:pass@db.example.com:5432/mydb?sslmode=require
+```
+
+## Usage
+
+### Table Name Completion
+
+Type SQL and press **Tab** or **Ctrl+Space** to see table names:
+
+```sql
+SELECT * FROM pat<Tab>
+```
+
+**Completions will show:**
+
+- 📋 patients
+- 📋 patient_visits
+- 📋 patient_records
+
+### Column Name Completion (After Table Name)
+
+After typing a table name followed by a dot, you'll see **only the columns from that table**:
+
+```sql
+SELECT patients.<Tab>
+```
+
+**Completions will show columns from 'patients' table:**
+
+- 📊 patient_id (patients)
+- 📊 patient_name (patients)
+- 📊 date_of_birth (patients)
+
+```sql
+-- Works with table aliases too:
+SELECT p.<Tab>
+FROM patients p
+```
+
+**Completions will show columns from 'p' (if it's a known table)**
+
+### Smart Activation
+
+Autocomplete activates when SQL keywords are detected:
+
+- SELECT, FROM, JOIN, WHERE
+- INSERT, UPDATE, DELETE
+- GROUP BY, ORDER BY, etc.
+
+### Schema-Aware Completion
+
+Access tables and columns from different schemas:
+
+```sql
+-- List tables from a specific schema
+SELECT * FROM custom_schema.<Tab>
+```
+
+**Completions will show tables and views from 'custom_schema':**
+
+- 📋 users
+- 📋 products
+- 👁️ active_users (view)
+
+```sql
+-- Access columns from schema-qualified table
+SELECT custom_schema.users.<Tab>
+```
+
+**Completions will show columns from custom_schema.users:**
+
+- 📊 user_id (users)
+- 📊 username (users)
+- 📊 email (users)
+
+### JSONB Key Completion
+
+For JSONB columns, get autocomplete for JSON object keys after typing `->` or `->>`:
+
+```sql
+-- First-level JSONB keys
+SELECT metadata-><Tab>
+FROM patients
+```
+
+**Completions will show keys from the 'metadata' JSONB column:**
+
+- 🔑 allergies
+- 🔑 medications
+- 🔑 diagnosis
+
+```sql
+-- Nested JSONB keys
+SELECT metadata->>'diagnosis'-><Tab>
+FROM patients
+```
+
+**Completions will show nested keys under 'diagnosis':**
+
+- 🔑 code
+- 🔑 description
+- 🔑 date
+
+**How it works:**
+
+- Extension queries actual table data to extract unique JSONB keys
+- Supports nested paths (e.g., `column->>'key1'->>'key2'->`
+  )
+- Samples up to 1000 rows for performance
+- Works with table-qualified columns (e.g., `patients.metadata->`)
+
+### Complete Example
+
+```sql
+-- Step 1: Type table name and press Tab (default schema)
+SELECT * FROM pat<Tab>
+-- → Suggests: patients, patient_visits
+
+-- Step 2: After selecting "patients", type dot and press Tab
+SELECT patients.<Tab>
+-- → Shows columns: patient_id, patient_name, etc.
+
+-- Step 3: JSONB key completion
+SELECT patients.metadata-><Tab>
+-- → Shows JSONB keys: allergies, medications, diagnosis
+
+-- Step 4: Nested JSONB keys
+SELECT patients.metadata->>'diagnosis'-><Tab>
+-- → Shows nested keys: code, description, date
+
+-- Step 5: With different schemas
+SELECT
+    public.patients.<Tab>,
+    custom_schema.users.<Tab>
+FROM public.patients
+JOIN custom_schema.users ON patients.user_id = users.user_id
+-- → "public.patients." shows patient columns
+-- → "custom_schema.users." shows user columns
+
+-- Step 6: List tables from specific schema
+SELECT * FROM custom_schema.<Tab>
+-- → Shows tables and views from custom_schema
+```
+
+## Uninstall
+
+To remove the extension, execute:
+
+```bash
+pip uninstall jl_db_comp
+```
+
+## Troubleshoot
+
+If you are seeing the frontend extension, but it is not working, check
+that the server extension is enabled:
+
+```bash
+jupyter server extension list
+```
+
+If the server extension is installed and enabled, but you are not seeing
+the frontend extension, check the frontend extension is installed:
+
+```bash
+jupyter labextension list
+```
+
+## Contributing
+
+### Development install
+
+Note: You will need NodeJS to build the extension package.
+
+The `jlpm` command is JupyterLab's pinned version of
+[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
+`yarn` or `npm` in lieu of `jlpm` below.
+
+```bash
+# Clone the repo to your local environment
+# Change directory to the jl_db_comp directory
+
+# Set up a virtual environment and install package in development mode
+python -m venv .venv
+source .venv/bin/activate
+pip install --editable ".[dev,test]"
+
+# Link your development version of the extension with JupyterLab
+jupyter labextension develop . --overwrite
+# Server extension must be manually installed in develop mode
+jupyter server extension enable jl_db_comp
+
+# Rebuild extension Typescript source after making changes
+# IMPORTANT: Unlike the steps above which are performed only once, do this step
+# every time you make a change.
+jlpm build
+```
+
+You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.
+
+```bash
+# Watch the source directory in one terminal, automatically rebuilding when needed
+jlpm watch
+# Run JupyterLab in another terminal
+jupyter lab
+```
+
+With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).
+
+By default, the `jlpm build` command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:
+
+```bash
+jupyter lab build --minimize=False
+```
+
+### Development uninstall
+
+```bash
+# Server extension must be manually disabled in develop mode
+jupyter server extension disable jl_db_comp
+pip uninstall jl_db_comp
+```
+
+In development mode, you will also need to remove the symlink created by `jupyter labextension develop`
+command. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`
+folder is located. Then you can remove the symlink named `jl_db_comp` within that folder.
+
+### Testing the extension
+
+#### Server tests
+
+This extension is using [Pytest](https://docs.pytest.org/) for Python code testing.
+
+Install test dependencies (needed only once):
+
+```sh
+pip install -e ".[test]"
+# Each time you install the Python package, you need to restore the front-end extension link
+jupyter labextension develop . --overwrite
+```
+
+To execute them, run:
+
+```sh
+pytest -vv -r ap --cov jl_db_comp
+```
+
+#### Frontend tests
+
+This extension is using [Jest](https://jestjs.io/) for JavaScript code testing.
+
+To execute them, execute:
+
+```sh
+jlpm
+jlpm test
+```
+
+#### Integration tests
+
+This extension uses [Playwright](https://playwright.dev/docs/intro) for the integration tests (aka user level tests).
+More precisely, the JupyterLab helper [Galata](https://github.com/jupyterlab/jupyterlab/tree/master/galata) is used to handle testing the extension in JupyterLab.
+
+More information are provided within the [ui-tests](./ui-tests/README.md) README.
+
+## AI Coding Assistant Support
+
+This project includes an `AGENTS.md` file with coding standards and best practices for JupyterLab extension development. The file follows the [AGENTS.md standard](https://agents.md) for cross-tool compatibility.
+
+### Compatible AI Tools
+
+`AGENTS.md` works with AI coding assistants that support the standard, including Cursor, GitHub Copilot, Windsurf, Aider, and others. For a current list of compatible tools, see [the AGENTS.md standard](https://agents.md).
+This project also includes symlinks for tool-specific compatibility:
+
+- `CLAUDE.md` → `AGENTS.md` (for Claude Code)
+
+- `GEMINI.md` → `AGENTS.md` (for Gemini Code Assist)
+
+Other conventions you might encounter:
+
+- `.cursorrules` - Cursor's YAML/JSON format (Cursor also supports AGENTS.md natively)
+- `CONVENTIONS.md` / `CONTRIBUTING.md` - For CodeConventions.ai and GitHub bots
+- Project-specific rules in JetBrains AI Assistant settings
+
+All tool-specific files should be symlinks to `AGENTS.md` as the single source of truth.
+
+### What's Included
+
+The `AGENTS.md` file provides guidance on:
+
+- Code quality rules and file-scoped validation commands
+- Naming conventions for packages, plugins, and files
+- Coding standards (TypeScript, Python)
+- Development workflow and debugging
+- Backend-frontend integration patterns (`APIHandler`, `requestAPI()`, routing)
+- Common pitfalls and how to avoid them
+
+### Customization
+
+You can edit `AGENTS.md` to add project-specific conventions or adjust guidelines to match your team's practices. The file uses plain Markdown with Do/Don't patterns and references to actual project files.
+
+**Note**: `AGENTS.md` is living documentation. Update it when you change conventions, add dependencies, or discover new patterns. Include `AGENTS.md` updates in commits that modify workflows or coding standards.
+
+### Packaging the extension
+
+See [RELEASE](RELEASE.md)

jl_db_comp-0.1.0.dist-info/RECORD

@@ -0,0 +1,33 @@
+jl_db_comp/__init__.py,sha256=L_Vn61SO_SScZsd1--0ug5RN35CibN9SH-yHBpGXR7g,1102
+jl_db_comp/_version.py,sha256=ac3tgjoOzsODOlacRPCwz99LbZv0NK7ZYAaBWulFo7E,171
+jl_db_comp/routes.py,sha256=Pe-eOBSCBT6exEAMC39p41B80L29QT8nmFnta6jDmPM,11875
+jl_db_comp/labextension/build_log.json,sha256=9Fa7HddpMOiLtfcoYI5E_z5GVoepOZWn_vFhPoQ1Lvc,22866
+jl_db_comp/labextension/package.json,sha256=ilRPoMw03hLstG3ZZmsTSwqS7DtAqW5H7wJRW3-EAPI,6192
+jl_db_comp/labextension/schemas/jl_db_comp/package.json.orig,sha256=DkqDZXCT7xbUu43ld2SCIx_knACzO9Kg3-YTu1NMUO8,7048
+jl_db_comp/labextension/schemas/jl_db_comp/plugin.json,sha256=x5QwcUiPowlvRS2GmWX8ShVp_mSBpa8KzmOqXtUmwr0,883
+jl_db_comp/labextension/static/lib_index_js.a0969ed73da70f2cc451.js,sha256=jLdpa9d4NhvN4SkRSIW0RmHbb_10L5eBW2yV4jGHeyc,23033
+jl_db_comp/labextension/static/lib_index_js.a0969ed73da70f2cc451.js.map,sha256=llIygypU4AkI_EHcH31iWfVAFQgDu6_OXG_Cj0S1Lag,32091
+jl_db_comp/labextension/static/remoteEntry.5763ae02737e035e938c.js,sha256=Yr-FJ22zCsiTE2pmuouGd49UqUSNxePzFjNt5w1XB6M,27460
+jl_db_comp/labextension/static/remoteEntry.5763ae02737e035e938c.js.map,sha256=yfmN24Pf_NopFihOdiI4k8GuDKaPv9tKODh3SJ_RcQo,26210
+jl_db_comp/labextension/static/style.js,sha256=kHmCPOWdRY7r0Voabh7CMyxQJA6oPseEwKF6mcW--Zs,153
+jl_db_comp/labextension/static/style_index_js.5364c7419a6b9db5d727.js,sha256=igPCVhf4WBPKMw5Tj-kjKW4ErSnvcYO4rErGoJQUgl0,20179
+jl_db_comp/labextension/static/style_index_js.5364c7419a6b9db5d727.js.map,sha256=gzr0DMPk4dFovCxWekh8FGwioiYIB6VBvF95k0eaynk,15976
+jl_db_comp/tests/__init__.py,sha256=mdd3JucOpGsN8PiHaypFnGLdv2nemscFn0piCZc2fls,40
+jl_db_comp/tests/test_routes.py,sha256=eMw0eOa2vA2gjpJVNN_dYtuKXlowGOEkDqbBs_9j3BA,1753
+jl_db_comp-0.1.0.data/data/etc/jupyter/jupyter_server_config.d/jl_db_comp.json,sha256=fSmY5rlApxKaWIC5WmqvKJ2xW5lLmO_ybLJKogoJcq8,85
+jl_db_comp-0.1.0.data/data/share/jupyter/labextensions/jl_db_comp/build_log.json,sha256=9Fa7HddpMOiLtfcoYI5E_z5GVoepOZWn_vFhPoQ1Lvc,22866
+jl_db_comp-0.1.0.data/data/share/jupyter/labextensions/jl_db_comp/package.json,sha256=ilRPoMw03hLstG3ZZmsTSwqS7DtAqW5H7wJRW3-EAPI,6192
+jl_db_comp-0.1.0.data/data/share/jupyter/labextensions/jl_db_comp/schemas/jl_db_comp/package.json.orig,sha256=DkqDZXCT7xbUu43ld2SCIx_knACzO9Kg3-YTu1NMUO8,7048
+jl_db_comp-0.1.0.data/data/share/jupyter/labextensions/jl_db_comp/schemas/jl_db_comp/plugin.json,sha256=x5QwcUiPowlvRS2GmWX8ShVp_mSBpa8KzmOqXtUmwr0,883
+jl_db_comp-0.1.0.data/data/share/jupyter/labextensions/jl_db_comp/static/lib_index_js.a0969ed73da70f2cc451.js,sha256=jLdpa9d4NhvN4SkRSIW0RmHbb_10L5eBW2yV4jGHeyc,23033
+jl_db_comp-0.1.0.data/data/share/jupyter/labextensions/jl_db_comp/static/lib_index_js.a0969ed73da70f2cc451.js.map,sha256=llIygypU4AkI_EHcH31iWfVAFQgDu6_OXG_Cj0S1Lag,32091
+jl_db_comp-0.1.0.data/data/share/jupyter/labextensions/jl_db_comp/static/remoteEntry.5763ae02737e035e938c.js,sha256=Yr-FJ22zCsiTE2pmuouGd49UqUSNxePzFjNt5w1XB6M,27460
+jl_db_comp-0.1.0.data/data/share/jupyter/labextensions/jl_db_comp/static/remoteEntry.5763ae02737e035e938c.js.map,sha256=yfmN24Pf_NopFihOdiI4k8GuDKaPv9tKODh3SJ_RcQo,26210
+jl_db_comp-0.1.0.data/data/share/jupyter/labextensions/jl_db_comp/static/style.js,sha256=kHmCPOWdRY7r0Voabh7CMyxQJA6oPseEwKF6mcW--Zs,153
+jl_db_comp-0.1.0.data/data/share/jupyter/labextensions/jl_db_comp/static/style_index_js.5364c7419a6b9db5d727.js,sha256=igPCVhf4WBPKMw5Tj-kjKW4ErSnvcYO4rErGoJQUgl0,20179
+jl_db_comp-0.1.0.data/data/share/jupyter/labextensions/jl_db_comp/static/style_index_js.5364c7419a6b9db5d727.js.map,sha256=gzr0DMPk4dFovCxWekh8FGwioiYIB6VBvF95k0eaynk,15976
+jl_db_comp-0.1.0.data/data/share/jupyter/labextensions/jl_db_comp/install.json,sha256=AkhpkuSkRFqmwkttzIRdh8UApmBhvmiodyEPb9WylXc,181
+jl_db_comp-0.1.0.dist-info/METADATA,sha256=T456HSGlkCXZypfcl6sDIbZ3sWZPPO_psPo4XTiMNbk,14011
+jl_db_comp-0.1.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+jl_db_comp-0.1.0.dist-info/licenses/LICENSE,sha256=Oz0oICGKssavDqCu6-PnQedLBaqF1DaZvDyJsGCSIzE,1523
+jl_db_comp-0.1.0.dist-info/RECORD,,

jl_db_comp-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py3-none-any

jl_db_comp-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2025, jl_db_completer
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.