vuer-cli 0.0.2__tar.gz → 0.0.4__tar.gz

{vuer_cli-0.0.2 → vuer_cli-0.0.4}/.gitignore

@@ -4,6 +4,13 @@
 .idea
 # since this is public
 .run
+
+# remove the env file.
+.env
+
+# test foldders
+downloads
+
 # IDE files
 .eggs
 .tox
@@ -38,4 +45,10 @@ uv.lock
 output
 pcds
 
-.pytest_cache
+.pytest_cache
+
+# Assets folder (contains GLB models)
+assets/
+
+# MCAP output data
+mcap_outputs/

vuer_cli-0.0.4/CLAUDE.md

@@ -0,0 +1,8 @@
+
+- Release Procedure:
+1. update pip install and uv add instruction in the README to include the version tag of the current version
+2. push to latest and the version tag in git
+3. publish this version
+
+# Skills
+- params-proto: https://raw.githubusercontent.com/geyang/params-proto/main/skill/index.md

vuer_cli-0.0.4/CONTRIBUTING.md

@@ -0,0 +1,97 @@
+# Development Guide
+
+This project uses modern Python packaging with [uv](https://docs.astral.sh/uv/) and `pyproject.toml`.
+
+## Setup
+
+### Option 1: Using uv (recommended)
+
+Create a virtual environment and install dependencies:
+
+```bash
+uv sync --group dev
+```
+
+Activate the environment:
+
+```bash
+source .venv/bin/activate
+```
+
+### Option 2: Using pip
+
+Install in your current environment (conda, virtualenv, or system Python):
+
+```bash
+pip install -e ".[dev]"
+```
+
+## Common Tasks
+
+### Documentation
+
+Build documentation:
+
+```bash
+make docs
+```
+
+Preview documentation with live reload:
+
+```bash
+make preview-docs
+```
+
+The preview server will start at `http://0.0.0.0:8000`
+
+### Testing
+
+Run tests:
+
+```bash
+make test
+```
+
+### Code Quality
+
+Format code with ruff:
+
+```bash
+ruff format .
+```
+
+Lint code:
+
+```bash
+ruff check .
+```
+
+Fix linting issues automatically:
+
+```bash
+ruff check --fix .
+```
+
+## Project Structure
+
+```
+vuer/
+├── src/vuer/          # Main package source
+├── docs/              # Sphinx documentation
+├── Makefile           # Build tasks
+└── pyproject.toml     # Project configuration
+```
+
+## Publishing
+
+### Using uv (recommended)
+
+1. Update version in `pyproject.toml`
+2. Build the package: `uv build`
+3. Publish: `uv publish`
+
+### Using traditional tools
+
+1. Update version in `pyproject.toml`
+2. Build: `python -m build`
+3. Publish: `twine upload dist/*`

{vuer_cli-0.0.2 → vuer_cli-0.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vuer-cli
-Version: 0.0.2
+Version: 0.0.4
 Summary: A Python CLI for Vuer, a real-time 3D visualization library
 Project-URL: Homepage, https://github.com/vuer-ai/vuer-cli
 Project-URL: Repository, https://github.com/vuer-ai/vuer-cli
@@ -18,10 +18,16 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.8
-Requires-Dist: params-proto>=3.0.0rc9
+Requires-Dist: params-proto>=3.2.3
 Requires-Dist: requests>=2.31.0
 Requires-Dist: tqdm>=4.66.0
 Provides-Extra: all
+Requires-Dist: mcap-ros2-support>=0.5.0; extra == 'all'
+Requires-Dist: mcap>=1.1.0; extra == 'all'
+Requires-Dist: numpy>=1.24.0; extra == 'all'
+Requires-Dist: opencv-python>=4.8.0; extra == 'all'
+Requires-Dist: pandas>=2.0.0; extra == 'all'
+Requires-Dist: vuer>=0.0.79; extra == 'all'
 Provides-Extra: docs
 Requires-Dist: furo; extra == 'docs'
 Requires-Dist: myst-parser; extra == 'docs'
@@ -30,6 +36,17 @@ Requires-Dist: sphinx-copybutton; extra == 'docs'
 Requires-Dist: sphinx>=4.0; extra == 'docs'
 Requires-Dist: tomli>=1.1.0; (python_version < '3.11') and extra == 'docs'
 Provides-Extra: example
+Provides-Extra: mcap
+Requires-Dist: mcap-ros2-support>=0.5.0; extra == 'mcap'
+Requires-Dist: mcap>=1.1.0; extra == 'mcap'
+Requires-Dist: numpy>=1.24.0; extra == 'mcap'
+Requires-Dist: opencv-python>=4.8.0; extra == 'mcap'
+Requires-Dist: pandas>=2.0.0; extra == 'mcap'
+Provides-Extra: viz
+Requires-Dist: numpy>=1.24.0; extra == 'viz'
+Requires-Dist: opencv-python>=4.8.0; extra == 'viz'
+Requires-Dist: pandas>=2.0.0; extra == 'viz'
+Requires-Dist: vuer>=0.0.79; extra == 'viz'
 Description-Content-Type: text/markdown
 
 # Vuer Hub Environment Manager
@@ -41,7 +58,13 @@ software packages.
 ## Installation
 
 ```bash
-pip install vuer-cli
+pip install vuer-cli==0.0.4
+```
+
+or with uv:
+
+```bash
+uv add vuer-cli==0.0.4
 ```
 
 ## Environment Variables

{vuer_cli-0.0.2 → vuer_cli-0.0.4}/README.md

@@ -7,7 +7,13 @@ software packages.
 ## Installation
 
 ```bash
-pip install vuer-cli
+pip install vuer-cli==0.0.4
+```
+
+or with uv:
+
+```bash
+uv add vuer-cli==0.0.4
 ```
 
 ## Environment Variables

vuer_cli-0.0.4/docs/commands/add.md

@@ -0,0 +1,18 @@
+# vuer add
+
+Add an environment dependency to `environment.json` and run `sync`.
+
+## Usage
+
+```bash
+vuer add some-environment/1.2.3
+```
+
+## Behavior
+
+- Validates argument format `name/version`.
+- If `environments-lock.yaml` already contains the exact entry, the command
+  returns success without modifying `environment.json`.
+- Otherwise, it writes or updates `environment.json` and triggers `vuer sync`.
+
+

vuer_cli-0.0.4/docs/commands/index.md

@@ -0,0 +1,17 @@
+# Commands
+
+This section contains the user-facing command documentation. Each command has
+its own page linked below.
+
+```{toctree}
+:maxdepth: 1
+
+sync
+add
+remove
+upgrade
+```
+
+Use `vuer <command> --help` for per-command options.
+
+

vuer_cli-0.0.4/docs/commands/remove.md

@@ -0,0 +1,21 @@
+# vuer remove
+
+Remove an environment dependency from `environment.json` and run `sync`.
+
+## Usage
+
+```bash
+vuer remove some-environment/1.2.3
+```
+
+## Behavior
+
+- Requires `name/version` argument.
+- Only removes the dependency entry if the name and version exactly match the
+  current `environment.json` entry for that name.
+- Triggers `vuer sync` to reconcile local cache.
+
+If removing the last version directory for an environment, `sync` will also
+remove the empty parent `vuer_environments/<name>/` directory.
+
+

vuer_cli-0.0.4/docs/commands/sync.md

@@ -0,0 +1,31 @@
+# vuer sync
+
+Synchronize `environment.json` dependencies with the local cache (`vuer_environments/`).
+
+## Usage
+
+```bash
+vuer sync
+
+# Or specify output directory (optional)
+vuer sync --output ./vuer_environments
+```
+
+## Behavior
+
+1. Locate `environment.json` in the current working directory. If missing, the
+   command fails with an error.
+
+2. Parse `dependencies` and expand transitive dependencies via the backend.
+
+3. Deduplicate and write resolved dependencies to `environments-lock.yaml`.
+
+4. Download missing environments into `vuer_environments/<name>/<version>`.
+   Existing version directories listed in the lockfile are skipped.
+
+5. Remove version directories that are no longer present in the new lockfile.
+
+Dry-run mode (`VUER_CLI_DRY_RUN`) simulates validation and downloading without
+performing network calls.
+
+

vuer_cli-0.0.4/docs/commands/upgrade.md

@@ -0,0 +1,18 @@
+# vuer upgrade
+
+Upgrade a named environment to the latest version available in the backend.
+
+## Usage
+
+```bash
+vuer upgrade some-environment-name
+```
+
+## Behavior
+
+1. Read `environment.json` and locate the dependency by name.
+2. Call backend `/environments/latest-by-name?name=<name>` to fetch latest
+   `versionId`.
+3. If the latest version differs, update `environment.json` and trigger `vuer sync`.
+
+

vuer_cli-0.0.4/docs/concepts.md

@@ -0,0 +1,58 @@
+# Core concepts
+
+This page explains the main concepts used by Vuer CLI.
+
+## Environment Configuration File: `environment.json`
+
+Maintain an `environment.json` file in your project root directory to declare
+the list of environments your project depends on, similar to `package.json` in
+Node.js.
+
+**Example:**
+
+```json
+{
+  "dependencies": {
+    "some-dependency": "^1.2.3",
+    "another-dependency": "~4.5.6",
+    "new-dependency": "0.1.0"
+  }
+}
+```
+
+**`dependencies` field:**
+
+- **Key**: Environment name (e.g., `some-dependency`)
+- **Value**: Version expression (e.g., `^1.2.3`, `~4.5.6`, etc.)
+
+## Local cache: `vuer_environments/`
+
+`vuer sync` downloads direct and transitive dependencies into the
+`vuer_environments/` directory in the project root. Each environment uses a
+nested directory layout `vuer_environments/<name>/<version>`.
+
+Downloaded environment directories may contain their own `environment.json`;
+the CLI preserves these per-version metadata files.
+
+## Dependency index: `environments-lock.yaml`
+
+`vuer sync` generates `environments-lock.yaml` (next to `vuer_environments/`)
+as a system-maintained lockfile that records resolved and deduplicated
+environment dependencies. Do not edit it manually.
+
+Minimal example:
+
+```yaml
+environments:
+  - "some-dependency/^1.2.3"
+  - "another-dependency/~4.5.6"
+```
+
+## Environment variables
+
+- `VUER_HUB_URL` — Base URL of Vuer Hub API (required in non-dry-run)
+- `VUER_AUTH_TOKEN` — JWT token for API access (required in non-dry-run)
+- `VUER_CLI_DRY_RUN` — Enable dry-run mode (any non-"0"/"false" value enables
+  it)
+
+