Metadata-Version: 2.4
Name: sheetframe
Version: 0.1.1
Summary: Interactive spreadsheet-style pandas tables for Jupyter and Colab
Keywords: pandas,jupyter,colab,dataframe,table
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Web Environment
Classifier: Framework :: Jupyter
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Scientific/Engineering :: Visualization
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: numpy>=1.23
Requires-Dist: pandas>=1.5
Requires-Dist: ipython>=8

# sheetframe

Interactive spreadsheet-style pandas tables for Jupyter notebooks and Google Colab. Select cells, rows, columns, or the whole table; resize rows and columns; copy a selection as plain text or an HTML table. Optional KPIs summarize the DataFrame.

## Install

```bash
pip install sheetframe
```

The PyPI package and recommended Python import are both named `sheetframe`.

## Use

```python
import pandas as pd
from sheetframe import sheetframe

df = pd.DataFrame({"Name": ["Ada", "Lin"], "Score": [9.25, 8.5]})
sheetframe(df, decimal=2, showIndex=False, include_header=True, kpi=False)
```

`sheetframe` displays the table in a Jupyter or Colab output cell. It accepts a pandas DataFrame or Series. `decimal=0` preserves the original numeric text. Set `showIndex=True` to show the index initially, `include_header=False` to omit column names from copied selections, and `kpi=True` to show the summary above the table.

The original `from labframe import lab_table` import still works.

Browser clipboard permissions and notebook security settings may affect copying and inline JavaScript behavior.

## Publish to PyPI

The current release is `0.1.1`. From this folder on Windows, create a virtual environment and build the distributions:

```powershell
py -m venv .venv
.\.venv\Scripts\python -m pip install build twine
.\.venv\Scripts\python -m build
.\.venv\Scripts\python -m twine check dist\sheetframe-0.1.1*
```

Create a [PyPI account](https://pypi.org/account/register/) and an [API token](https://pypi.org/manage/account/token/). Then upload the files:

```powershell
.\.venv\Scripts\python -m twine upload dist\sheetframe-0.1.1*
```

When prompted, use `__token__` as the username and paste the full `pypi-...` token as the password. After PyPI finishes processing, verify with `py -m pip install sheetframe==0.1.1` in a fresh environment. For later releases, increase the version in `pyproject.toml`, `src/sheetframe/__init__.py`, and `src/labframe/__init__.py` before building again; PyPI does not permit replacing an uploaded version.
