remotivelabs-cli 0.2.1__tar.gz → 0.2.2__tar.gz

{remotivelabs_cli-0.2.1 → remotivelabs_cli-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: remotivelabs-cli
-Version: 0.2.1
+Version: 0.2.2
 Summary: CLI for operating RemotiveCloud and RemotiveBroker
 Author: Johan Rask
 Author-email: johan.rask@remotivelabs.com
@@ -13,9 +13,11 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: click (<8.2.0)
 Requires-Dist: dacite (>=1.9.2,<2.0.0)
+Requires-Dist: email-validator (>=2.2.0,<3.0.0)
 Requires-Dist: grpc-stubs (>=1.53.0.5)
 Requires-Dist: mypy-protobuf (>=3.0.0)
 Requires-Dist: plotext (>=5.2,<6.0)
+Requires-Dist: pydantic (>=2.11.7,<3.0.0)
 Requires-Dist: pyjwt (>=2.6,<3.0)
 Requires-Dist: python-can (>=4.3.1)
 Requires-Dist: python-socketio (>=4.6.1)

{remotivelabs_cli-0.2.1 → remotivelabs_cli-0.2.2}/cli/remotive.py

@@ -20,6 +20,7 @@ from cli.settings.migration.migrate_legacy_dirs import migrate_legacy_settings_d
 from cli.tools.tools import app as tools_app
 from cli.topology.cmd import app as topology_app
 from cli.typer import typer_utils
+from cli.utils.version_check import check_for_update
 
 err_console = Console(stderr=True)
 
@@ -46,7 +47,6 @@ def version_callback(value: bool) -> None:
     if value:
         my_version = version("remotivelabs-cli")
         typer.echo(my_version)
-        raise typer.Exit()
 
 
 def test_callback(value: int) -> None:
@@ -55,6 +55,10 @@ def test_callback(value: int) -> None:
         raise typer.Exit()
 
 
+def check_for_newer_version(settings: Settings) -> None:
+    check_for_update("remotivelabs-cli", version("remotivelabs-cli"), settings)
+
+
 def run_migrations(settings: Settings) -> None:
     """
     Run all migration scripts.
@@ -91,11 +95,12 @@ def main(
         None,
         "--version",
         callback=version_callback,
-        is_eager=False,
+        is_eager=True,
         help="Print current version",
     ),
 ) -> None:
     run_migrations(settings)
+    check_for_newer_version(settings)
     set_default_org_as_env(settings)
     # Do other global stuff, handle other global options here
 

{remotivelabs_cli-0.2.1 → remotivelabs_cli-0.2.2}/cli/settings/core.py

@@ -7,20 +7,21 @@ from json import JSONDecodeError
 from pathlib import Path
 from typing import Optional, Tuple
 
+from pydantic import ValidationError
 from rich.console import Console
 
 from cli.errors import ErrorPrinter
 from cli.settings import config_file, token_file
 from cli.settings import token_file as tf
 from cli.settings.config_file import ConfigFile
+from cli.settings.state_file import StateFile
 from cli.settings.token_file import TokenFile
 
 err_console = Console(stderr=True)
 
-
 CONFIG_DIR_PATH = Path.home() / ".config" / "remotive"
 CLI_CONFIG_FILE_NAME = "config.json"
-
+CLI_INTERNAL_STATE_FILE_NAME = "app-state.json"
 
 TokenFileMetadata = Tuple[TokenFile, Path]
 
@@ -46,6 +47,10 @@ class Settings:
         self.config_file_path = self.config_dir / CLI_CONFIG_FILE_NAME
         if not self.config_file_path.exists():
             self._write_config_file(ConfigFile())
+        self.state_dir = self.config_dir / "state"
+        self.state_file_path = self.state_dir / CLI_INTERNAL_STATE_FILE_NAME
+        if not self.state_file_path.exists():
+            self.write_state_file(StateFile())
 
     def set_default_organisation(self, organisation: str) -> None:
         cli_config = self.get_cli_config()
@@ -166,6 +171,15 @@ class Settings:
 
         return file
 
+    def read_state_file(self) -> StateFile:
+        try:
+            return StateFile.loads(self.state_file_path.read_text(encoding="utf-8"))
+        except Exception:
+            return StateFile()
+
+    def write_state_file(self, state_file: StateFile) -> None:
+        self._write_file(self.state_file_path, state_file.dumps())
+
     def list_personal_tokens(self) -> list[TokenFile]:
         """
         List all personal tokens
@@ -234,7 +248,7 @@ class Settings:
             try:
                 self._read_token_file(path)
                 return True
-            except JSONDecodeError:
+            except (JSONDecodeError, ValidationError):
                 # TODO - this should be printed but printing it here causes it to be displayed to many times
                 # err_console.print(f"File is not valid json, skipping. {path}")
                 return False

remotivelabs_cli-0.2.2/cli/settings/state_file.py

@@ -0,0 +1,32 @@
+from __future__ import annotations
+
+import dataclasses
+import json
+from dataclasses import dataclass
+from datetime import datetime
+from typing import Optional
+
+from dacite import from_dict
+
+from cli.utils.time import parse_datetime
+
+
+@dataclass
+class StateFile:
+    version: str = "1.0"
+    last_update_check_time: Optional[str] = None
+
+    def dumps(self) -> str:
+        return json.dumps(dataclasses.asdict(self), default=str)
+
+    def should_perform_update_check(self) -> bool:
+        if self.last_update_check_time:
+            seconds = (datetime.now() - parse_datetime(self.last_update_check_time)).seconds
+            return (seconds / 3600) > 2
+        # This will solve the issue
+        return True
+
+    @staticmethod
+    def loads(data: str) -> StateFile:
+        d = json.loads(data)
+        return from_dict(StateFile, d)

remotivelabs_cli-0.2.2/cli/settings/token_file.py

@@ -0,0 +1,136 @@
+from __future__ import annotations
+
+import re
+from datetime import date, datetime
+from typing import Any, Literal
+
+from pydantic import BaseModel, EmailStr, Field, field_validator, model_validator
+
+from cli.utils.time import parse_date
+
+DEFAULT_EMAIL = "unknown@remotivecloud.com"
+PERSONAL_TOKEN_FILE_PREFIX = "personal-token-"
+SERVICE_ACCOUNT_TOKEN_FILE_PREFIX = "service-account-token-"
+
+TokenType = Literal["authorized_user", "service_account"]
+
+
+def _email_to_safe_filename(email: str) -> str:
+    """Replace any invalid character with an underscore"""
+    return re.sub(r'[<>:"/\\|?*]', "_", email)
+
+
+def _parse_token_type(token: str) -> TokenType:
+    if token.startswith("pa"):
+        return "authorized_user"
+    if token.startswith("sa"):
+        return "service_account"
+    raise ValueError(f"Unknown token type for token: {token}")
+
+
+class TokenFileAccount(BaseModel):
+    email: EmailStr = DEFAULT_EMAIL
+
+
+class TokenFile(BaseModel):
+    version: str = "1.0"
+    type: TokenType
+    name: str
+    token: str
+    created: date
+    expires: date
+    account: TokenFileAccount = Field(default_factory=TokenFileAccount)
+
+    @field_validator("created", "expires", mode="before")
+    @classmethod
+    def validate_parse_date(cls, value: str | date) -> date:
+        if isinstance(value, date):
+            return value
+        return parse_date(value)
+
+    @model_validator(mode="before")
+    @classmethod
+    def init_with_defaults(cls, json_data: Any) -> Any:
+        """
+        Try to migrate old formats and missing fields as best we can.
+
+        NOTE: If we ever need to add a new version (like 2.0), we should add explicit classes for each version (e.g. TokenFileV1,
+        TokenFileV2, etc.), each with their own fields. This will allow us to migrate to new versions without breaking
+        backwards compatibility.
+        """
+        if not isinstance(json_data, dict):
+            return json_data
+
+        if "version" not in json_data:
+            json_data["version"] = "1.0"
+
+        if "type" not in json_data and "token" in json_data:
+            json_data["type"] = _parse_token_type(json_data["token"])
+
+        if "account" not in json_data:
+            json_data["account"] = {"email": DEFAULT_EMAIL}
+        elif isinstance(json_data["account"], str):
+            json_data["account"] = {"email": json_data["account"]}
+
+        return json_data
+
+    def get_token_file_name(self) -> str:
+        """
+        Returns the name of the token file using the proper file name format.
+        """
+        email = _email_to_safe_filename(self.account.email) if self.account is not None else "unknown"
+        if self.type == "authorized_user":
+            return f"{PERSONAL_TOKEN_FILE_PREFIX}{self.name}-{email}.json"
+        return f"{SERVICE_ACCOUNT_TOKEN_FILE_PREFIX}{self.name}-{email}.json"
+
+    def is_expired(self) -> bool:
+        """
+        Returns True if the token is expired, False otherwise.
+        """
+        return datetime.today().date() > self.expires
+
+    def expires_in_days(self) -> int:
+        """
+        Returns the number of days until the token expires.
+        """
+        return (self.expires - datetime.today().date()).days
+
+    @classmethod
+    def from_json_str(cls, data: str) -> TokenFile:
+        """
+        Creates a TokenFile from a JSON string.
+        """
+        return cls.model_validate_json(data)
+
+    @classmethod
+    def from_dict(cls, data: dict[str, Any]) -> TokenFile:
+        """
+        Creates a TokenFile from a dictionary.
+        """
+        return cls.model_validate(data)
+
+    def to_json_str(self) -> str:
+        """
+        Returns the JSON string representation of the TokenFile.
+        """
+        return self.model_dump_json()
+
+    def to_dict(self) -> dict[str, Any]:
+        """
+        Returns the dictionary representation of the TokenFile.
+        """
+        return self.model_dump()
+
+
+def loads(data: str) -> TokenFile:
+    """
+    Creates a TokenFile from a JSON string.
+    """
+    return TokenFile.from_json_str(data)
+
+
+def dumps(token_file: TokenFile) -> str:
+    """
+    Returns the JSON string representation of the TokenFile.
+    """
+    return token_file.to_json_str()

{remotivelabs_cli-0.2.1 → remotivelabs_cli-0.2.2}/cli/typer/typer_utils.py

@@ -17,7 +17,7 @@ console = Console()
 def create_typer(**kwargs: Any) -> typer.Typer:
     """Create a Typer instance with default settings."""
     # return typer.Typer(no_args_is_help=True, **kwargs)
-    return typer.Typer(cls=OrderCommands, no_args_is_help=True, **kwargs)
+    return typer.Typer(cls=OrderCommands, no_args_is_help=True, invoke_without_command=True, **kwargs)
 
 
 def print_padded(label: str, right_text: str, length: int = 30) -> None:

remotivelabs_cli-0.2.2/cli/utils/time.py

@@ -0,0 +1,11 @@
+from datetime import date, datetime
+
+
+def parse_date(date_str: str) -> date:
+    return parse_datetime(date_str).date()
+
+
+def parse_datetime(date_str: str) -> datetime:
+    """Required for pre 3.11"""
+    normalized = date_str.replace("Z", "+00:00")
+    return datetime.fromisoformat(normalized)

remotivelabs_cli-0.2.2/cli/utils/version_check.py

@@ -0,0 +1,112 @@
+from __future__ import annotations
+
+import datetime
+import json
+import os
+import urllib.request
+from datetime import timedelta
+from importlib import metadata as importlib_metadata
+
+from packaging.version import InvalidVersion, Version
+
+from cli.errors import ErrorPrinter
+from cli.settings import Settings
+
+
+def _pypi_latest(
+    project: str, *, include_prereleases: bool, timeout: float = 2.5, user_agent: str | None = None
+) -> tuple[str | None, str | None]:
+    """Return (latest_version, project_url) from PyPI, skipping yanked files."""
+    url = f"https://pypi.org/pypi/{project}/json"
+    headers = {"Accept": "application/json"}
+    if user_agent:
+        headers["User-Agent"] = user_agent
+    req = urllib.request.Request(url, headers=headers)
+
+    try:
+        with urllib.request.urlopen(req, timeout=timeout) as resp:
+            data = json.load(resp)
+    except Exception:
+        return None, None  # network/404/etc.
+
+    releases = data.get("releases") or {}
+    candidates: list[Version] = []
+    for s, files in releases.items():
+        try:
+            v = Version(s)
+        except InvalidVersion:
+            continue
+        the_files = files or []
+        if any(f.get("yanked", False) for f in the_files):
+            continue
+        if (v.is_prerelease or v.is_devrelease) and not include_prereleases:
+            continue
+        candidates.append(v)
+
+    if not candidates:
+        return None, None
+
+    latest = str(max(candidates))
+    info = data.get("info") or {}
+    proj_url = info.get("project_url") or info.get("package_url") or f"https://pypi.org/project/{project}/"
+    return latest, proj_url
+
+
+def _installed_version(distribution_name: str, fallback: str | None = None) -> str | None:
+    try:
+        return importlib_metadata.version(distribution_name)
+    except importlib_metadata.PackageNotFoundError:
+        return fallback
+
+
+def check_for_update(project: str, current_version: str, settings: Settings) -> None:
+    # Make it possible to disable update check, i.e in CI
+    if os.environ.get("PYTHON_DISABLE_UPDATE_CHECK"):
+        return
+
+    # Determine current version
+    cur = current_version or _installed_version(project)
+    if not cur:
+        return  # unknown version → skip silently
+
+    state = settings.read_state_file()
+
+    if not state.last_update_check_time:
+        if os.environ.get("RUNS_IN_DOCKER"):
+            # To prevent that we always check update in docker due to ephemeral disks we write an "old" check if the state
+            # is missing. If no disk is mounted we will never get the update check but if its mounted properly we will get
+            # it on the second attempt. This is good enough
+            state.last_update_check_time = (datetime.datetime.now() - timedelta(hours=10)).isoformat()
+            settings.write_state_file(state)
+            return
+
+    elif not state.should_perform_update_check():
+        return
+
+    # We end up here if last_update_check_time is None or should_perform_update_check is true
+
+    include_prereleases = Version(cur).is_prerelease or Version(cur).is_devrelease
+
+    latest, proj_url = _pypi_latest(
+        project, include_prereleases=include_prereleases, user_agent=f"{project}/{cur} (+https://pypi.org/project/{project}/)"
+    )
+    if latest:
+        if Version(latest) > Version(cur):
+            _print_update_info(
+                cur,
+                latest,
+            )
+    state.last_update_check_time = datetime.datetime.now().isoformat()
+    settings.write_state_file(state)
+
+
+def _print_update_info(cur: str, latest: str) -> None:
+    instructions = (
+        "upgrade with: docker pull remotivelabs/remotivelabs-cli"
+        if os.environ.get("RUNS_IN_DOCKER")
+        else "upgrade with: pipx install -U remotivelabs-cli"
+    )
+
+    ErrorPrinter.print_hint(
+        f"Update available: remotivelabs-cli {cur} → {latest} , ({instructions}) we always recommend to use latest version"
+    )

{remotivelabs_cli-0.2.1 → remotivelabs_cli-0.2.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "remotivelabs-cli"
-version = "0.2.1"
+version = "0.2.2"
 description = "CLI for operating RemotiveCloud and RemotiveBroker"
 authors = ["Johan Rask <johan.rask@remotivelabs.com>"]
 readme = "README.md"
@@ -27,6 +27,8 @@ grpc-stubs = ">=1.53.0.5"
 mypy-protobuf = ">=3.0.0"
 types-requests = "^2.32.0.20240622"
 dacite = "^1.9.2"
+pydantic = "^2.11.7"
+email-validator = "^2.2.0"
 
 [tool.poetry.group.test.dependencies]
 pytest = "^8.3"

remotivelabs_cli-0.2.1/cli/settings/token_file.py

@@ -1,101 +0,0 @@
-from __future__ import annotations
-
-import dataclasses
-import json
-import re
-from dataclasses import dataclass
-from datetime import date, datetime
-from typing import Any, Literal
-
-DEFAULT_EMAIL = "unknown@remotivecloud.com"
-PERSONAL_TOKEN_FILE_PREFIX = "personal-token-"
-SERVICE_ACCOUNT_TOKEN_FILE_PREFIX = "service-account-token-"
-
-TokenType = Literal["authorized_user", "service_account"]
-
-
-def _parse_date(date_str: str) -> date:
-    normalized = date_str.replace("Z", "+00:00")
-    return datetime.fromisoformat(normalized).date()
-
-
-def _parse_token_type(token: str) -> TokenType:
-    if token.startswith("pa"):
-        return "authorized_user"
-    if token.startswith("sa"):
-        return "service_account"
-    raise ValueError(f"Unknown token type for token: {token}")
-
-
-def _from_dict(d: dict[str, Any]) -> TokenFile:
-    if "version" not in d:
-        token_type = _parse_token_type(d["token"])
-        return TokenFile(
-            version="1.0",
-            type=token_type,
-            name=d["name"],
-            token=d["token"],
-            created=_parse_date(d["created"]),
-            expires=_parse_date(d["expires"]),
-            account=TokenFileAccount(email=DEFAULT_EMAIL),
-        )
-
-    account_email = d.get("account", {}).get("email", DEFAULT_EMAIL)
-    return TokenFile(
-        version=d["version"],
-        type=d["type"],
-        name=d["name"],
-        token=d["token"],
-        created=_parse_date(d["created"]),
-        expires=_parse_date(d["expires"]),
-        account=TokenFileAccount(email=account_email),
-    )
-
-
-def loads(data: str) -> TokenFile:
-    return _from_dict(json.loads(data))
-
-
-def dumps(token: TokenFile) -> str:
-    return json.dumps(dataclasses.asdict(token), default=str)
-
-
-@dataclass
-class TokenFileAccount:
-    email: str
-
-
-@dataclass
-class TokenFile:
-    version: str
-    type: TokenType
-    name: str
-    token: str
-    created: date
-    expires: date
-    account: TokenFileAccount
-
-    def get_token_file_name(self) -> str:
-        def email_to_safe_filename(email: str) -> str:
-            # Replace any invalid character with an underscore
-            return re.sub(r'[<>:"/\\|?*]', "_", email)
-
-        # From now, user will never be None when adding a token so in this case token_file.user is never None
-        email = email_to_safe_filename(self.account.email) if self.account is not None else "unknown"
-        if self.type == "authorized_user":
-            return f"{PERSONAL_TOKEN_FILE_PREFIX}{self.name}-{email}.json"
-        return f"{SERVICE_ACCOUNT_TOKEN_FILE_PREFIX}{self.name}-{email}.json"
-
-    def is_expired(self) -> bool:
-        return datetime.today().date() > self.expires
-
-    def expires_in_days(self) -> int:
-        return (self.expires - datetime.today().date()).days
-
-    @staticmethod
-    def from_json_str(data: str) -> TokenFile:
-        return loads(data)
-
-    @staticmethod
-    def from_dict(data: dict[str, Any]) -> TokenFile:
-        return _from_dict(data)