Extremely lightweight compatibility layer between dataframe libraries

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for anopsy from gravatar.com anopsy Avatar for dealeon from gravatar.com dealeon Avatar for EdoAbati from gravatar.com EdoAbati Avatar for FBruzzesi from gravatar.com FBruzzesi Avatar for MarcoGorelli from gravatar.com MarcoGorelli

Unverified details

These details have not been verified by PyPI
Meta
  • License: MIT License
  • Author: Marco Gorelli
  • Requires: Python >=3.8
  • Provides-Extra: cudf, dask, modin, pandas, polars, pyarrow
Classifiers

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!

Note: You might suspect that this is a secret ploy to infiltrate the Polars API everywhere. Indeed, you may suspect that.

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!

Why "Narwhals"?

Coz they are so awesome.

Thanks to Olha Urdeichuk for the illustration!

Project details

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for anopsy from gravatar.com anopsy Avatar for dealeon from gravatar.com dealeon Avatar for EdoAbati from gravatar.com EdoAbati Avatar for FBruzzesi from gravatar.com FBruzzesi Avatar for MarcoGorelli from gravatar.com MarcoGorelli

Unverified details

These details have not been verified by PyPI
Meta
  • License: MIT License
  • Author: Marco Gorelli
  • Requires: Python >=3.8
  • Provides-Extra: cudf, dask, modin, pandas, polars, pyarrow
Classifiers

Release history Release notifications | RSS feed

1.13.5

1.13.4

1.13.3

1.13.2

1.13.1

1.12.1

1.12.0

1.11.1

1.11.0

1.10.0

1.9.4

1.9.3

1.9.2

1.9.1

1.9.0

1.8.4

1.8.3

1.8.2

1.8.1

1.8.0

1.7.0

This version

1.6.4

1.6.3

1.6.2

1.6.1

1.6.0

1.5.5

1.5.4

1.5.3

1.5.2

1.5.1

1.5.0

1.4.2

1.4.1

1.4.0

1.3.0

1.2.0

1.1.9

1.1.8

1.1.7

1.1.6

1.1.5

1.1.4

1.1.3

1.1.2

1.1.1

1.1.0

1.0.6

1.0.5

1.0.4

1.0.3

1.0.2

1.0.1

1.0.0

0.9.29

0.9.28

0.9.27

0.9.26

0.9.25

0.9.24

0.9.23

0.9.22

0.9.21

0.9.20

0.9.19

0.9.18

0.9.17

0.9.16

0.9.15

0.9.14

0.9.13

0.9.12

0.9.11

0.9.10

0.9.9

0.9.8

0.9.7

0.9.6

0.9.5

0.9.2

0.9.1

0.9.0

0.8.21

0.8.20

0.8.19

0.8.18

0.8.17

0.8.16

0.8.15

0.8.14

0.8.13

0.8.12

0.8.11

0.8.10

0.8.9

0.8.8

0.8.7

0.8.6

0.8.5

0.8.4

0.8.3

0.8.2

0.8.1

0.8.0

0.7.18

0.7.16

0.7.15

0.7.14

0.7.12

0.7.11

0.7.10

0.7.9

0.7.8

0.7.7

0.7.6

0.7.5

0.7.4

0.7.3

0.7.2

0.7.1

0.7.0

0.6.9

0.6.8

0.6.7

0.6.6

0.6.5

0.6.4

0.6.3

0.6.2

0.6.1

0.6.0

0.5.0

0.4.1

0.4.0

0.3.0

0.2.0

0.1.14

0.1.13

0.1.12

0.1.11

0.1.10

0.1.9

0.1.8

0.1.7

0.1.6

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

Uploaded Source

Built Distribution

narwhals-1.6.4-py3-none-any.whl (163.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for narwhals-1.6.4.tar.gz
Algorithm Hash digest
SHA256 e49f660660bfe9e0dc37164df53b147b13a4ee8ee3fe41c40c4e91f64cb50fff
MD5 96f5dd1c236b7a04b0c39b8bf5c59bfa
BLAKE2b-256 602ce3991795308f8d3f1dd22938a5df424e3213a158ae38cc84833d254e4856

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for narwhals-1.6.4-py3-none-any.whl
Algorithm Hash digest
SHA256 d5e98a811af6794f4a07fee37039c8e2cb5791db4b998a795eeefd367ce8277c
MD5 29910cb417f75ea5ca83af400cdf4ece
BLAKE2b-256 518d0f949c69d86f346e75f3c0a3e4ce1d09066f268257d294e1460cdbc28493

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