lightwheel-sdk 0.11

No project description provided

Lightwheel SDK Python

A Python SDK for interacting with the Lightwheel API to access Lightwheel assets and services.

Features

• Authentication: Secure login with credential caching
• Floorplan Loading: Download and cache USD floorplan files
• Object Loading: Load USD and MJCF objects from floorplans
• Caching: Automatic caching of downloaded files for improved performance

Installation

pip install lightwheel_sdk

Quick Start

Authentication

from lightwheel_sdk.loader import login_client

# Login interactively (will prompt for username/password)
headers = login_client.login()

# Or use environment variables
# Set LW_API_ENDPOINT, LoaderUserName, and LoaderToken
headers = login_client.get_headers()

Loading Floorplans

from lightwheel_sdk.loader import floorplan_loader

# Load a USD floorplan
future = floorplan_loader.acquire_usd(layout_id=123, style_id=456)
usd_file_path = future.result()  # Returns path to downloaded USD file

Loading Objects

from lightwheel_sdk.loader import object_loader

# Load a USD object
usd_path = object_loader.acquire_object("level1/level2/object_name", "USD")

# Load an MJCF object
mjcf_path = object_loader.acquire_object("level1/level2/object_name", "MJCF")

Configuration

Environment Variables

• LW_API_ENDPOINT: API endpoint URL (default: https://api.lightwheel.net)

Cache Locations

• Login cache: ~/.cache/lightwheel_sdk/login/
• Floorplan cache: ~/.cache/lightwheel_sdk/floorplan/
• Object cache: ~/.cache/lightwheel_sdk/object/

API Reference

Login Client

• login(force_login=False): Authenticate with the API
• get_headers(): Get authentication headers

Floorplan Loader

• acquire_usd(layout_id, style_id, scene=None, cancel_previous_download=True): Download USD floorplan
• get_usd(layout_id, style_id, scene=None): Synchronous USD download

Object Loader

• acquire_object(rel_path, file_type): Download object files (USD or MJCF)

License

Apache License 2.0

Support

For support and questions, please contact the Lightwheel team.