npm2rez 0.3.0

Convert npm packages to rez packages

npm2rez

A tool to convert Node.js packages to rez packages for VFX and animation pipeline integration.

English | 中文

Features

• Support for installing Node.js packages from npm or GitHub
• Automatically create rez-compliant package structure
• Configure correct environment variables and paths
• Support for executable creation and configuration
• Generate detailed documentation and changelogs

Installation

# Install from PyPI
pip install npm2rez
# Or use uv to install
uv pip install npm2rez

# Or install from source
git clone https://github.com/loonghao/npm2rez.git
cd npm2rez
uv pip install -e .

Usage

Basic Usage

# Run with uvx (recommended)
uvx npm2rez --name typescript --version 4.9.5 --source npm --node-version 16.14.0

# Or run directly
npm2rez --name typescript --version 4.9.5 --source npm --node-version 16.14.0

# Create package from GitHub
uvx npm2rez --name typescript --version 4.9.5 --source github --repo microsoft/TypeScript

Command Line Arguments

Parameter	Description	Default
--name	Package name	(required)
--version	Package version	(required)
--source	Package source (npm or github)	npm
--repo	GitHub repository (format: user/repo), required when source=github	None
--output	Output directory	./rez-packages
--node-version	Node.js version requirement	16
--global	Install package globally	False
--install	Install package after creation	False

Examples

Creating a TypeScript Package

npm2rez --name typescript --version 4.9.5

This will create a rez package for TypeScript version 4.9.5.

Using the Created Package

# Activate the package environment
rez env typescript-4.9.5

# Or directly run the executable
rez env typescript-4.9.5 -- tsc --version

Development

# Clone the repository
git clone https://github.com/loonghao/npm2rez.git
cd npm2rez

# Install development dependencies
uv pip install -e ".[dev]"

# Run tests
uvx nox -s pytest

# Run real package tests
uvx nox -s pytest-real-packages

# Run linting
uvx nox -s lint

License

MIT