Metadata-Version: 2.4
Name: buckaroo
Version: 0.14.1
Summary: Buckaroo - GUI Data wrangling for pandas
Project-URL: Homepage, https://github.com/paddymul/buckaroo
Author: Paddy Mullen
License: Copyright (c) 2019 Bloomberg
        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.txt
Keywords: IPython,Jupyter,Widgets,pandas
Classifier: Framework :: Jupyter
Classifier: Framework :: Jupyter :: JupyterLab
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.11
Requires-Dist: anywidget>=0.9.0
Requires-Dist: cloudpickle>=3.1.1
Requires-Dist: fastparquet<2026.3.0,>=2024.5.0
Requires-Dist: graphlib-backport>=1.0.0
Requires-Dist: numpy>=2.2.5; python_version >= '3.13'
Requires-Dist: pyarrow; python_version == '3.13'
Requires-Dist: pyarrow>=18.0.0; python_version < '3.13'
Requires-Dist: pyarrow>=22.0.0; python_version >= '3.14'
Provides-Extra: dev
Requires-Dist: anywidget[dev]>=0.9.0; extra == 'dev'
Requires-Dist: graphviz>=0.20.1; extra == 'dev'
Requires-Dist: hypothesis>=6.88.1; extra == 'dev'
Requires-Dist: jupyterlab>=4.2.5; extra == 'dev'
Requires-Dist: libcst>=1.4.0; extra == 'dev'
Requires-Dist: marimo>=0.19.7; extra == 'dev'
Requires-Dist: mistune<3.1; extra == 'dev'
Requires-Dist: nbval>=0.9; extra == 'dev'
Requires-Dist: pandas; (python_version >= '3.13') and extra == 'dev'
Requires-Dist: pandas>=1.3.5; (python_version < '3.13') and extra == 'dev'
Requires-Dist: pl-series-hash==0.2.1; extra == 'dev'
Requires-Dist: playwright; extra == 'dev'
Requires-Dist: pyarrow; extra == 'dev'
Requires-Dist: pydantic>=2.5.2; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: pytest-check-links; extra == 'dev'
Requires-Dist: pytest-playwright; extra == 'dev'
Requires-Dist: ruff>=0.6.2; extra == 'dev'
Requires-Dist: solara; (python_version < '3.14') and extra == 'dev'
Requires-Dist: solara[pytest]; (python_version < '3.14') and extra == 'dev'
Requires-Dist: sphinx>=1.5; extra == 'dev'
Requires-Dist: toml; extra == 'dev'
Requires-Dist: watchfiles; extra == 'dev'
Provides-Extra: jupyterlab
Requires-Dist: jupyterlab>=3.6.0; extra == 'jupyterlab'
Provides-Extra: marimo
Requires-Dist: marimo>=0.19.7; extra == 'marimo'
Requires-Dist: pandas; (python_version >= '3.13') and extra == 'marimo'
Requires-Dist: pandas>=1.3.5; (python_version < '3.13') and extra == 'marimo'
Provides-Extra: mcp
Requires-Dist: mcp; extra == 'mcp'
Requires-Dist: polars; extra == 'mcp'
Requires-Dist: tornado>=6.0; extra == 'mcp'
Provides-Extra: notebook
Requires-Dist: notebook>=7.0.0; extra == 'notebook'
Provides-Extra: packaging-tools
Requires-Dist: build; extra == 'packaging-tools'
Requires-Dist: twine; extra == 'packaging-tools'
Provides-Extra: polars
Requires-Dist: pl-series-hash==0.2.1; extra == 'polars'
Requires-Dist: polars; extra == 'polars'
Requires-Dist: polars>=1.24.0; extra == 'polars'
Requires-Dist: polars[timezone]; extra == 'polars'
Provides-Extra: tauri-essentials
Requires-Dist: pandas; (python_version >= '3.13') and extra == 'tauri-essentials'
Requires-Dist: pandas>=1.3.5; (python_version < '3.13') and extra == 'tauri-essentials'
Requires-Dist: polars>=1.24.0; extra == 'tauri-essentials'
Requires-Dist: tornado>=6.0; extra == 'tauri-essentials'
Provides-Extra: test
Requires-Dist: anywidget; extra == 'test'
Requires-Dist: codecov; extra == 'test'
Requires-Dist: hypothesis>=6.88.1; extra == 'test'
Requires-Dist: nbstripout; extra == 'test'
Requires-Dist: nbval>=0.9; extra == 'test'
Requires-Dist: packaging; extra == 'test'
Requires-Dist: pandas; (python_version >= '3.13') and extra == 'test'
Requires-Dist: pandas>=1.3.5; (python_version < '3.13') and extra == 'test'
Requires-Dist: pandera; extra == 'test'
Requires-Dist: pydantic>=2.5.2; extra == 'test'
Requires-Dist: pytest-cov>=3; extra == 'test'
Requires-Dist: pytest>=6; extra == 'test'
Requires-Dist: ruff; extra == 'test'
Provides-Extra: xorq
Requires-Dist: xorq>=0.1.0; (python_version < '3.14') and extra == 'xorq'
Description-Content-Type: text/markdown

