Skip to main content

Extremely lightweight compatibility layer between dataframe libraries

Project description

Narwhals

narwhals_small

PyPI version Downloads

Extremely lightweight and extensible compatibility layer between dataframe libraries!

  • Full API support: cuDF, Modin, pandas, Polars, PyArrow
  • Lazy-only support: Dask
  • Interchange-level support: Ibis, 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/PyArrow 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)
    • if you started with PyArrow, you'll get PyArrow back

narwhals_gif

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!

Sponsors and institutional partners

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 your organization's time, please let us know. We'd be happy to add your employer to this list!

Appears on

Narwhals has been featured in several talks, podcasts, and blog posts:

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.9.3.tar.gz (153.8 kB view details)

Uploaded Source

Built Distribution

narwhals-1.9.3-py3-none-any.whl (185.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: narwhals-1.9.3.tar.gz
  • Upload date:
  • Size: 153.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for narwhals-1.9.3.tar.gz
Algorithm Hash digest
SHA256 5b3f52c02a86730a611497e6ffbaccaa3df86fc26470c23e3fb40dc2bc793ebb
MD5 355c297eea2d77f2446d0eb99c16ca60
BLAKE2b-256 6f540fc9dc22365cfc462b7abfa687756690b14d2e7cff7a4a5afcb8fc5a6024

See more details on using hashes here.

File details

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

File metadata

  • Download URL: narwhals-1.9.3-py3-none-any.whl
  • Upload date:
  • Size: 185.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for narwhals-1.9.3-py3-none-any.whl
Algorithm Hash digest
SHA256 598d09227bef31f42ec25840728f3113e7e37c30d5430ae8126a1c8bd58177f9
MD5 263ca7c13f0505b70840d696e8c2ffbe
BLAKE2b-256 cfd2470667e763eaf355b8ed1c6010453e92dfcdfd4cfd3b5924586ee6469e24

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