sima-cli 0.0.11__tar.gz

sima_cli-0.0.11/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 SiMa.ai
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the “Software”), to deal
+in the Software without restriction, including without limitation the rights 
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 
+copies of the Software, and to permit persons to whom the Software is 
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in 
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 
+THE SOFTWARE.

sima_cli-0.0.11/MANIFEST.in

@@ -0,0 +1,13 @@
+include README.md
+include LICENSE
+include requirements.txt
+
+# Include all Python source files
+recursive-include sima_cli *.py
+
+recursive-include tests *.py
+
+include pyproject.toml
+include setup.cfg
+include setup.py
+include sima_cli/data/resources.yaml

sima_cli-0.0.11/PKG-INFO

@@ -0,0 +1,182 @@
+Metadata-Version: 2.4
+Name: sima-cli
+Version: 0.0.11
+Summary: CLI tool for SiMa Developer Portal to download models, firmware, and apps.
+Home-page: https://developer.sima.ai/
+Author: SiMa.ai
+Author-email: "Sima.ai" <support@sima.ai>
+License-Expression: MIT
+Project-URL: Homepage, https://developer.sima.ai/
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Environment :: Console
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests
+Requires-Dist: click
+Requires-Dist: tqdm
+Requires-Dist: pyyaml
+Requires-Dist: paramiko
+Dynamic: author
+Dynamic: license-file
+Dynamic: requires-python
+
+# 🛠️ sima-cli – SiMa Developer Portal CLI Tool
+
+`sima-cli` is a command-line interface (CLI) utility designed to interact with the SiMa Developer Portal. It supports downloading models and apps from the Model/App Zoo, performing firmware updates, and authenticating against internal or external environments.
+
+---
+
+## 📦 Installation
+
+```bash
+pip install sima-cli
+```
+
+---
+
+## 🚀 Getting Started
+
+```bash
+sima-cli --help
+```
+
+### Global Option
+
+- `--internal`: Use internal Artifactory resources (can also be set via `SIMA_CLI_INTERNAL=1`).
+
+Environment detection output will appear like:
+
+```
+🔧 Environment: dev (sandbox) | Internal: True
+```
+
+If external mode is detected and not supported:
+
+```
+external environment is not supported yet..
+```
+
+---
+
+## 🔐 Authentication
+
+```bash
+sima-cli login
+```
+
+Authenticates with the SiMa Developer Portal. Internal or external login is selected based on context.
+
+---
+
+## 📥 Download Resources
+
+```bash
+sima-cli download <URL> [-d DEST]
+```
+
+- Downloads a single file or an entire folder from the provided URL.
+- Options:
+  - `-d`, `--dest`: Destination folder (default is current directory).
+
+---
+
+## 🔧 Firmware Update
+
+```bash
+sima-cli update <version_or_url> [--ip IP] [--board BOARD] [--passwd PASSWORD]
+```
+
+- Updates firmware either locally or over the network.
+- Positional:
+  - `<version_or_url>`: Version string (e.g. `1.5.0`) or direct URL.
+- Options:
+  - `--ip`: IP address of remote device (for network update).
+  - `--board`: Board type, one of `davinci`, `modalix` (default: `davinci`).
+  - `--passwd`: SSH password for remote board (default: `edgeai`).
+
+---
+
+## 🧠 Model Zoo
+
+### List Models
+
+```bash
+sima-cli model-zoo list [--ver VERSION]
+```
+
+- Lists available models for a given SDK version.
+
+### Get Model
+
+```bash
+sima-cli model-zoo get <MODEL_NAME> [--ver VERSION]
+```
+
+- Downloads the specified model.
+
+---
+
+## 📱 App Zoo
+
+### List Apps
+
+```bash
+sima-cli app-zoo list [--ver VERSION]
+```
+
+- Lists available apps for a given SDK version.
+
+### Get App
+
+```bash
+sima-cli app-zoo get <APP_NAME> [--ver VERSION]
+```
+
+- Downloads the specified app.
+
+---
+
+## 🌍 Environment Variable Support
+
+Instead of using `--internal` flag every time, you can set:
+
+```bash
+export SIMA_CLI_INTERNAL=1
+```
+
+---
+
+## 🧪 Examples
+
+### Authenticate Internally
+
+```bash
+sima-cli --internal login
+```
+
+
+### Firmware Update on Davinci (MLSOC Gen 1) Board
+
+```bash
+sima-cli update 1.6.0_master_B1611 --ip 192.168.1.20
+```
+
+---
+
+## 🧩 Requirements
+
+- Python 3.8+
+- Internal network access if using `--internal` features
+
+---
+
+## 📞 Support
+
+Please reach out to **SiMa Support** (support@sima.ai) if you encounter issues with downloads or updates.
+
+---

sima_cli-0.0.11/README.md

