| Name | jupy-sqlite-extension JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | None |
| Summary | JupyterLab extension for SQLite execution based on cell metadata without magic |
| upload_time | 2025-08-25 03:37:29 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | MIT License
Copyright (c) 2025 Yiwei Chen
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE. |
| keywords |
jupyter
jupyterlab
jupyterlab-extension
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# jupy_sqlite_extension
JupyterLab extension for SQLite execution based on cell metadata without magic
This extension is composed of a Python package named `jupy_sqlite_extension`
for the server extension and a NPM package named `jupy-sqlite-extension`
for the frontend extension.
## Requirements
- JupyterLab >= 4.4.0
## Install
To install the extension, execute:
```bash
pip install jupy_sqlite_extension
```
## Uninstall
To remove the extension, execute:
```bash
pip uninstall jupy_sqlite_extension
```
## Usage
This extension allows you to execute SQLite queries directly in notebook cells without magic commands. To use it:
### 1. Set Cell Metadata
For any code cell where you want to run SQL, you need to add metadata:
```json
{
"sql_cell": true,
"db_file": "path/to/your/database.db"
}
```
The DB file path must be relative to the notebook's directory for security.
Alternatively, you can set the language metadata:
```json
{
"language": "sql",
"db_file": "path/to/your/database.db"
}
```
### 2. Write Your SQL Query
Write your SQL query in the cell:
```sql
SELECT * FROM customers LIMIT 10;
```
### 3. Execute the Cell
Run the cell (Shift+Enter) and the extension will:
- Execute your SQL query against the specified database
- Display results in a formatted ASCII table for SELECT queries
- Show row count information for INSERT/UPDATE/DELETE operations
- Display any error messages if the query fails
### Important Notes
- **Database file paths must be relative** to the notebook's directory for security
- The database file must exist before running queries
- Results are limited to 25 rows by default (with truncation notice if exceeded)
- Only SQLite databases are supported
## 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 jupy_sqlite_extension directory
# Install package in development mode
pip install -e ".[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 jupy_sqlite_extension
# Rebuild extension Typescript source after making changes
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 jupy_sqlite_extension
pip uninstall jupy_sqlite_extension
```
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 `jupy-sqlite-extension` 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 jupy_sqlite_extension
```
#### 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.
### Packaging the extension
See [RELEASE](RELEASE.md)
Raw data
{
"_id": null,
"home_page": null,
"name": "jupy-sqlite-extension",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "jupyter, jupyterlab, jupyterlab-extension",
"author": null,
"author_email": "Yiwei Chen <yiwei@deeplearning.ai>",
"download_url": "https://files.pythonhosted.org/packages/27/52/cd11613211e0b0ecc16d0a57e9ce07eb43331f6ca73fb4bfc301d445c1cc/jupy_sqlite_extension-0.1.1.tar.gz",
"platform": null,
"description": "# jupy_sqlite_extension\n\nJupyterLab extension for SQLite execution based on cell metadata without magic\n\nThis extension is composed of a Python package named `jupy_sqlite_extension`\nfor the server extension and a NPM package named `jupy-sqlite-extension`\nfor the frontend extension.\n\n## Requirements\n\n- JupyterLab >= 4.4.0\n\n## Install\n\nTo install the extension, execute:\n\n```bash\npip install jupy_sqlite_extension\n```\n\n## Uninstall\n\nTo remove the extension, execute:\n\n```bash\npip uninstall jupy_sqlite_extension\n```\n\n## Usage\n\nThis extension allows you to execute SQLite queries directly in notebook cells without magic commands. To use it:\n\n### 1. Set Cell Metadata\n\nFor any code cell where you want to run SQL, you need to add metadata:\n\n```json\n{\n \"sql_cell\": true,\n \"db_file\": \"path/to/your/database.db\"\n}\n```\n\nThe DB file path must be relative to the notebook's directory for security.\n\nAlternatively, you can set the language metadata:\n\n```json\n{\n \"language\": \"sql\",\n \"db_file\": \"path/to/your/database.db\"\n}\n```\n\n### 2. Write Your SQL Query\n\nWrite your SQL query in the cell:\n\n```sql\nSELECT * FROM customers LIMIT 10;\n```\n\n### 3. Execute the Cell\n\nRun the cell (Shift+Enter) and the extension will:\n- Execute your SQL query against the specified database\n- Display results in a formatted ASCII table for SELECT queries\n- Show row count information for INSERT/UPDATE/DELETE operations\n- Display any error messages if the query fails\n\n### Important Notes\n\n- **Database file paths must be relative** to the notebook's directory for security\n- The database file must exist before running queries\n- Results are limited to 25 rows by default (with truncation notice if exceeded)\n- Only SQLite databases are supported\n\n## Troubleshoot\n\nIf you are seeing the frontend extension, but it is not working, check\nthat the server extension is enabled:\n\n```bash\njupyter server extension list\n```\n\nIf the server extension is installed and enabled, but you are not seeing\nthe frontend extension, check the frontend extension is installed:\n\n```bash\njupyter labextension list\n```\n\n## Contributing\n\n### Development install\n\nNote: You will need NodeJS to build the extension package.\n\nThe `jlpm` command is JupyterLab's pinned version of\n[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use\n`yarn` or `npm` in lieu of `jlpm` below.\n\n```bash\n# Clone the repo to your local environment\n# Change directory to the jupy_sqlite_extension directory\n# Install package in development mode\npip install -e \".[test]\"\n# Link your development version of the extension with JupyterLab\njupyter labextension develop . --overwrite\n# Server extension must be manually installed in develop mode\njupyter server extension enable jupy_sqlite_extension\n# Rebuild extension Typescript source after making changes\njlpm build\n```\n\nYou 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.\n\n```bash\n# Watch the source directory in one terminal, automatically rebuilding when needed\njlpm watch\n# Run JupyterLab in another terminal\njupyter lab\n```\n\nWith 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).\n\nBy 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:\n\n```bash\njupyter lab build --minimize=False\n```\n\n### Development uninstall\n\n```bash\n# Server extension must be manually disabled in develop mode\njupyter server extension disable jupy_sqlite_extension\npip uninstall jupy_sqlite_extension\n```\n\nIn development mode, you will also need to remove the symlink created by `jupyter labextension develop`\ncommand. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`\nfolder is located. Then you can remove the symlink named `jupy-sqlite-extension` within that folder.\n\n### Testing the extension\n\n#### Server tests\n\nThis extension is using [Pytest](https://docs.pytest.org/) for Python code testing.\n\nInstall test dependencies (needed only once):\n\n```sh\npip install -e \".[test]\"\n# Each time you install the Python package, you need to restore the front-end extension link\njupyter labextension develop . --overwrite\n```\n\nTo execute them, run:\n\n```sh\npytest -vv -r ap --cov jupy_sqlite_extension\n```\n\n#### Frontend tests\n\nThis extension is using [Jest](https://jestjs.io/) for JavaScript code testing.\n\nTo execute them, execute:\n\n```sh\njlpm\njlpm test\n```\n\n#### Integration tests\n\nThis extension uses [Playwright](https://playwright.dev/docs/intro) for the integration tests (aka user level tests).\nMore precisely, the JupyterLab helper [Galata](https://github.com/jupyterlab/jupyterlab/tree/master/galata) is used to handle testing the extension in JupyterLab.\n\nMore information are provided within the [ui-tests](./ui-tests/README.md) README.\n\n### Packaging the extension\n\nSee [RELEASE](RELEASE.md)\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2025 Yiwei Chen\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.",
"summary": "JupyterLab extension for SQLite execution based on cell metadata without magic",
"version": "0.1.1",
"project_urls": {
"Homepage": "https://pypi.org/project/jupy-sqlite-extension/"
},
"split_keywords": [
"jupyter",
" jupyterlab",
" jupyterlab-extension"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "7b15209dcba064cc31bbf15ffa0c76075594c222fa6daec36675b16502613546",
"md5": "e14c999f732f68424e7b2e21c0bcf120",
"sha256": "fdad1ec92aca399cf5282d45ad2d98f82a59adabbd2db9bca7bc4005ab0a35c6"
},
"downloads": -1,
"filename": "jupy_sqlite_extension-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e14c999f732f68424e7b2e21c0bcf120",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 73820,
"upload_time": "2025-08-25T03:37:27",
"upload_time_iso_8601": "2025-08-25T03:37:27.770568Z",
"url": "https://files.pythonhosted.org/packages/7b/15/209dcba064cc31bbf15ffa0c76075594c222fa6daec36675b16502613546/jupy_sqlite_extension-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "2752cd11613211e0b0ecc16d0a57e9ce07eb43331f6ca73fb4bfc301d445c1cc",
"md5": "934fcab5a3e0dc764f5ee89d49261c14",
"sha256": "e3e6b500599075c6728c0218147df537a50a92e5777d96bef1a476e7a6253d8b"
},
"downloads": -1,
"filename": "jupy_sqlite_extension-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "934fcab5a3e0dc764f5ee89d49261c14",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 150780,
"upload_time": "2025-08-25T03:37:29",
"upload_time_iso_8601": "2025-08-25T03:37:29.801017Z",
"url": "https://files.pythonhosted.org/packages/27/52/cd11613211e0b0ecc16d0a57e9ce07eb43331f6ca73fb4bfc301d445c1cc/jupy_sqlite_extension-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-25 03:37:29",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "jupy-sqlite-extension"
}