# Buckaroo - The Data Table for Jupyter

[![PyPI version](https://img.shields.io/pypi/v/buckaroo.svg)](https://pypi.org/project/buckaroo/)
[![CI](https://github.com/buckaroo-data/buckaroo/actions/workflows/checks.yml/badge.svg)](https://github.com/buckaroo-data/buckaroo/actions/workflows/checks.yml)
[![License](https://img.shields.io/pypi/l/buckaroo.svg)](https://github.com/buckaroo-data/buckaroo/blob/main/LICENSE.txt)

Buckaroo is a modern data table for Jupyter that expedites the most common exploratory data analysis tasks. The most basic data analysis task - looking at the raw data, is cumbersome with the existing pandas tooling. Buckaroo starts with a modern performant data table that is sortable, has value formatting, and scrolls infinitely. On top of the core table experience, extra features like summary stats, histograms, smart sampling, auto-cleaning, and a low code UI are added. All of the functionality has sensible defaults that can be overridden to customize the experience for your workflow.

<img width="947" alt="Screenshot 2025-05-12 at 3 54 33 PM" src="https://github.com/user-attachments/assets/9238c893-8dd4-47e4-8215-b5450c8c7b3a" />

## Try it now with Marimo in your browser
Play with Buckaroo without any installation.
[Full Tour](https://marimo.io/p/@paddy-mullen/buckaroo-full-tour)


## Quick start

```bash
pip install buckaroo
```

Then in a Jupyter notebook:

```python
import pandas as pd
import buckaroo
pd.DataFrame({'a': [1, 2, 10, 30, 50, 60, 50], 'b': ['foo', 'foo', 'bar', pd.NA, pd.NA, pd.NA, pd.NA]})
```

When you `import buckaroo`, it becomes the default display for Pandas and Polars DataFrames.

## Claude Code MCP Integration

Buckaroo can be used as an [MCP](https://modelcontextprotocol.io/) server in [Claude Code](https://docs.anthropic.com/en/docs/claude-code), giving Claude the ability to open data files in an interactive table viewer.

### Install

```bash
claude mcp add buckaroo-table -- uvx --from "buckaroo[mcp]" buckaroo-table
```

That's it. This downloads Buckaroo from PyPI into an isolated environment and registers the MCP server. No other installation steps are needed.

### Usage

Once installed, ask Claude Code to view any CSV, TSV, Parquet, or JSON file:

> show me sales_data.csv

Claude will call the `view_data` tool, which opens the file in Buckaroo's interactive table UI in your browser.


## Compatibility

Buckaroo works in the following notebook environments:

- `jupyter lab` (version >=3.6.0)
- `jupyter notebook` (version >=7.0)
- [Marimo](https://marimo.io/p/@paddy-mullen/buckaroo-full-tour)
- `VS Code notebooks` (with extra install)
- [Jupyter Lite](https://paddymul.github.io/buckaroo-examples/lab/index.html)
- `Google Colab`
- `Claude Code` (via MCP)

Buckaroo works with the following DataFrame libraries:
- **pandas** (version >=1.3.5)
- **polars** (optional, `pip install buckaroo[polars]`)


# Features

## High performance table
The core data grid is based on [AG-Grid](https://www.ag-grid.com/). It loads thousands of cells in under a second, with highly customizable display, formatting and scrolling. Data is loaded lazily into the browser as you scroll, and serialized with parquet. You no longer have to use `df.head()` to poke at portions of your data.

## Fixed width formatting by default
By default numeric columns are formatted to use a fixed width font and commas are added. This allows quick visual confirmation of magnitudes in a column.

## Histograms
[Histograms](https://buckaroo-data.readthedocs.io/en/latest/articles/histograms.html) for every column give you a very quick overview of the distribution of values, including uniques and N/A.

## Summary stats
The summary stats view can be toggled by clicking on the `0` below the `Σ` icon. Summary stats are similar to `df.describe` and extensible.

## Sorting
All visible data is sortable by clicking on a column name; further clicks change sort direction then disable sort for that column. Because extreme values are included with sample rows, you can see outlier values too.

## Search
Search is built into Buckaroo so you can quickly find the rows you are looking for.

## Lowcode UI
Buckaroo has a simple low code UI with Python code gen. This view can be toggled by clicking the checkbox below the `λ` (lambda) icon.

## Autocleaning
Select a cleaning method from the status bar. The autocleaning system inspects each column and runs statistics to decide if cleaning should be applied (parsing dates, stripping non-integer characters, parsing implied booleans like "yes"/"no"), then adds those operations to the low code UI. Different cleaning methods can be tried because dirty data isn't deterministic. Access it with `BuckarooWidget(df, auto_clean=True)`.

Read more: [Autocleaning docs](https://buckaroo-data.readthedocs.io/en/latest/articles/auto_clean.html)

## Extensibility at the core
Summary stats are built on the [Pluggable Analysis Framework](https://buckaroo-data.readthedocs.io/en/latest/articles/pluggable.html) that allows individual summary stats to be overridden, and new summary stats to be built in terms of existing ones. Care is taken to prevent errors in summary stats from preventing display of a dataframe.


# Learn More

## Interactive Styling Gallery
The interactive [styling gallery](https://py.cafe/app/paddymul/buckaroo-gallery) lets you see different styling configurations. You can live edit code and play with different configs.

## Videos
- [Buckaroo Full Tour](https://youtu.be/t-wk24F1G3s) 6m50s - A broad introduction to Buckaroo
- [The Column's the limit - PyData Boston 2025](https://www.youtube.com/watch?v=JUCvHnpmx-Y) 43m - How LazyBuckaroo reliably processes laptop-large data
- [19 Million row scrolling and stats demo](https://www.youtube.com/shorts/x1UnW4Y_tOk) 58s
- [Buckaroo PyData Boston 2025](https://www.youtube.com/watch?v=HtahDDEnBwE) 49m - Full tour with audience Q&A
- [Using Buckaroo and pandas to investigate large CSVs](https://www.youtube.com/watch?v=_ZmYy8uvZN8) 9m
- [Autocleaning quick demo](https://youtube.com/shorts/4Jz-Wgf3YDc) 2m38s
- [Writing your own autocleaning functions](https://youtu.be/A-GKVsqTLMI) 10m10s
- [Extending Buckaroo](https://www.youtube.com/watch?v=GPl6_9n31NE) 12m56s
- [Styling Buckaroo](https://www.youtube.com/watch?v=cbwJyo_PzKY) 8m18s
- [Understanding JLisp in Buckaroo](https://youtu.be/3Tf3lnuZcj8) 12m42s
- [GeoPandas Support](https://youtu.be/8WBhoNjDJsA)

## Articles
- [Using Buckaroo and pandas to investigate large CSVs](https://medium.com/@paddy_mullen/using-buckaroo-and-pandas-to-investigate-large-csvs-2a200aebae31)
- [Speed up exploratory data analysis with Buckaroo](https://medium.com/data-science-collective/speed-up-initial-data-analysis-with-buckaroo-71d00660d3fc)


## Example Notebooks

- [Full Tour (Marimo)](https://marimo.io/p/@paddy-mullen/buckaroo-full-tour) - Start here. Broad overview of Buckaroo's features. Also available on [Google Colab](https://colab.research.google.com/github/buckaroo-data/buckaroo/blob/main/docs/example-notebooks/Full-tour-colab.ipynb) and [JupyterLite](https://paddymul.github.io/buckaroo-examples/lab/index.html?path=Full-tour.ipynb)
- [Notebook on GitHub](https://github.com/buckaroo-data/buckaroo/blob/main/docs/example-notebooks/Full-tour.ipynb)
- [Live Styling Gallery](https://marimo.io/p/@paddy-mullen/buckaroo-styling-gallery) - Examples of all the formatters and styling available
- [Live Autocleaning](https://marimo.io/p/@paddy-mullen/buckaroo-auto-cleaning) - How autocleaning works and how to implement your own
- [Live Histogram Demo](https://marimo.io/p/@paddy-mullen/buckaroo-histogram-demo) - Explanation of the embedded histograms
- [Live JLisp overview](https://marimo.io/p/@paddy-mullen/jlisp-in-buckaroo) - The small lisp interpreter powering the lowcode UI
- [Extending Buckaroo](https://paddymul.github.io/buckaroo-examples/lab/index.html?path=Extending.ipynb) - Adding post processing methods and custom styling
- [Styling Howto](https://paddymul.github.io/buckaroo-examples/lab/index.html?path=styling-howto.ipynb) - In depth custom styling guide
- [Pluggable Analysis Framework](https://paddymul.github.io/buckaroo-examples/lab/index.html?path=Pluggable-Analysis-Framework.ipynb) - Adding new summary stats
- [Solara Buckaroo](https://github.com/buckaroo-data/buckaroo/blob/main/docs/example-notebooks/Solara-Buckaroo.ipynb) - Using Buckaroo with Solara
- [GeoPandas with Buckaroo](https://github.com/buckaroo-data/buckaroo/blob/main/docs/example-notebooks/GeoPandas.ipynb)

## Example apps built on Buckaroo
- [Buckaroo Compare](https://marimo.io/p/@paddy-mullen/buckaroo-compare-preview) - Join two dataframes and highlight visual differences
- [Buckaroo Pandera](https://marimo.io/p/@paddy-mullen/buckaroo-pandera) - Validate a dataframe with Pandera, then visually highlight where it fails


# Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup, build instructions, and release process.

We welcome [issue reports](https://github.com/buckaroo-data/buckaroo/issues); be sure to choose the proper issue template so we get the necessary information.