@@ -0,0 +1,155 @@
+# 🛠️ sima-cli – SiMa Developer Portal CLI Tool
+
+`sima-cli` is a command-line interface (CLI) utility designed to interact with the SiMa Developer Portal. It supports downloading models and apps from the Model/App Zoo, performing firmware updates, and authenticating against internal or external environments.
+
+---
+
+## 📦 Installation
+
+```bash
+pip install sima-cli
+```
+
+---
+
+## 🚀 Getting Started
+
+```bash
+sima-cli --help
+```
+
+### Global Option
+
+- `--internal`: Use internal Artifactory resources (can also be set via `SIMA_CLI_INTERNAL=1`).
+
+Environment detection output will appear like:
+
+```
+🔧 Environment: dev (sandbox) | Internal: True
+```
+
+If external mode is detected and not supported:
+
+```
+external environment is not supported yet..
+```
+
+---
+
+## 🔐 Authentication
+
+```bash
+sima-cli login
+```
+
+Authenticates with the SiMa Developer Portal. Internal or external login is selected based on context.
+
+---
+
+## 📥 Download Resources
+
+```bash
+sima-cli download <URL> [-d DEST]
+```
+
+- Downloads a single file or an entire folder from the provided URL.
+- Options:
+  - `-d`, `--dest`: Destination folder (default is current directory).
+
+---
+
+## 🔧 Firmware Update
+
+```bash
+sima-cli update <version_or_url> [--ip IP] [--board BOARD] [--passwd PASSWORD]
+```
+
+- Updates firmware either locally or over the network.
+- Positional:
+  - `<version_or_url>`: Version string (e.g. `1.5.0`) or direct URL.
+- Options:
+  - `--ip`: IP address of remote device (for network update).
+  - `--board`: Board type, one of `davinci`, `modalix` (default: `davinci`).
+  - `--passwd`: SSH password for remote board (default: `edgeai`).
+
+---
+
+## 🧠 Model Zoo
+
+### List Models
+
+```bash
+sima-cli model-zoo list [--ver VERSION]
+```
+
+- Lists available models for a given SDK version.
+
+### Get Model
+
+```bash
+sima-cli model-zoo get <MODEL_NAME> [--ver VERSION]
+```
+
+- Downloads the specified model.
+
+---
+
+## 📱 App Zoo
+
+### List Apps
+
+```bash
+sima-cli app-zoo list [--ver VERSION]
+```
+
+- Lists available apps for a given SDK version.
+
+### Get App
+
+```bash
+sima-cli app-zoo get <APP_NAME> [--ver VERSION]
+```
+
+- Downloads the specified app.
+
+---
+
+## 🌍 Environment Variable Support
+
+Instead of using `--internal` flag every time, you can set:
+
+```bash
+export SIMA_CLI_INTERNAL=1
+```
+
+---
+
+## 🧪 Examples
+
+### Authenticate Internally
+
+```bash
+sima-cli --internal login
+```
+
+
+### Firmware Update on Davinci (MLSOC Gen 1) Board
+
+```bash
+sima-cli update 1.6.0_master_B1611 --ip 192.168.1.20
+```
+
+---
+
+## 🧩 Requirements
+
+- Python 3.8+
+- Internal network access if using `--internal` features
+
+---
+
+## 📞 Support
+
+Please reach out to **SiMa Support** (support@sima.ai) if you encounter issues with downloads or updates.
+
+---

sima_cli-0.0.11/pyproject.toml

@@ -0,0 +1,36 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "sima-cli"
+version = "0.0.11"
+description = "CLI tool for SiMa Developer Portal to download models, firmware, and apps."
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+authors = [
+  { name="Sima.ai", email="support@sima.ai" }
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Build Tools",
+    "Environment :: Console",
+]
+
+dependencies = [
+    "requests",
+    "click", 
+    "tqdm",
+    "pyyaml",
+    "paramiko"
+]
+
+[project.urls]
+Homepage = "https://developer.sima.ai/"
+
+[project.scripts]
+sima-cli = "sima_cli.cli:main"

sima_cli-0.0.11/requirements.txt

@@ -0,0 +1,5 @@
+click>=8.0
+requests>=2.25
+tqdm>=4.64
+pyyaml>=6.0
+paramiko>=3.5.1

sima_cli-0.0.11/setup.cfg

@@ -0,0 +1,38 @@
+[metadata]
+name = sima-cli
+author = Sima.ai
+author_email = support@sima.ai
+description = CLI tool for SiMa Developer Portal to download models, firmware, and apps.
+long_description = file: README.md
+long_description_content_type = text/markdown
+url = https://developer.sima.ai/
+license = MIT
+classifiers = 
+	Programming Language :: Python :: 3
+	Operating System :: OS Independent
+	Development Status :: 3 - Alpha
+	Environment :: Console
+	Intended Audience :: Developers
+	Topic :: Software Development :: Build Tools
+
+[options]
+packages = find:
+python_requires = >=3.10
+install_requires = 
+	click
+	requests
+
+[options.entry_points]
+console_scripts = 
+	sima-cli = sima_cli.cli:main
+
+[options.package_data]
+* = *.txt, *.md
+
+[sdist]
+formats = gztar
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

sima_cli-0.0.11/setup.py

