Skip to main content

Extremely lightweight compatibility layer between dataframe libraries

Project description

Narwhals

narwhals_small

PyPI version

Extremely lightweight and extensible compatibility layer between dataframe libraries!

  • Full API support: cuDF, Modin, pandas, Polars
  • Interchange-level support: Ibis, PyArrow, Vaex, anything else which implements the DataFrame Interchange Protocol

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

Get started!

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:

  1. use narwhals.from_native to wrap a pandas/Polars/Modin/cuDF DataFrame/LazyFrame in a Narwhals class

  2. use the subset of the Polars API supported by Narwhals

  3. use narwhals.to_native to 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)

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.

Funding

Narwhals is 100% independent, community-driven, and community-owned. We are extremely grateful to the following organisations for having provided some funding / development time:

If you contribute to Narwhals on company time, feel free to reach out and we can add your employer to the list!

Why "Narwhals"?

Coz they are so awesome.

Thanks to Olha Urdeichuk for the illustration!

Project details


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

narwhals-1.1.2.tar.gz (94.1 kB view details)

Uploaded Source

Built Distribution

narwhals-1.1.2-py3-none-any.whl (106.2 kB view details)

Uploaded Python 3

File details

Details for the file narwhals-1.1.2.tar.gz.

File metadata

  • Download URL: narwhals-1.1.2.tar.gz
  • Upload date:
  • Size: 94.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for narwhals-1.1.2.tar.gz
Algorithm Hash digest
SHA256 e9ce90524a58c9d2de927b759486cbf021f46aba769ae11edf6740436b6490e4
MD5 2e6356eee95b617c3392535387d9c3c9
BLAKE2b-256 af4a0900fe9c6c95073cb7d949d75bf5ca951a42771b60eebac615ee75261d8c

See more details on using hashes here.

File details

Details for the file narwhals-1.1.2-py3-none-any.whl.

File metadata

  • Download URL: narwhals-1.1.2-py3-none-any.whl
  • Upload date:
  • Size: 106.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for narwhals-1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a66cb99a83657bfbcbdb7b5859483758dc3619e4eab749d74fa302ca1a07fb6b
MD5 cd96e109e5046df4f8ec82069461a15b
BLAKE2b-256 c848bb5b4d90d598b482abc9725c278b7fc30f0a99b40a9c34ae6a20c1430170

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page