Metadata-Version: 2.4
Name: pyspark-inspect
Version: 0.1.0
Summary: Inspect pyspark query plans
License: MIT
Author: Matthias Ossadnik
Author-email: ossadnik.matthias@gmail.com
Requires-Python: >=3.11,<4.0
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Dist: pyspark (==3.5.*)
Project-URL: homepage, https://github.com/mossadnik/pyspark-inspect
Description-Content-Type: text/markdown

# pyspark-inspect

pyspark-inspect allows to inspect the query plans of pyspark dataframes from Python.

It converts analyzed Catalyst plans into Python data structures that can be queried programmatically.

## Compatibility & Limitiations

- Tested against Spark 3.5
- Spark Connect is not supported
- Coverage of Spark SQL operations is currently very limited

## Basic Usage

```python
from pypspark.sql import functions as F
from pyspark_inspect import inspect_dataframe

df = (
    spark.createDataFrame([[1, 2]], ['a', 'b'])
    .withColumn('c', F.col('a') + F.col('b'))
)
plan = inspect_dataframe(df)
```

