Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pola-rs/nodejs-polars
nodejs front-end of polars
https://github.com/pola-rs/nodejs-polars
polars
Last synced: about 2 months ago
JSON representation
nodejs front-end of polars
- Host: GitHub
- URL: https://github.com/pola-rs/nodejs-polars
- Owner: pola-rs
- License: mit
- Created: 2022-07-31T07:41:30.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-25T22:55:58.000Z (about 2 months ago)
- Last Synced: 2024-07-26T01:16:45.349Z (about 2 months ago)
- Topics: polars
- Language: TypeScript
- Homepage: https://pola-rs.github.io/nodejs-polars/
- Size: 52.3 MB
- Stars: 354
- Watchers: 11
- Forks: 37
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-polars - nodejs-polars for Node.js - [Node.js](https://nodejs.org/en/) `nodejs-polars` package to use polars DataFrame from Node.js. (Libraries/Packages/Scripts / Node.js)
README
# Polars
Polars: Blazingly fast DataFrames in Rust, Python, Node.js, R and SQL
[](https://github.com/pola-rs/nodejs-polars/actions/workflows/docs.yaml/)
[](https://github.com/pola-rs/nodejs-polars/actions/workflows/test-js.yaml)
[](https://crates.io/crates/polars)
[](https://pypi.org/project/polars/)
[](https://www.npmjs.com/package/nodejs-polars)
Documentation: [Node.js](https://pola-rs.github.io/nodejs-polars/index.html)
-[ Rust](https://docs.rs/polars/latest/polars/)
-[ Python](https://pola-rs.github.io/polars/py-polars/html/reference/index.html)
-[ R](https://rpolars.github.io/index.html)
|StackOverflow: [ Node.js](https://stackoverflow.com/questions/tagged/nodejs-polars)
-[ Rust](https://stackoverflow.com/questions/tagged/rust-polars)
-[ Python](https://stackoverflow.com/questions/tagged/python-polars)
| [User Guide](https://pola-rs.github.io/polars/)
| [Discord](https://discord.gg/4UfP5cfBE7)
#### Note: This library is intended to work only with server side JS/TS (Node, Bun, Deno). For browser please see [js-polars](https://github.com/pola-rs/js-polars)
## Usage
### Importing
```js
// esm
import pl from 'nodejs-polars';
// require
const pl = require('nodejs-polars');
```
### Series
```js
> const fooSeries = pl.Series("foo", [1, 2, 3])
> fooSeries.sum()
6
// a lot operations support both positional and named arguments
// you can see the full specs in the docs or the type definitions
> fooSeries.sort(true)
> fooSeries.sort({reverse: true})
shape: (3,)
Series: 'foo' [f64]
[
3
2
1
]
> fooSeries.toArray()
[1, 2, 3]
// Series are 'Iterables' so you can use javascript iterable syntax on them
> [...fooSeries]
[1, 2, 3]
> fooSeries[0]
1
```
### DataFrame
```js
>const df = pl.DataFrame(
... {
... A: [1, 2, 3, 4, 5],
... fruits: ["banana", "banana", "apple", "apple", "banana"],
... B: [5, 4, 3, 2, 1],
... cars: ["beetle", "audi", "beetle", "beetle", "beetle"],
... }
... )
> df.sort("fruits").select(
... "fruits",
... "cars",
... pl.lit("fruits").alias("literal_string_fruits"),
... pl.col("B").filter(pl.col("cars").eq(pl.lit("beetle"))).sum(),
... pl.col("A").filter(pl.col("B").gt(2)).sum().over("cars").alias("sum_A_by_cars"),
... pl.col("A").sum().over("fruits").alias("sum_A_by_fruits"),
... pl.col("A").reverse().over("fruits").flatten().alias("rev_A_by_fruits")
... )
shape: (5, 8)
┌──────────┬──────────┬──────────────┬─────┬─────────────┬─────────────┬─────────────┐
│ fruits ┆ cars ┆ literal_stri ┆ B ┆ sum_A_by_ca ┆ sum_A_by_fr ┆ rev_A_by_fr │
│ --- ┆ --- ┆ ng_fruits ┆ --- ┆ rs ┆ uits ┆ uits │
│ str ┆ str ┆ --- ┆ i64 ┆ --- ┆ --- ┆ --- │
│ ┆ ┆ str ┆ ┆ i64 ┆ i64 ┆ i64 │
╞══════════╪══════════╪══════════════╪═════╪═════════════╪═════════════╪═════════════╡
│ "apple" ┆ "beetle" ┆ "fruits" ┆ 11 ┆ 4 ┆ 7 ┆ 4 │
├╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌┤
│ "apple" ┆ "beetle" ┆ "fruits" ┆ 11 ┆ 4 ┆ 7 ┆ 3 │
├╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌┤
│ "banana" ┆ "beetle" ┆ "fruits" ┆ 11 ┆ 4 ┆ 8 ┆ 5 │
├╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌┤
│ "banana" ┆ "audi" ┆ "fruits" ┆ 11 ┆ 2 ┆ 8 ┆ 2 │
├╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌┤
│ "banana" ┆ "beetle" ┆ "fruits" ┆ 11 ┆ 4 ┆ 8 ┆ 1 │
└──────────┴──────────┴──────────────┴─────┴─────────────┴─────────────┴─────────────┘
```
```js
> df["cars"] // or df.getColumn("cars")
shape: (5,)
Series: 'cars' [str]
[
"beetle"
"beetle"
"beetle"
"audi"
"beetle"
]
```
## Node setup
Install the latest polars version with:
```sh
$ yarn add nodejs-polars # yarn
$ npm i -s nodejs-polars # npm
```
Releases happen quite often (weekly / every few days) at the moment, so updating polars regularly to get the latest bugfixes / features might not be a bad idea.
### Minimum Requirements
- Node version `>=18`
- Rust version `>=1.59` - *Only needed for development*
## Deno
In Deno modules you can import polars straight from `npm`:
```typescript
import pl from "npm:nodejs-polars";
```
With Deno 1.37, you can use the `display` function to display a `DataFrame` in the notebook:
```typescript
import pl from "npm:nodejs-polars";
import { display } from "https://deno.land/x/[email protected]/mod.ts";
let response = await fetch(
"https://cdn.jsdelivr.net/npm/world-atlas@1/world/110m.tsv",
);
let data = await response.text();
let df = pl.readCSV(data, { sep: "\t" });
await display(df)
```
With Deno 1.38, you only have to make the dataframe be the last expression in the cell:
```typescript
import pl from "npm:nodejs-polars";
let response = await fetch(
"https://cdn.jsdelivr.net/npm/world-atlas@1/world/110m.tsv",
);
let data = await response.text();
let df = pl.readCSV(data, { sep: "\t" });
df
```
___
## Documentation
Want to know about all the features Polars supports? Read the docs!
#### Python
- Installation guide: `$ pip3 install polars`
- [Python documentation](https://pola-rs.github.io/polars/py-polars/html/reference/index.html)
- [User guide](https://pola-rs.github.io/polars-book/)
#### Rust
- [Rust documentation (master branch)](https://pola-rs.github.io/polars/polars/index.html)
- [User guide](https://pola-rs.github.io/polars-book/)
#### Node
* Installation guide: `$ yarn install nodejs-polars`
* [Node documentation](https://pola-rs.github.io/nodejs-polars/)
* [User guide](https://pola-rs.github.io/polars-book/)
## Contribution
Want to contribute? Read our [contribution guideline](https://github.com/pola-rs/polars/blob/master/CONTRIBUTING.md).
## \[Node\]: compile polars from source
If you want a bleeding edge release or maximal performance you should compile **polars** from source.
1. Install the latest [Rust compiler](https://www.rust-lang.org/tools/install)
2. Run `npm|yarn install`
3. Choose any of:
- Fastest binary, very long compile times:
```bash
$ cd nodejs-polars && yarn build && yarn build:ts # this will generate a /bin directory with the compiles TS code, as well as the rust binary
```
- Debugging, fastest compile times but slow & large binary:
```bash
$ cd nodejs-polars && yarn build:debug && yarn build:ts # this will generate a /bin directory with the compiles TS code, as well as the rust binary
```
## Webpack configuration
To use `nodejs-polars` with [Webpack](https://webpack.js.org) please use [node-loader](https://github.com/webpack-contrib/node-loader) and `webpack.config.js`
## Acknowledgements
Development of Polars is proudly powered by
[](https://www.xomnia.com/)
## Sponsors
[
](https://www.xomnia.com/) [
](https://www.jetbrains.com)