feat: implements initial sync for v2 APIs

.github/CODEOWNERS

@@ -0,0 +1 @@
+* @rapyuta-robotics/io-cli-owner @rapyuta-robotics/io-first-reviewer

.github/workflows/conventional-commits.yml

@@ -0,0 +1,20 @@
+name: 💬 Check Commit Hygiene
+
+on:
+  pull_request:
+    branches:
+      - main
+      - devel
+
+jobs:
+  verify:
+    name: Conventional Commits
+    runs-on: ubuntu-22.04
+    steps:
+    - uses: actions/checkout@v3
+      name: Checkout code
+
+    - uses: rapyuta-robotics/[email protected]
+      name: Check if commit messages are compliant
+      with:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/lint-check.yml

@@ -0,0 +1,13 @@
+name: "🧹 Ruff"
+
+on: [pull_request]
+
+jobs:
+    lint:
+        name: Lint Check
+        runs-on: ubuntu-22.04
+        steps:
+        - uses: actions/checkout@v4
+        - uses: chartboost/ruff-action@v1
+          with:
+            args: "check"

.gitignore

@@ -0,0 +1,11 @@
+# python generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# venv
+.venv
+.ruff_cache

.python-version

@@ -0,0 +1 @@
+3.12.5

CONTRIBUTING.md

@@ -0,0 +1,38 @@
+# Contribution Guidelines
+## 🌟 Setup Your Development Environment
+
+The project uses [uv](https://docs.astral.sh/uv/) for development. It needs to be installed to set up the development environment.
+
+```bash
+curl -LsSf https://astral.sh/uv/install.sh | sh
+```
+
+Once `uv` is installed, a Python virtual environment can be quickly bootstrapped by running the following commands in the root of the repository:
+
+```bash
+uv venv
+source .venv/bin/activate
+```
+
+This will create a virtual environment in the `.venv` directory and activate it.
+
+Next, install all dependencies using the following command:
+
+```bash
+uv sync
+```
+
+New dependencies can be installed directly using `uv`. This modifies the `pyproject.toml` and `uv.lock`.
+
+```bash
+uv add <package-name>
+```
+
+### 🛠️ Linting and Formatting
+
+You can check and fix the code style by running the following commands:
+
+```bash
+uvx ruff check --fix
+uvx ruff format
+```

README.md

@@ -0,0 +1,13 @@
+# Rapyuta IO SDK v2
+Rapyuta IO SDK v2 provides a comprehensive set of tools and functionalities to interact with the Rapyuta Robotics platform.
+
+## Key Features
+
+- 🚀 **Improved API Integration**: Seamless integration with Rapyuta Robotics APIs.
+- ⚡ **Enhanced Performance**: Optimized for better performance and reduced latency.
+- 🛠️ **Extended Functionality**: New modules and functions to support advanced robotics applications.
+- 📚 **Better Documentation**: Comprehensive and easy-to-follow documentation.
+
+## Contributing
+
+We welcome contributions! Please read our [contributing guidelines](CONTRIBUTING.md) to get started.

pyproject.toml

@@ -0,0 +1,24 @@
+[project]
+name = "rapyuta-io-sdk-v2"
+version = "0.1.0"
+description = "Version:2 for Rapyuta.io SDK"
+dependencies = [
+    "httpx>=0.27.2",
+    "tenacity>=9.0.0",
+]
+readme = "README.md"
+requires-python = ">= 3.8"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.rye]
+managed = true
+dev-dependencies = []
+
+[tool.hatch.metadata]
+allow-direct-references = true
+
+[tool.hatch.build.targets.wheel]
+packages = ["rapyuta_io_sdk_v2"]

rapyuta_io_sdk_v2/__init__.py

@@ -0,0 +1 @@
+# from rapyuta_io_sdk_v2.config import Configuration

rapyuta_io_sdk_v2/async_client.py

@@ -0,0 +1,46 @@
+# -*- coding: utf-8 -*-
+# Copyright 2024 Rapyuta Robotics
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+from contextlib import asynccontextmanager
+from typing import AsyncGenerator
+
+import httpx
+
+from rapyuta_io_sdk_v2.client import Client
+from rapyuta_io_sdk_v2.utils import handle_server_errors
+
+
+class AsyncClient(Client):
+    def __init__(self, config):
+        super().__init__(config)
+
+    @asynccontextmanager
+    async def _get_client(self) -> AsyncGenerator[httpx.AsyncClient, None]:
+        async with httpx.AsyncClient(
+            headers=self._get_headers(),
+        ) as async_client:
+            yield async_client
+
+    @staticmethod
+    async def get_token(self, email: str, password: str) -> str:
+        url = "{}/user/login/".format(self.v2api_host)
+        headers = {"Content-Type": "application/json"}
+        data = {"email": email, "password": password}
+        response = httpx.post(url=url, headers=headers, json=data, timeout=10)
+        handle_server_errors(response)
+        return response.json().get("token")
+
+    @staticmethod
+    async def expire_token(token: str) -> None:
+        pass

rapyuta_io_sdk_v2/client.py

