This repo contains the User Guide for the Polars DataFrame library.
To build the benchmarks and Python code examples, Graphviz, make, wget as well as the Python packages listed in requirements.txt need to be present on the system.
To build the User Guide, the Rust-based mdBook executable should also be downloaded/compiled and accessible (in the PATH).
To build the Reference Guide, a custom mdBook executable should also be downloaded from here and made accessible as mdbook2 in the PATH.
The reference guide requires a specific Python version to be used. Make sure to check __main__.SRC for reference guide work.
Use make serve to serve the user guide.
| Example | Rust |
Python |
JavaScript |
|---|---|---|---|
| CSV files | ✔ | ✔ | ✗ |
| Parquet files | ✔ | ✔ | ✗ |
| Interact with an AWS bucket | ✔ | ✔ | ✗ |
| Interact with an Azure Blob Storage | ✗ | ✗ | ✗ |
| Interact with a GCP Storage | ✗ | ✗ | ✗ |
| Interact with a database | ✗ | ✗ | ✗ |
| Process strings | ✔ | ✔ | ✗ |
| Process timestamps | ✗ | ✔ | ✗ |
| Process missing values | ✗ | ✗ | ✗ |
| Process nested values (explode) | ✗ | ✗ | ✗ |
| Rename columns and other manipulations* | ✗ | ✔ | ✗ |
| Column/row selection* | ✗ | ✔ | ✗ |
| Filter* | ✔ | ✔ | ✗ |
| GroupBy* | ✔ | ✔ | ✗ |
| Join | ✔ | ✗ | ✗ |
| Sort* | ✔ | ✔ | ✗ |
| Pivot/melt | ✗ | ✗ | ✗ |
| Aggregate* | ✔ | ✔ | ✗ |
| Conditionally apply* | ✗ | ✔ | ✗ |
| Horizontal fold | ✗ | ✗ | ✗ |
| Stacking | ✗ | ✗ | ✗ |
| Sampling | ✗ | ✗ | ✗ |
Arrow interoperability |
✗ | ✔ | ✗ |
NumPy interoperability |
✗ | ✔ | ✗ |
Apply NumPy universal functions* |
✗ | ✔ | ✗ |
| Apply custom functions (UDFs) | ✗ | ✗ | ✗ |
| Apply window functions* | ✗ | ✔ | ✗ |
| Apply rolling-window functions | ✗ | ✗ | ✗ |
| Group statistics | ✗ | ✔ | ✗ |
* Some How Can I code examples not included but topic introduced elsewhere.
At this point in time, only Python and NodeJS bindings are available for Polars.
The content of the Reference Guides is generated directly from the source code.
In this repo one can find the scripts used to generate the Markdown content later rendered by mdBook (a custom version thereof).