@@ -0,0 +1,27 @@
+from setuptools import setup, find_packages
+from pathlib import Path
+
+# Load version from sima_cli/__version__.py
+version_path = Path(__file__).parent / "sima_cli" / "__version__.py"
+version_ns = {}
+exec(version_path.read_text(), version_ns)
+
+setup(
+    name="sima-cli",
+    version=version_ns["__version__"],
+    description="SiMa Developer Portal CLI Tool",
+    author="SiMa.ai",
+    packages=find_packages(),
+    include_package_data=True,
+    install_requires=[
+        "click>=8.0",
+        "requests>=2.25",
+        "tqdm>=4.64"
+    ],
+    entry_points={
+        "console_scripts": [
+            "sima-cli=sima_cli.__main__:main"
+        ]
+    },
+    python_requires=">=3.10",
+)

sima_cli-0.0.11/sima_cli/__init__.py

@@ -0,0 +1,12 @@
+"""
+sima_cli - SiMa Developer CLI Tool
+
+This package provides the command-line interface for interacting with
+the SiMa Developer Portal. Functionality includes authentication, model
+and firmware downloads, and device updates.
+
+To get started, run: `sima-cli help`
+"""
+from .__version__ import __version__
+
+__all__ = ["__version__"]

sima_cli-0.0.11/sima_cli/__main__.py

@@ -0,0 +1,4 @@
+from sima_cli.cli import main
+
+if __name__ == "__main__":
+    main()

sima_cli-0.0.11/sima_cli/__version__.py

@@ -0,0 +1,2 @@
+# sima_cli/__version__.py
+__version__ = "0.0.11"

sima_cli-0.0.11/sima_cli/auth/login.py

@@ -0,0 +1,103 @@
+import click
+import getpass
+import requests
+from sima_cli.utils.config import set_auth_token, get_auth_token
+from sima_cli.utils.config_loader import load_resource_config
+from sima_cli.utils.artifactory import exchange_identity_token, validate_token
+
+def login(method: str = "external"):
+    """
+    Dispatch login based on the specified method.
+
+    Args:
+        method (str): 'external' (public developer portal) or 'internal' (Artifactory).
+    """
+    if method == "internal":
+        return login_internal()
+    else:
+        return login_external()
+
+def login_internal():
+    """
+    Internal login using a manually provided identity token.
+
+    Flow:
+    1. Prompt for identity token.
+    2. Validate the token using the configured validation URL.
+    3. If valid, exchange it for a short-lived access token.
+    4. Save the short-lived token to local config.
+    """
+
+    cfg = load_resource_config()
+    auth_cfg = cfg.get("internal", {}).get("auth", {})
+    base_url = cfg.get("internal", {}).get("artifactory", {}).get("url", {})
+    validate_url = f"{base_url}/{auth_cfg.get("validate_url")}"
+    exchange_url = f"{base_url}/{auth_cfg.get("internal_url")}"
+
+    # Check for required config values
+    if not validate_url or not exchange_url:
+        click.echo("❌ Missing 'validate_url' or 'internal_url' in internal auth config.")
+        click.echo("👉 Please check ~/.sima-cli/resources_internal.yaml")
+        return
+
+    # Prompt for identity token
+    click.echo("🔐 Paste your Artifactory identity token below.")
+    identity_token = click.prompt("Identity Token", hide_input=True)
+
+    if not identity_token or len(identity_token.strip()) < 10:
+        return click.echo("❌ Invalid or empty token.")
+
+    # Step 1: Validate the identity token
+    is_valid, username = validate_token(identity_token, validate_url)
+    if not is_valid:
+        return click.echo("❌ Token validation failed. Please check your identity token.")
+
+    click.echo(f"✅ Identity token is valid")
+
+    # Step 2: Exchange for a short-lived access token (default: 7 days)
+    access_token, user_name = exchange_identity_token(identity_token, exchange_url, expires_in=604800)
+
+    if not access_token:
+        return click.echo("❌ Failed to acquire short-lived access token.")
+
+    # Step 3: Save token to internal auth config
+    set_auth_token(access_token, internal=True)
+    click.echo(f"💾 Short-lived access token saved successfully for {user_name} (valid for 7 days).")
+
+
+def login_external():
+    """
+    External login using Developer Portal endpoint defined in the 'public' section of YAML config.
+    Prompts for username/password and retrieves access token.
+    """
+    cfg = load_resource_config()
+    auth_url = cfg.get("public", {}).get("auth", {}).get("external_url")
+
+    if not auth_url:
+        click.echo("❌ External auth URL not configured in YAML.")
+        return
+
+    click.echo("🌐 Logging in using external Developer Portal...")
+
+    # Prompt for credentials
+    username = click.prompt("Email or Username")
+    password = getpass.getpass("Password: ")
+
+    data = {
+        "username": username,
+        "password": password
+    }
+
+    try:
+        response = requests.post(auth_url, json=data)
+        response.raise_for_status()
+
+        token = response.json().get("access_token")
+        if not token:
+            return click.echo("❌ Failed to retrieve access token.")
+
+        set_auth_token(token)
+        click.echo("✅ External login successful.")
+
+    except requests.RequestException as e:
+        click.echo(f"❌ External login failed: {e}")