robot-wrapper-sdk 0.2.4

Robot Platform API SDK

Robot Platform SDK (Python)

Robot Platform provides a clean‑architecture, DDD‑compliant Python SDK for interacting with the robot management backend. The SDK ships with both synchronous and asynchronous clients, automatic authentication, and token‑refresh middleware.

---

📦 Installation

pip install robot-wrapper-sdk

---

🚀 Quick start

from robot_sdk import RobotPlatformModule

# Auto‑configuration via environment variables (recommended)
#   ROBOT_PLATFORM_BASE_URL
#   ROBOT_PLATFORM_APP_ID
#   ROBOT_PLATFORM_APP_SECRET
#   ROBOT_PLATFORM_PROXY_URL (optional: socks5h://..., http://...)

sdk = RobotPlatformModule()  # reads env vars automatically

# Or manual configuration with proxy support
sdk = RobotPlatformModule(
    base_url="https://api.example.com",
    app_id="...",
    app_secret="...",
    proxy_url="socks5h://192.168.3.100:1080"
)

# Synchronous call example
robot = sdk.robot_usecase.get_robot_profile("2029943774539935744")
print(robot.platform)

# Asynchronous call example
import asyncio

async def async_demo():
    async_sdk = await RobotPlatformModule.async_init()
    robot = await async_sdk.robot_usecase.get_robot_profile_async("2029943774539935744")
    print(robot.platform)

asyncio.run(async_demo())

---

📚 Documentation

The full API reference and usage guide live in the repository:

• Guide: docs/guide.md – step‑by‑step walkthrough of all use‑cases.
• API reference is generated from type‑hints and can be inspected via help(RobotPlatformModule).

---

💡 Examples

The examples/ directory contains ready‑to‑run scripts that demonstrate common scenarios:

• examples/auth_flow.py – login, token refresh, and error handling.
• examples/robot_profile.py – fetch robot details synchronously.
• examples/async_robot_profile.py – the same operation with asyncio.

Run any example directly:

python examples/robot_profile.py

---

🛠️ Build & publish (maintainer guide)

# Create a clean virtual environment
make venv

# Install build tools
make install

# Build source and wheel distributions
make build

# Publish to PyPI (requires twine and valid credentials)
make publish

The Makefile lives in the SDK root and abstracts the above commands.

---

📄 License

MIT License – see the bundled LICENSE file.

---

This README is rendered on PyPI, so all relative links (docs/, examples/) resolve to the files shipped in the source distribution, allowing developers to browse the documentation and example code directly from the package page.