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
  • 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.8.0.tar.gz (137.0 kB view details)

Uploaded Source

Built Distribution

narwhals-1.8.0-py3-none-any.whl (165.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for narwhals-1.8.0.tar.gz
Algorithm Hash digest
SHA256 b1572b8781273e5712ee76144b9b6f412f2b71f39d63053853322cc98201eeaa
MD5 d50eedb05409830295da03847f65e536
BLAKE2b-256 bcb6e767bf0ac651550414268143091329cf73520fdaff805814cd9231b15500

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for narwhals-1.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 73bde7b1721e1d95f749f6aacec12bc616fcccae5a926064d641c93e133fd548
MD5 18f513515068f02e8a3d6b7cdf45fd87
BLAKE2b-256 46fef34c61be530148759740fb62ddd623637e9d911461999449f667759660a1

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