jupyterlite / xeus-sqlite-kernel Goto Github PK

A SQLite kernel for JupyterLite, powered by Xeus

License: BSD 3-Clause "New" or "Revised" License

JavaScript 8.38% Dockerfile 34.35% Shell 1.19% Python 19.92% TypeScript 33.00% CSS 3.16%

xeus-sqlite-kernel's Introduction

JupyterLite

JupyterLite is a JupyterLab distribution that runs entirely in the browser built from the ground-up using JupyterLab components and extensions.

⚡ Status ⚡

Although JupyterLite is currently being developed by core Jupyter developers, the project is still unofficial.

Not all the usual features available in JupyterLab and the Classic Notebook will work with JupyterLite, but many already do!

Don't hesitate to check out the documentation for more information and project updates.

✨ Try it in your browser ✨

JupyterLite works with both JupyterLab and Jupyter Notebook.

Try it with JupyterLab!	Try it with Jupyter Notebook!

🏗️ Build your own JupyterLite 🏗️

You can build your own JupyterLite website in a couple of minutes, with custom extensions and packages.

See the documentation for more details.

Browser-based Interactive Computing

JupyterLite is all about accessible browser-based interactive computing:

Python kernel backed by Pyodide running in a Web Worker
- Initial support for interactive visualization libraries such as altair, bqplot, ipywidgets, matplotlib, and plotly
JavaScript kernel running in a Web Worker
View hosted example Notebooks and other files, then edit, save, and download from the browser's IndexDB (or localStorage)
Support for saving settings for JupyterLab/Lite core and federated extensions
Basic session and kernel management to have multiple kernels running at the same time
Support for Code Consoles

Ease of Deployment

Served via well-cacheable, static HTTP(S), locally or on most static web hosts
Embeddable within larger applications
Requires no dedicated application server much less a container orchestrator
Fine-grained configurability of page settings, including reuse of federated extensions

Showcase

Jupyter Interactive Widgets

JupyterLab Mimerender Extensions

Matplotlib Figures

Altair

Plotly

Development install

See the contributing guide for a development installation.

JupyterLite is a reboot of several attempts at making a full static Jupyter distribution that runs in the browser, without having to start the Python Jupyter Server on the host machine.

The goal is to provide a lightweight computing environment accessible in a matter of seconds with a single click, in a web browser and without having to install anything.

This project is a collection of packages that can be remixed together in variety of ways to create new applications and distributions. Most of the packages in this repo focus on providing server-like components that run in the browser (to manage kernels, files and settings), so existing JupyterLab extensions and plugins can be reused out of the box.

👥 Contributors

Join our community and become a contributor today! 🚀

xeus-sqlite-kernel's People

Contributors

Stargazers

Watchers

xeus-sqlite-kernel's Issues

RuntimeError: Aborted(Assertion failed: sz < N && "setting a small size"

Description

Opening a notebook with the jupyterlite-xeus-sqlite kernel gives the following error in the console:

RuntimeError: Aborted(Assertion failed: sz < N && "setting a small size", at: /install/include/xtl/xbasic_fixed_string.hpp,109,set_size). Build with -s ASSERTIONS=1 for more info.

Reproduce

Use jupyterlite-xeus-sqlite==0.2.0 in a JupyterLite deployment.

sqlite-0-2-0.mp4

Expected behavior

The kernel should start without error.

Context

Noticed when updating to jupyterlite-sqlite for the Try Jupyter deployment: jupyter/try-jupyter#10

cc @SylvainCorlay @DerThorsten if you can have a look, thanks!

Add a static demo with per-PR review

Problem

There's no place to try out this kernel yet.

Aside from off main, as new features are added, it would be nice to have something that reviewers can try out.

Suggested Improvement

add a dev-focused binder with jupyter-server-proxy
get set up for readthedocs (doesn't even require the mamb flag anymore to get a self-consistent environment)

vega is built in a static and non-static way.

vega is built in a static and non-static way. This doubles the compile times and only the static version is needed

Loading SQLite databases from a remote URL

The jupyterlite/xeus-sqlite-kernel currently seems to require users to create a database as part of a script before they can query it, rather than connect to a sqlite file shipped as part of a JuptyerLite distribution or uploaded to it, or connect to a remote database file.

The phiresky/sql.js-httpvfs Javascript package wraps a SQLite emscripten distribution and also provides a virtual filesystem that allows the SQLite database to access very large remote SQLite databases (if configured appropriately) in an efficient way.

I wonder if this approach could be used to support remote connections from the xeus-sqlite-kernel? Users could then use a simple web server to publish both the JupyterLite environment, and even a large database, and then query the database efficiently from their browser?

The SQLime browser based SQlite playground (nalgeon/sqlime) also offers some interesting "web integrations", as described on its About SQLime page. For example, SQL files can be hosted Github gists, the gist id passed via a URL parameter to SQLime, then loaded and run by the playground when the page is loaded. (Databases files can also be uploaded from the desktop to the playground environment.)

The Basthon in-browser notebook [repo] & SQLite kernel loads a database from a file path specified via a URL parameter:

(I also note here examples of using custom javascript functions to create custom sqlite functions.)