Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mmomtchev/pymport

Use Python libraries from Node.js
https://github.com/mmomtchev/pymport

compatibility-layer import nodejs numpy pandas python require

Last synced: about 15 hours ago
JSON representation

Use Python libraries from Node.js

Host: GitHub
URL: https://github.com/mmomtchev/pymport
Owner: mmomtchev
License: isc
Created: 2022-10-17T20:12:47.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2024-12-03T13:45:17.000Z (11 days ago)
Last Synced: 2024-12-03T14:42:23.287Z (11 days ago)
Topics: compatibility-layer, import, nodejs, numpy, pandas, python, require
Language: C++
Homepage:
Size: 1.49 MB
Stars: 110
Watchers: 2
Forks: 8
Open Issues: 19
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

        # pymport

Use Python libraries from Node.js

**Update: since Oct 24 I am homeless and living in my van. I lost access to most of my computer hardware. The eviction from my home has been timed for maximum effect as I was not present when it happened. I have only a single set of clothes and no means to get anything else. Please, if you use my software, consider asking everyone around you if they are taking part in this extortion and why.**

[![ISC](https://img.shields.io/github/license/mmomtchev/pymport)](https://github.com/mmomtchev/pymport/blob/main/LICENSE)

[![Test npm package](https://github.com/mmomtchev/pymport/actions/workflows/test-package.yml/badge.svg)](https://github.com/mmomtchev/pymport/actions/workflows/test-package.yml)

[![Node.js CI](https://github.com/mmomtchev/pymport/actions/workflows/test-dev.yml/badge.svg)](https://github.com/mmomtchev/pymport/actions/workflows/test-dev.yml)

[![npm](https://img.shields.io/npm/v/pymport)](https://www.npmjs.com/package/pymport)

[![codecov](https://codecov.io/gh/mmomtchev/pymport/branch/main/graph/badge.svg?token=pNeJl1Zhmw)](https://codecov.io/gh/mmomtchev/pymport)

# Quickstart

Install `pymport`:

```shell

npm i pymport

```

Install `numpy`, `pandas` or whatever your favorite Python package is:

```shell

npx pympip3 install numpy

```

Start using from Node.js:

```js

const { pymport, proxify } = require('pymport');

const np = proxify(pymport('numpy'));

const a = np.arange(15).reshape(3, 5);

const b = np.ones([2, 3], { dtype: np.int16 });

```

or

```js

import { pymport, proxify } from 'pymport';

const np = proxify(pymport('numpy'));

const a = np.arange(15).reshape(3, 5);

const b = np.ones([2, 3], { dtype: np.int16 });

```

Then head to the [wiki](https://github.com/mmomtchev/pymport/wiki) for the full documentation.

Or go for the quickstart by learning from the [examples](https://github.com/mmomtchev/pymport/tree/main/examples).

There is also a [medium stort](https://medium.com/@mmomtchev/using-numpy-and-pandas-in-node-js-88fe30080938) with a brief introduction.

# Supported Versions

`pymport` is unit-tested on all combinations of:

| Platforms | Versions                                                 |

| --------- | -------------------------------------------------------- |

| OS        | Windows 2019 & 2022, Ubuntu 20.04 & 22.04, macOS 11 & 12 (x86 only) |

| Node.js   | 16.x, 18.x and 20.x                                      |

| Python    | 3.8, 3.9, 3.10, 3.11 and 3.12                            |

except for the following combinations that are not supported:

* **Node.js 16.x on Ubuntu 22.04**: rebuilding from source against the system-installed Python is not possible due to Node.js containing a built-in OpenSSL 1.1 with exported symbols while the system-provided Python is built vs OpenSSL 3.0, upgrading Node.js or using the precompiled interpreter solves this issue

* **Node.js 16.x and Python 3.12**: `node-gyp` from Node.js 16.x does not work if Python 3.12 is installed

* **Python 3.11.x on Windows**: An upstream bug requires a specific workaround in this case [#44](https://github.com/mmomtchev/pymport/issues/44)

| `pymport` | Built-in Python interpreter           |

| --------- | ------------------------------------- |

| 1.4.x     | Python 3.10                           |

| 1.5.x     | Pytnon 3.12                           |

# `pymport` vs `PyScript/Pyodide`

Although both projects provide similar functionality, they are completely unrelated with very different design goals:

* `pymport` goal is to allow using standard Python libraries without any modification in Node.js - it brings software such as `numpy` and `pandas` to Node.js

* `Pyodide` goal is to allow using Python code in a modified interpreter both in the browser and in Node.js - it allows scripting a web page in Python

You can check [the wiki](https://github.com/mmomtchev/pymport/wiki/vs-Pyodide) for a more detailed comparison.

# Known Issues

The wiki has a list of some known and hard to fix issues:

[Known Issues](https://github.com/mmomtchev/pymport/wiki#known-issues)

# License

Copyright 2022-2024 Momtchil Momtchev  and contributors

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.