Extremely lightweight compatibility layer between pandas, Polars, cuDF, and Modin
Project description
Narwhals
Extremely lightweight and extensible compatibility layer between Polars, pandas, Modin, and cuDF (and more!).
Seamlessly support all, without depending on any!
- ✅ Just use a subset of the Polars API, no need to learn anything new
- ✅ Zero dependencies, Narwhals only uses what the user passes in so your library can stay lightweight
- ✅ Separate lazy and eager APIs, use expressions
- ✅ Support pandas' complicated type system and index, without either getting in the way
- ✅ 100% branch coverage, tested against pandas and Polars nightly builds
- ✅ Negligible overhead, see overhead
- ✅ Let your IDE help you thanks to full static typing, see typing
- ✅ Perfect backwards compatibility policy, see stable api for how to opt-in
Used by / integrates with
Join the party!
Feel free to add your project to the list if it's missing, and/or chat with us on Discord if you'd like any support.
Installation
- pip (recommended, as it's the most up-to-date)
pip install narwhals - conda-forge (also fine, but the latest version may take longer to appear)
conda install -c conda-forge narwhals
Usage
There are three steps to writing dataframe-agnostic code using Narwhals:
-
use
narwhals.from_nativeto wrap a pandas/Polars/Modin/cuDF DataFrame/LazyFrame in a Narwhals class -
use
narwhals.to_nativeto return an object to the user in its original dataframe flavour. For example:- if you started with pandas, you'll get pandas back
- if you started with Polars, you'll get Polars back
- if you started with Modin, you'll get Modin back (and compute will be distributed)
- if you started with cuDF, you'll get cuDF back (and compute will happen on GPU)
What about Ibis?
Like Ibis, Narwhals aims to enable dataframe-agnostic code. However, Narwhals comes with zero dependencies, is about as lightweight as it gets, and is aimed at library developers rather than at end users. It also does not aim to support as many backends, instead preferring to focus on dataframes. So, which should you use?
- If you need a SQL frontend in Python: Ibis!
- If you're a library maintainer and want a lightweight and minimal-overhead layer to get cross-dataframe library support: Narwhals!
Here is the package size increase which would result from installing each tool in a non-pandas environment:
Example
See the tutorial for several examples!
Scope
- Do you maintain a dataframe-consuming library?
- Do you have a specific Polars function in mind that you would like Narwhals to have in order to make your work easier?
If you said yes to both, we'd love to hear from you!
Note: You might suspect that this is a secret ploy to infiltrate the Polars API everywhere. Indeed, you may suspect that.
Why "Narwhals"?
Thanks to Olha Urdeichuk for the illustration!
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file narwhals-1.0.1.tar.gz.
File metadata
- Download URL: narwhals-1.0.1.tar.gz
- Upload date:
- Size: 83.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.0 CPython/3.12.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b0bb220d43908fe32122fa0d1cd4664c46c5137c5272d4700ec153453a48dcc8 |
|
| MD5 | 8bcc2406496dea3dafcf84e75e87d3a4 |
|
| BLAKE2b-256 | c8f7a9339963ab13e5f6c49e293d35eade107216ec7df7de653618728112bfda |
Provenance
File details
Details for the file narwhals-1.0.1-py3-none-any.whl.
File metadata
- Download URL: narwhals-1.0.1-py3-none-any.whl
- Upload date:
- Size: 93.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.0 CPython/3.12.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 1bcba6d1b8858e8b8a710ba1193b55726a42276bf75debecac985fab02a24bb3 |
|
| MD5 | e5588ff46811b5796b1ba6003b56b689 |
|
| BLAKE2b-256 | 2b72055985655fa727eff0ca8469b965581516ea4d094694c14fbf4e28bd99a4 |