@@ -0,0 +1,77 @@
+# -*- coding: utf-8 -*-
+# Copyright 2024 Rapyuta Robotics
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+from typing import Dict, Optional
+
+import httpx
+
+from rapyuta_io_sdk_v2.config import Configuration
+from rapyuta_io_sdk_v2.constants import GET_USER_PATH
+from rapyuta_io_sdk_v2.utils import handle_server_errors
+
+
+class Client(object):
+    PROD_V2API_URL = "https://api.rapyuta.io"
+
+    def __init__(self, config: Configuration = None):
+        self.config = config
+        self.v2api_host = config.hosts.get("v2api_host", self.PROD_V2API_URL)
+
+    def _get_headers(self, with_project: bool = True) -> dict:
+        headers = {
+            "Authorization": "Bearer " + self.config.auth_token,
+            "Content-Type": "application/json",
+            "project": self.config.project_guid,
+            "organizationguid": self.config.organization_guid,
+        }
+        return headers
+
+    def get_authenticated_user(self) -> Optional[Dict]:
+        try:
+            _core_api_host = self.config.hosts.get("core_api_host")
+            url = "{}{}".format(_core_api_host, GET_USER_PATH)
+            headers = self._get_headers()
+            response = httpx.get(url=url, headers=headers, timeout=10)
+            handle_server_errors(response)
+            return response.json()
+        except Exception:
+            raise
+
+    @staticmethod
+    def get_token(self, email: str, password: str) -> str:
+        """Get the authentication token for the user.
+
+        Args:
+            email (str)
+            password (str)
+
+        Returns:
+            str: authentication token
+        """
+        url = "{}/user/login/".format(self.v2api_host)
+        headers = {"Content-Type": "application/json"}
+        data = {"email": email, "password": password}
+        response = httpx.post(url=url, headers=headers, json=data, timeout=10)
+        handle_server_errors(response)
+        return response.json().get("token")
+
+    @staticmethod
+    def expire_token(token: str) -> None:
+        pass
+
+    def set_project(self, project_guid: str):
+        self.config.project_guid = project_guid
+
+    def set_organization(self, organization_guid: str):
+        self.config.organization_guid = organization_guid

rapyuta_io_sdk_v2/config.py

@@ -0,0 +1,92 @@
+# -*- coding: utf-8 -*-
+# Copyright 2024 Rapyuta Robotics
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+import json
+from dataclasses import dataclass
+
+from rapyuta_io_sdk_v2.constants import (
+    NAMED_ENVIRONMENTS,
+    PROD_ENVIRONMENT_SUBDOMAIN,
+    STAGING_ENVIRONMENT_SUBDOMAIN,
+)
+from rapyuta_io_sdk_v2.exceptions import (
+    ValidationError,
+)
+
+
+@dataclass
+class Configuration(object):
+    email: str
+    _password: str
+    auth_token: str
+    project_guid: str
+    organization_guid: str
+    environment: str = "ga"  # Default environment is prod
+
+    def __init__(
+        self,
+        project_guid: str,
+        organization_guid: str,
+        password: str = None,
+        auth_token: str = None,
+        environment: str = None,
+        email: str = None,
+    ):
+        self.email = email
+        self._password = password
+        self.auth_token = auth_token
+        self.project_guid = project_guid
+        self.organization_guid = organization_guid
+        self.environment = environment
+        self.hosts = {}
+        self.set_environment(environment)
+
+    @staticmethod
+    def from_file(self, file_path: str) -> "Configuration":
+        with open(file_path, "r") as file:
+            data = json.load(file)
+            return Configuration(
+                email=data.get("email"),
+                password=data.get("password"),
+                project_guid=data.get("project_guid"),
+                organization_guid=data.get("organization_guid"),
+                environment=data.get("environment"),
+            )
+
+    def set_project(self, project) -> None:
+        self.project_guid = project
+
+    def set_organization(self, organization_guid) -> None:
+        self.organization_guid = organization_guid
+
+    def set_environment(self, name: str) -> None:
+        subdomain = PROD_ENVIRONMENT_SUBDOMAIN
+        if name is not None:
+            is_valid_env = name in NAMED_ENVIRONMENTS or name.startswith("pr")
+            if not is_valid_env:
+                raise ValidationError("Invalid environment")
+            subdomain = STAGING_ENVIRONMENT_SUBDOMAIN
+        else:
+            name = "ga"
+
+        catalog = "https://{}catalog.{}".format(name, subdomain)
+        core = "https://{}apiserver.{}".format(name, subdomain)
+        rip = "https://{}rip.{}".format(name, subdomain)
+        v2api = "https://{}api.{}".format(name, subdomain)
+
+        self.hosts["environment"] = name
+        self.hosts["catalog_host"] = catalog
+        self.hosts["core_api_host"] = core
+        self.hosts["rip_host"] = rip
+        self.hosts["v2api_host"] = v2api

rapyuta_io_sdk_v2/constants.py

@@ -0,0 +1,22 @@
+# -*- coding: utf-8 -*-
+# Copyright 2024 Rapyuta Robotics
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+LOGIN_ROUTE_PATH = "/user/login"
+GET_USER_PATH = "/api/user/me/get"
+
+
+STAGING_ENVIRONMENT_SUBDOMAIN = "apps.okd4v2.okd4beta.rapyuta.io"
+PROD_ENVIRONMENT_SUBDOMAIN = "apps.okd4v2.prod.rapyuta.io"
+NAMED_ENVIRONMENTS = ["v11", "v12", "v13", "v14", "v15", "qa", "dev"]