teleop (npm)

Node-friendly entry for the same Python camera-side stack (FastAPI + RealSense + WebRTC + cloud Socket.IO client).

PyPI / pip use the name teleopsh (the teleop name was taken on PyPI). This npm package stays teleop on npmjs.

Important

• npx teleop does not remove the Python requirement. It is a small launcher that runs python -m teleop (or the teleopsh console script from pip).
• You still need Python 3.10+, Intel RealSense drivers, and pyrealsense2 wheels for your platform.

Install (Python side)

From a clone of this repo:

pip install -e .

Or, after you publish the project to PyPI under the name teleopsh:

pip install teleopsh

Run (npm)

After the Python package is installed into the same environment you point the launcher at:

npx teleop -- --cloud http://localhost:3001 --robot-id my-robot-1

The -- separates npm’s flags from the script’s; the launcher strips it before calling Python. You can also run npx teleop --cloud … if your shell does not treat flags as npm options.

Notes:

• Set TELEOP_PYTHON to a specific interpreter (e.g. C:\\path\\to\\venv\\Scripts\\python.exe on Windows).

Run (pip / Python only)

teleopsh --cloud http://localhost:3001 --robot-id my-robot-1
# or
python -m teleop --help

Publishing to npmjs

The package is teleop in packages/teleop/ (only ships the Node launcher: bin/ + this README).

One-time setup

1. Create an account on https://www.npmjs.com/signup (enable 2FA on the account; npm may require it to publish).

2. On your machine, log in (opens browser or prompts for OTP):

   npm login

3. Confirm you are logged in:

   npm whoami

4. Confirm the name is free (or that you own it): open https://www.npmjs.com/package/teleop — if it 404s, the name is available; if it shows a package, you need another name or must be added as maintainer.

5. In package.json, set repository.url (and optionally homepage, bugs) to your real Git repo URL instead of OWNER/realsense-restapi.

Dry run (see tarball contents)

cd packages/teleop
npm pack

Inspect the generated .tgz (should contain package/bin/teleop.cjs and package/README.md).

Publish

cd packages/teleop
npm publish

Unscoped packages are public by default; you do not need --access public unless you use a scoped name like @yourorg/teleop.

After publish

• Install globally: npm install -g teleop then run teleop --help.
• Without global install: npx teleop -- --cloud http://localhost:3001 --robot-id my-robot (still requires pip install teleopsh or pip install -e . so python -m teleop works).

New versions

Bump "version" in package.json (semver), commit, then npm publish again. You cannot overwrite an existing version on npm.

Verify the unscoped name teleop is still available on npm before the first publish. On PyPI, install as teleopsh.