Skip to content

Commit ba693a1

Browse files
author
Vladimir Vilimaitis
committed
Simplified README
1 parent ae3ec72 commit ba693a1

1 file changed

Lines changed: 0 additions & 26 deletions

File tree

README.md

Lines changed: 0 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -27,22 +27,6 @@ import polars as pl
2727
import polars_janitor as pj
2828
```
2929

30-
## Install
31-
32-
```bash
33-
pip install polars-janitor
34-
```
35-
36-
`polars-janitor` supports CPython 3.10 through 3.14 and Python Polars `1.29.0` and newer. Older Polars `1.x` wheels do not expose the data exchange API this extension uses.
37-
38-
From a local checkout:
39-
40-
```powershell
41-
uv run --extra dev maturin develop --release
42-
```
43-
44-
The Rust extension is built for the Python interpreter active in your environment. If you switch interpreters, for example from CPython 3.14 to CPython 3.13, rebuild it. The compiled `_rust.*.pyd` on Windows, or `_rust.*.so` on Linux and macOS, is not portable across Python versions.
45-
4630
## Python usage
4731

4832
### Clean column names
@@ -292,16 +276,6 @@ pj.compare_df_cols_same({"left": left, "right": right})
292276

293277
Schema comparison supports eager and lazy frames. It uses lazy schemas and does not collect lazy data.
294278

295-
## Example
296-
297-
Run the small messy-dataframe example from a checkout:
298-
299-
```powershell
300-
uv run --extra dev python examples\messy_dataframe.py
301-
```
302-
303-
The example promotes a spreadsheet header row, cleans names, removes empty rows and columns, drops constant columns, returns duplicate customer records, and compares schemas.
304-
305279
## What this is not
306280

307281
This is not a dataframe namespace package. There is no `df.janitor.clean_names()` registration on import.

0 commit comments

Comments
 (0)