Skip to main content

No project description provided

Project description

quak logo
quak /kwæk/

an anywidget for data that talks like a duck

quak is a scalable data profiler for quickly scanning large tables, capturing interactions as executable SQL queries.

  • interactive 🖱️ mouse over column summaries, cross-filter, sort, and slice rows.
  • fast ⚡ built with Mosaic; views are expressed as SQL queries lazily executed by DuckDB.
  • flexible 🔄 supports many data types and formats via Apache Arrow and the dataframe interchange protocol.
  • reproducible 📓 a UI for building complex SQL queries; materialize views in the kernel for further analysis.

install

[!WARNING] quak is a prototype exploring a high-performance data profiler based on anywidget. It is not production-ready. Expect bugs. Open-sourced for SciPy 2024.

pip install quak

usage

The easiest way to get started with quak is using the IPython cell magic.

%load_ext quak
import polars as pl

df = pl.read_parquet("https://github.com/uwdata/mosaic/raw/main/data/athletes.parquet")
df
olympic athletes table

quak hooks into Jupyter's display mechanism to automatically render any dataframe-like object (implementing the Python dataframe interchange protocol) using quak.Widget instead of the default display.

Alternatively, you can use quak.Widget directly:

import polars as pl
import quak

df = pl.read_parquet("https://github.com/uwdata/mosaic/raw/main/data/athletes.parquet")
widget = quak.Widget(df)
widget

interacting with the data

quak captures all user interactions as queries.

At any point, table state can be accessed as SQL,

widget.sql # SELECT * FROM df WHERE ...

which for convenience can be executed in the kernel to materialize the view for further analysis:

widget.data() # returns duckdb.DuckDBPyRelation object

By representing UI state as SQL, quak makes it easy to generate complex queries via interactions that would be challenging to write manually, while keeping them reproducible.

using quak in marimo

quak can also be used in marimo notebooks, which provide out-of-the-box support for anywidget:

import marimo as mo
import polars as pl
import quak

df = pl.read_parquet("https://github.com/uwdata/mosaic/raw/main/data/athletes.parquet")
widget = mo.ui.anywidget(quak.Widget(df))
widget

contributing

Contributors welcome! Check the Contributors Guide to get started. Note: I'm wrapping up my PhD, so I might be slow to respond. Please open an issue before contributing a new feature.

references

quak pieces together many important ideas from the web and Python data science ecosystems. It serves as an example of what you can achieve by embracing these platforms for their strengths.

  • Observable's data table: Inspiration for the UI design and user interactions.
  • Mosaic: The foundation for linking databases and interactive table views.
  • Apache Arrow: Support for various data types and efficient data interchange between JS/Python.
  • DuckDB: An amazingly engineered piece of software that makes SQL go vroom.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

quak-0.1.3.tar.gz (63.6 kB view details)

Uploaded Source

Built Distribution

quak-0.1.3-py2.py3-none-any.whl (64.5 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file quak-0.1.3.tar.gz.

File metadata

  • Download URL: quak-0.1.3.tar.gz
  • Upload date:
  • Size: 63.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for quak-0.1.3.tar.gz
Algorithm Hash digest
SHA256 384d070033b5cdb2634f8c9d1e8b77fc7ac93f49e1779c86d50ea3c53f089b59
MD5 67b81ee2a457ef6edc2f355eec65783d
BLAKE2b-256 5e9eb236497deabaa44574c1106f0594210bbb8df8f16320d75b40928c732c04

See more details on using hashes here.

File details

Details for the file quak-0.1.3-py2.py3-none-any.whl.

File metadata

  • Download URL: quak-0.1.3-py2.py3-none-any.whl
  • Upload date:
  • Size: 64.5 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for quak-0.1.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 eeb802f2c2d7c4fa8c712943ea1a21c2f0c385f7645d6ca215d8f291ba775f49
MD5 a128fc251f6fd1802d3bef99f0645610
BLAKE2b-256 02892c251fef0c375067fa9fa62e830e8575179535388e2a8da11ba255f784aa

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page