cvat-cli 2.71.0__tar.gz → 2.74.0__tar.gz

{cvat_cli-2.71.0 → cvat_cli-2.74.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cvat-cli
-Version: 2.71.0
+Version: 2.74.0
 Summary: Command-line client for CVAT
 Author-email: "CVAT.ai Corporation" <support@cvat.ai>
 License-Expression: MIT
@@ -9,8 +9,9 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Operating System :: OS Independent
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
-Requires-Dist: cvat-sdk==2.71.0
+Requires-Dist: cvat-sdk==2.74.0
 Requires-Dist: attrs>=24.2.0
+Requires-Dist: json-with-comments==1.2.10
 Requires-Dist: Pillow>=10.3.0
 
 # Command-line client for CVAT

{cvat_cli-2.71.0 → cvat_cli-2.74.0}/pyproject.toml

@@ -16,9 +16,10 @@ classifiers = [
 ]
 requires-python = ">=3.10"
 dependencies = [
-    "cvat-sdk==2.71.0",
+    "cvat-sdk==2.74.0",
 
     "attrs>=24.2.0",
+    "json-with-comments==1.2.10",
     "Pillow>=10.3.0",
 ]
 

{cvat_cli-2.71.0 → cvat_cli-2.74.0}/src/cvat_cli/_internal/commands_all.py

@@ -5,6 +5,7 @@
 from .command_base import CommandGroup, DeprecatedAlias
 from .commands_config import COMMANDS as COMMANDS_CONFIG
 from .commands_functions import COMMANDS as COMMANDS_FUNCTIONS
+from .commands_profile import COMMANDS as COMMANDS_PROFILE
 from .commands_projects import COMMANDS as COMMANDS_PROJECTS
 from .commands_tasks import COMMANDS as COMMANDS_TASKS
 
@@ -12,6 +13,7 @@ COMMANDS = CommandGroup(description="Perform operations on CVAT resources.")
 
 COMMANDS.add_command("config", COMMANDS_CONFIG)
 COMMANDS.add_command("function", COMMANDS_FUNCTIONS)
+COMMANDS.add_command("profile", COMMANDS_PROFILE)
 COMMANDS.add_command("project", COMMANDS_PROJECTS)
 COMMANDS.add_command("task", COMMANDS_TASKS)
 

cvat_cli-2.74.0/src/cvat_cli/_internal/commands_profile.py

@@ -0,0 +1,173 @@
+# Copyright (C) CVAT.ai Corporation
+#
+# SPDX-License-Identifier: MIT
+
+from __future__ import annotations
+
+import argparse
+import getpass
+from pathlib import Path
+from urllib.parse import urlsplit
+
+from cvat_sdk.core.auth import DEFAULT_SERVER, AuthStore, ProfileEntry
+from cvat_sdk.core.client import AccessTokenCredentials, Client, Config
+from cvat_sdk.core.utils import normalize_server_url
+
+from .command_base import CommandGroup
+from .common import CriticalError
+from .utils import fetch_current_access_token_name, get_current_time_iso, read_token_file
+
+COMMANDS = CommandGroup(description="Manage saved CVAT authentication profiles.")
+
+
+@COMMANDS.command_class("list")
+class ProfileList:
+    needs_client = False
+    description = "List saved profiles, marking the default one."
+
+    def configure_parser(self, parser: argparse.ArgumentParser) -> None:
+        parser.add_argument(
+            "--names-only", action="store_true", help="print profile names only (one per line)"
+        )
+
+    def execute(self, args: argparse.Namespace) -> None:
+        store = AuthStore()
+        profiles = store.list_profiles()
+        default = store.get_default_profile()
+        default_name = default[0] if default is not None else None
+
+        for name in sorted(profiles):
+            if args.names_only:
+                print(name)
+            else:
+                marker = "(default)" if name == default_name else ""
+                print(f"{name}\t{profiles[name].server}\t{marker}".rstrip())
+
+
+@COMMANDS.command_class("default")
+class ProfileDefault:
+    needs_client = False
+    description = "Print, set, or unset the default profile."
+
+    def configure_parser(self, parser: argparse.ArgumentParser) -> None:
+        parser.add_argument("name", nargs="?", default=None, help="profile to make default")
+        parser.add_argument("--unset", action="store_true", help="clear the default profile")
+
+    def execute(self, args: argparse.Namespace) -> None:
+        store = AuthStore()
+
+        if args.unset and args.name is not None:
+            raise CriticalError("Cannot combine a profile name with '--unset'.")
+
+        if args.unset:
+            store.clear_default_profile()
+            print("Default profile cleared.")
+        elif args.name is not None:
+            try:
+                store.set_default_profile(args.name)
+            except KeyError:
+                raise CriticalError(f"Unknown profile '{args.name}'. Run 'cvat-cli profile list'.")
+            print(f"Default profile is now '{args.name}'.")
+        else:
+            default = store.get_default_profile()
+            if default is None:
+                raise CriticalError("No default profile is set.")
+            print(default[0])
+
+
+@COMMANDS.command_class("delete")
+class ProfileDelete:
+    needs_client = False
+    description = (
+        "Remove a saved profile. Does not revoke the server-side token. "
+        "If it was the default, the default becomes unset."
+    )
+
+    def configure_parser(self, parser: argparse.ArgumentParser) -> None:
+        parser.add_argument("name", help="profile to remove")
+
+    def execute(self, args: argparse.Namespace) -> None:
+        store = AuthStore()
+        try:
+            store.remove_profile(args.name)
+        except KeyError:
+            raise CriticalError(f"Unknown profile '{args.name}'. Run 'cvat-cli profile list'.")
+        print(f"Removed profile '{args.name}'.")
+
+
+@COMMANDS.command_class("create")
+class ProfileCreate:
+    needs_client = False
+    description = (
+        "Save a Personal Access Token (PAT) and the server info into a local profile. "
+        "A PAT must be created on the server manually first. "
+        "Read more: https://docs.cvat.ai/docs/api_sdk/access_tokens/"
+    )
+
+    def configure_parser(self, parser: argparse.ArgumentParser) -> None:
+        parser.add_argument("--name", default=None, help="profile name (unique)")
+        parser.add_argument("token", nargs="?", default=None, help="PAT (omit to be prompted)")
+        parser.add_argument("--set-default", action="store_true", help="mark as default profile")
+        parser.add_argument("--force", action="store_true", help="overwrite an existing profile")
+        parser.add_argument(
+            "--file",
+            type=Path,
+            default=None,
+            help=(
+                "read the PAT from a file; accepts plain tokens and JSONC envelopes. "
+                "'--server-host' overrides the envelope server"
+            ),
+        )
+
+    def execute(self, args: argparse.Namespace) -> None:
+        store = AuthStore()
+
+        envelope_server = envelope_name = None
+        if args.file is not None:
+            if args.token is not None:
+                raise CriticalError("Cannot combine a PAT argument with '--file'.")
+            try:
+                token, envelope_server, envelope_name = read_token_file(args.file)
+            except (OSError, UnicodeError, ValueError) as e:
+                raise CriticalError(f"Cannot read token file '{args.file}': {e}") from e
+        elif args.token is not None:
+            token = args.token
+        else:
+            token = None
+
+        server = (
+            args.server_host or envelope_server or store.get_default_server() or DEFAULT_SERVER
+        ).rstrip("/")
+        if args.server_port:
+            parsed_url = urlsplit(("https://" if "://" not in server else "") + server)
+            if parsed_url.port:
+                raise CriticalError(
+                    "A server URL with a port and '--server-port' cannot be used together. "
+                    "Please specify only one port."
+                )
+            server = f"{server}:{args.server_port}"
+        server = normalize_server_url(server)
+
+        if token is None:
+            token = getpass.getpass(f"Personal Access Token (PAT) for '{server}': ")
+        if not token:
+            raise CriticalError("A non-empty PAT is required.")
+
+        name = args.name or envelope_name
+        if name is None:
+            with Client(
+                url=server, config=Config(verify_ssl=not args.insecure), check_server_version=False
+            ) as client:
+                client.login(AccessTokenCredentials(token))
+                name = fetch_current_access_token_name(client)
+
+        if store.get_profile(name) is not None and not args.force:
+            raise CriticalError(f"Profile '{name}' already exists. Pass '--force' to overwrite.")
+
+        store.put_profile(
+            name,
+            ProfileEntry(server=server, token=token, created_date=get_current_time_iso()),
+            set_default=args.set_default,
+        )
+        suffix = " (set as default)" if store.get_default_profile()[0] == name else ""
+        print(f"Saved profile '{name}' for {server}{suffix}.")

cvat_cli-2.74.0/src/cvat_cli/_internal/utils.py

@@ -0,0 +1,61 @@
+# Copyright (C) CVAT.ai Corporation
+#
+# SPDX-License-Identifier: MIT
+
+from __future__ import annotations
+
+from datetime import datetime, timezone
+from json import JSONDecodeError
+from pathlib import Path
+
+import jsonc
+from cvat_sdk import Client
+
+
+def popattr(obj, name):
+    value = getattr(obj, name)
+    delattr(obj, name)
+    return value
+
+
+def get_current_time_iso() -> str:
+    return datetime.now(timezone.utc).isoformat()
+
+
+def fetch_current_access_token_name(client: Client) -> str:
+    access_token, _ = client.api_client.auth_api.retrieve_access_tokens_self()
+    return access_token.name
+
+
+def read_token_file(path: Path) -> tuple[str, str | None, str | None]:
+    """Read a PAT from a plain-text token file or a JSONC envelope."""
+    if not path.is_file():
+        raise ValueError("path must be a regular file")
+
+    text = path.read_text(encoding="utf-8")
+    if not text:
+        # jsonc.loads raises IndexError for empty strings:
+        # https://github.com/n-takumasa/json-with-comments/issues/48
+        return "", None, None
+
+    try:
+        doc = jsonc.loads(text)
+    except JSONDecodeError:
+        return text.strip(), None, None
+
+    if not isinstance(doc, dict):
+        return text.strip(), None, None
+
+    token = doc.get("token")
+    if not isinstance(token, str):
+        raise ValueError("JSON envelope field 'token' must be a string")
+
+    server = doc.get("server")
+    if server is not None and not isinstance(server, str):
+        raise ValueError("JSON envelope field 'server' must be a string")
+
+    name = doc.get("name")
+    if name is not None and not isinstance(name, str):
+        raise ValueError("JSON envelope field 'name' must be a string")
+
+    return token, server, name

cvat_cli-2.74.0/src/cvat_cli/version.py

@@ -0,0 +1 @@
+VERSION = "2.74.0"

{cvat_cli-2.71.0 → cvat_cli-2.74.0}/src/cvat_cli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cvat-cli
-Version: 2.71.0
+Version: 2.74.0
 Summary: Command-line client for CVAT
 Author-email: "CVAT.ai Corporation" <support@cvat.ai>
 License-Expression: MIT
@@ -9,8 +9,9 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Operating System :: OS Independent
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
-Requires-Dist: cvat-sdk==2.71.0
+Requires-Dist: cvat-sdk==2.74.0
 Requires-Dist: attrs>=24.2.0
+Requires-Dist: json-with-comments==1.2.10
 Requires-Dist: Pillow>=10.3.0
 
 # Command-line client for CVAT

{cvat_cli-2.71.0 → cvat_cli-2.74.0}/src/cvat_cli.egg-info/SOURCES.txt

@@ -19,6 +19,7 @@ src/cvat_cli/_internal/command_base.py
 src/cvat_cli/_internal/commands_all.py
 src/cvat_cli/_internal/commands_config.py
 src/cvat_cli/_internal/commands_functions.py
+src/cvat_cli/_internal/commands_profile.py
 src/cvat_cli/_internal/commands_projects.py
 src/cvat_cli/_internal/commands_tasks.py
 src/cvat_cli/_internal/common.py

cvat_cli-2.74.0/src/cvat_cli.egg-info/requires.txt

@@ -0,0 +1,4 @@
+cvat-sdk==2.74.0
+attrs>=24.2.0
+json-with-comments==1.2.10
+Pillow>=10.3.0

cvat_cli-2.71.0/src/cvat_cli/_internal/utils.py

@@ -1,9 +0,0 @@
-# Copyright (C) CVAT.ai Corporation
-#
-# SPDX-License-Identifier: MIT
-
-
-def popattr(obj, name):
-    value = getattr(obj, name)
-    delattr(obj, name)
-    return value

cvat_cli-2.71.0/src/cvat_cli/version.py

@@ -1 +0,0 @@
-VERSION = "2.71.0"

cvat_cli-2.71.0/src/cvat_cli.egg-info/requires.txt

@@ -1,3 +0,0 @@
-cvat-sdk==2.71.0
-attrs>=24.2.0
-Pillow>=10.3.0