Metadata-Version: 2.4
Name: planframe-pandas
Version: 0.6.0
Summary: pandas backend adapter for PlanFrame.
Project-URL: Repository, https://github.com/eddiethedean/planframe
Project-URL: Documentation, https://planframe.readthedocs.io/en/latest/planframe_pandas/
Project-URL: Issues, https://github.com/eddiethedean/planframe/issues
Author: PlanFrame Contributors
License: MIT
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Typing :: Typed
Requires-Python: >=3.10
Requires-Dist: pandas>=2.0
Requires-Dist: planframe<0.7.0,>=0.6.0
Provides-Extra: excel
Requires-Dist: openpyxl>=3.1; extra == 'excel'
Provides-Extra: parquet
Requires-Dist: pyarrow>=14; extra == 'parquet'
Description-Content-Type: text/markdown

## planframe-pandas

[![Docs](https://readthedocs.org/projects/planframe/badge/?version=latest)](https://planframe.readthedocs.io/en/latest/planframe_pandas/)
[![PyPI](https://img.shields.io/pypi/v/planframe-pandas)](https://pypi.org/project/planframe-pandas/)
[![License: MIT](https://img.shields.io/badge/License-MIT-informational)](../../LICENSE)

pandas adapter package for PlanFrame. Import as `planframe_pandas`.

Documentation (ReadTheDocs):

- pandas track (end users): `https://planframe.readthedocs.io/en/latest/planframe_pandas/`
- Light API reference: `https://planframe.readthedocs.io/en/latest/planframe_pandas/reference/api/`

### Notes

- PlanFrame is **always lazy**: chaining does not touch backend data; execution happens at `collect()` boundaries.

### Common transforms

- `with_row_count(name="row_nr", offset=0)`: add a monotonically increasing row number column.
- `clip(lower=..., upper=..., subset=...)`: clamp numeric columns (if `subset=None`, clamps all numeric schema fields).
- `cast_many` / `cast_subset`: multi-column cast helpers.
- `fill_null_many` / `fill_null_subset`: multi-column fill-null helpers.
- `rename_upper/lower/title/strip(...)`: schema-driven rename helpers.
- `pivot_longer(...)` / `pivot_wider(...)`: reshape convenience wrappers around `melt` / `pivot`.

