Node.js virtual environment builder

1.10.0 · active · verified Sat Mar 28

Nodeenv is a Python tool that facilitates creating isolated Node.js environments, similar to how `virtualenv` manages Python environments. It allows developers to install specific Node.js versions and global npm packages within a dedicated directory, preventing conflicts between different projects. Currently at version 1.10.0, the library maintains an active development pace with several releases per year, incorporating new Python and Node.js version support, as well as bug fixes and improvements like UV virtual environment integration.

Warnings

breaking Version 1.7.0 of `nodeenv` dropped support for Python versions 3.4, 3.5, and 3.6. Users on these Python versions must either upgrade their Python environment or pin `nodeenv` to a version older than 1.7.0.
Fix: Upgrade Python to 3.7+ or constrain `nodeenv` version to `<1.7.0` (e.g., `pip install nodeenv<1.7.0`).
gotcha When using `nodeenv --python-virtualenv` (or `-p`) to integrate Node.js into a Python virtual environment, ensure your Python virtual environment is active. Running the command without an active Python venv will result in a 'no python virtualenv is available' error, even if `nodeenv` itself is installed.
Fix: Always `source /path/to/your_venv/bin/activate` before running `nodeenv -p`.
gotcha Using the `--ignore_ssl_certs` option can bypass SSL certificate verification, which poses a security risk. This option should only be used in trusted environments and with full understanding of the implications.
Fix: Avoid `--ignore_ssl_certs` unless absolutely necessary and ensure you understand the security implications. Prefer setting up proper SSL certificates or using a trusted mirror if network issues persist.
gotcha Initial `nodeenv` installation or Node.js compilation can appear to hang without output, especially on slower connections or when compiling from source. This is often due to large downloads or long compilation times.
Fix: Use the `--verbose` flag for detailed output or the `--prebuilt` flag to prefer pre-compiled Node.js binaries for faster installation (`nodeenv --prebuilt`).

Install

pip install nodeenv Install latest version

Quickstart

Nodeenv is primarily a command-line tool. The standard workflow involves setting up a Python virtual environment, installing `nodeenv` into it, and then using `nodeenv` to create a Node.js environment. The `--python-virtualenv` (or `-p`) flag integrates the Node.js environment directly into the currently active Python virtual environment, updating its activation scripts. After installation, reactivating the Python environment or sourcing the `node_env/bin/activate` script ensures the new Node.js environment is active.

# First, create and activate a Python virtual environment
python -m venv my_node_project
source my_node_project/bin/activate

# Install nodeenv into the active Python virtual environment
pip install nodeenv

# Create a Node.js virtual environment within the Python venv, installing a specific Node.js version
# The --python-virtualenv (-p) flag integrates it with the current Python venv
nodeenv --python-virtualenv --node=lts node_env

# Note: nodeenv modifies the activation scripts. Reactivate the Python venv
# or manually source the node_env/bin/activate script.
source my_node_project/bin/activate

# Verify Node.js and npm versions
node -v
npm -v

# Install a global npm package (e.g., `pnpm`)
npm install -g pnpm

# Deactivate the node environment when done
deactivate_node
# Then deactivate the Python virtual environment
deactivate

view raw JSON →