pymport

Use Python libraries from Node.js

Quickstart

Install pymport:

npm i pymport

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

npx pympip3 install numpy

Start using from Node.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

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 for the full documentation.

Or go for the quickstart by learning from the examples.

There is also a medium stort 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

| 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 for a more detailed comparison.

Known Issues

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

License

Copyright 2022-2024 Momtchil Momtchev [email protected] 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.