Skip to main content

Installation

Prerequisites​

  • Python 3.10 or higher
  • pip package manager

Install from PyPI​

Install the Lightwheel SDK using pip:

pip install lightwheel-sdk

Install from Source​

If you want to install from the source code:

git clone https://github.com/lightwheel/lightwheel_sdk_py.git
cd lightwheel_sdk_py
pip install -e .

Install with Development Dependencies​

For development work, install with test dependencies:

pip install lightwheel-sdk[test]

Verify Installation​

Verify that the SDK is installed correctly:

python -c "import lightwheel_sdk; print('Lightwheel SDK installed successfully')"

Or check the CLI tool:

lwsdk --version

Dependencies​

The SDK requires the following dependencies (automatically installed):

  • requests - HTTP library for API calls
  • tqdm - Progress bar for downloads
  • termcolor - Colored terminal output
  • pyyaml - YAML parsing for scenes
  • click - CLI framework

Next Steps​

After installation, proceed to the Quick Start guide to learn how to use the SDK.