cvat-cli 2.64.0__tar.gz → 2.66.0__tar.gz

{cvat_cli-2.64.0 → cvat_cli-2.66.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cvat-cli
-Version: 2.64.0
+Version: 2.66.0
 Summary: Command-line client for CVAT
 Author-email: "CVAT.ai Corporation" <support@cvat.ai>
 License-Expression: MIT
@@ -9,7 +9,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Operating System :: OS Independent
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
-Requires-Dist: cvat-sdk==2.64.0
+Requires-Dist: cvat-sdk==2.66.0
 Requires-Dist: attrs>=24.2.0
 Requires-Dist: Pillow>=10.3.0
 
@@ -22,8 +22,12 @@ comprehensive CVAT administration tool in the future.
 The following subcommands are supported:
 
 - Projects:
+  - `backup` - back up a project
   - `create` - create a new project
+  - `create-from-backup` - create a project from a backup file
   - `delete` - delete projects
+  - `export-dataset` - export a project as a dataset
+  - `import-dataset` - import annotations into a project from a dataset
   - `ls` - list all projects
 
 - Tasks:

{cvat_cli-2.64.0 → cvat_cli-2.66.0}/README.md

@@ -7,8 +7,12 @@ comprehensive CVAT administration tool in the future.
 The following subcommands are supported:
 
 - Projects:
+  - `backup` - back up a project
   - `create` - create a new project
+  - `create-from-backup` - create a project from a backup file
   - `delete` - delete projects
+  - `export-dataset` - export a project as a dataset
+  - `import-dataset` - import annotations into a project from a dataset
   - `ls` - list all projects
 
 - Tasks:

{cvat_cli-2.64.0 → cvat_cli-2.66.0}/pyproject.toml

@@ -16,7 +16,7 @@ classifiers = [
 ]
 requires-python = ">=3.10"
 dependencies = [
-    "cvat-sdk==2.64.0",
+    "cvat-sdk==2.66.0",
 
     "attrs>=24.2.0",
     "Pillow>=10.3.0",

cvat_cli-2.66.0/src/cvat_cli/_internal/command_base.py

@@ -0,0 +1,302 @@
+# Copyright (C) CVAT.ai Corporation
+#
+# SPDX-License-Identifier: MIT
+
+import argparse
+import json
+import os
+import textwrap
+import types
+from abc import ABCMeta, abstractmethod
+from collections.abc import Callable, Mapping, Sequence
+from typing import Protocol
+
+from attr.converters import to_bool
+from cvat_sdk import Client
+from cvat_sdk.core.helpers import DeferredTqdmProgressReporter
+from cvat_sdk.core.proxies.types import Location
+
+
+class Command(Protocol):
+    @property
+    def description(self) -> str: ...
+
+    def configure_parser(self, parser: argparse.ArgumentParser) -> None: ...
+
+    # The exact parameters accepted by `execute` vary between commands,
+    # so we're forced to declare it like this instead of as a method.
+    @property
+    def execute(self) -> Callable[..., None]: ...
+
+
+class CommandGroup:
+    def __init__(self, *, description: str) -> None:
+        self._commands: dict[str, Command] = {}
+        self.description = description
+
+    def command_class(self, name: str):
+        def decorator(cls: type):
+            self._commands[name] = cls()
+            return cls
+
+        return decorator
+
+    def add_command(self, name: str, command: Command) -> None:
+        self._commands[name] = command
+
+    @property
+    def commands(self) -> Mapping[str, Command]:
+        return types.MappingProxyType(self._commands)
+
+    def configure_parser(self, parser: argparse.ArgumentParser) -> None:
+        subparsers = parser.add_subparsers(required=True)
+
+        for name, command in self._commands.items():
+            subparser = subparsers.add_parser(name, description=command.description)
+            subparser.set_defaults(_executor=command.execute)
+            command.configure_parser(subparser)
+
+    def execute(self) -> None:
+        # It should be impossible for a command group to be executed,
+        # because configure_parser requires that a subcommand is specified.
+        assert False, "unreachable code"
+
+
+class DeprecatedAlias:
+    def __init__(self, command: Command, replacement: str) -> None:
+        self._command = command
+        self._replacement = replacement
+
+    @property
+    def description(self) -> str:
+        return textwrap.dedent(f"""\
+            {self._command.description}
+            (Deprecated; use "{self._replacement}" instead.)
+            """)
+
+    def configure_parser(self, parser: argparse.ArgumentParser) -> None:
+        self._command.configure_parser(parser)
+
+    def execute(self, client: Client, **kwargs) -> None:
+        client.logger.warning('This command is deprecated. Use "%s" instead.', self._replacement)
+        self._command.execute(client, **kwargs)
+
+
+class GenericCommand(metaclass=ABCMeta):
+    @abstractmethod
+    def repo(self, client: Client): ...
+
+    @property
+    @abstractmethod
+    def resource_type_str(self) -> str: ...
+
+
+class GenericListCommand(GenericCommand):
+    @property
+    def description(self) -> str:
+        return f"List all CVAT {self.resource_type_str}s in either basic or JSON format."
+
+    def configure_parser(self, parser: argparse.ArgumentParser) -> None:
+        parser.add_argument(
+            "--json",
+            dest="use_json_output",
+            default=False,
+            action="store_true",
+            help="output JSON data",
+        )
+
+    def execute(self, client: Client, *, use_json_output: bool = False):
+        results = self.repo(client).list(return_json=use_json_output)
+        if use_json_output:
+            print(json.dumps(json.loads(results), indent=2))
+        else:
+            for r in results:
+                print(r.id)
+
+
+class GenericDeleteCommand(GenericCommand):
+    @property
+    def description(self):
+        return f"Delete a list of {self.resource_type_str}s, ignoring those which don't exist."
+
+    def configure_parser(self, parser: argparse.ArgumentParser) -> None:
+        parser.add_argument(
+            "ids", type=int, help=f"list of {self.resource_type_str} IDs", nargs="+"
+        )
+
+    def execute(self, client: Client, *, ids: Sequence[int]) -> None:
+        self.repo(client).remove_by_ids(ids)
+
+
+class GenericDownloadBackupCommand(GenericCommand):
+    @property
+    def description(self) -> str:
+        return f"Download a {self.resource_type_str} backup."
+
+    def configure_parser(self, parser: argparse.ArgumentParser) -> None:
+        parser.add_argument(
+            "resource_id",
+            metavar=f"{self.resource_type_str}_id",
+            type=int,
+            help=f"{self.resource_type_str} ID",
+        )
+        parser.add_argument(
+            "filename",
+            type=str,
+            nargs="?",
+            default="",
+            help="output file or directory (default: current directory)",
+        )
+        parser.add_argument(
+            "--completion_verification_period",
+            dest="status_check_period",
+            default=2,
+            type=float,
+            help="time interval between checks if archive building has been finished, in seconds",
+        )
+
+    def execute(
+        self, client: Client, *, resource_id: int, filename: str, status_check_period: float
+    ) -> None:
+        if not filename:
+            filename = os.getcwd()
+
+        if filename.endswith((os.sep, os.altsep or os.sep)):
+            os.makedirs(filename, exist_ok=True)
+
+        self.repo(client).retrieve(obj_id=resource_id).download_backup(
+            filename=filename,
+            status_check_period=status_check_period,
+            pbar=DeferredTqdmProgressReporter(),
+            location=Location.LOCAL,
+        )
+
+
+class GenericCreateFromBackupCommand(GenericCommand):
+    @property
+    def description(self) -> str:
+        return f"Create a {self.resource_type_str} from a backup file."
+
+    def configure_parser(self, parser: argparse.ArgumentParser) -> None:
+        parser.add_argument("filename", type=str, help="upload file")
+        parser.add_argument(
+            "--completion_verification_period",
+            dest="status_check_period",
+            default=2,
+            type=float,
+            help="time interval between checks if archive processing was finished, in seconds",
+        )
+
+    def execute(self, client: Client, *, filename: str, status_check_period: float) -> None:
+        resource = self.repo(client).create_from_backup(
+            filename=filename,
+            status_check_period=status_check_period,
+            pbar=DeferredTqdmProgressReporter(),
+        )
+        print(resource.id)
+
+
+class GenericExportDatasetCommand(GenericCommand):
+    @property
+    def description(self) -> str:
+        return textwrap.dedent(f"""\
+            Export a {self.resource_type_str} as a dataset in the specified format
+            (e.g. 'YOLO 1.1').
+            """)
+
+    def configure_parser(self, parser: argparse.ArgumentParser) -> None:
+        parser.add_argument(
+            "resource_id",
+            metavar=f"{self.resource_type_str}_id",
+            type=int,
+            help=f"{self.resource_type_str} ID",
+        )
+        parser.add_argument(
+            "filename",
+            type=str,
+            nargs="?",
+            default="",
+            help="output file or directory (default: current directory)",
+        )
+        parser.add_argument(
+            "--format",
+            dest="fileformat",
+            type=str,
+            default="CVAT for images 1.1",
+            help="annotation format (default: %(default)s)",
+        )
+        parser.add_argument(
+            "--completion_verification_period",
+            dest="status_check_period",
+            default=2,
+            type=float,
+            help="number of seconds to wait until checking if dataset building finished",
+        )
+        parser.add_argument(
+            "--with-images",
+            type=to_bool,
+            default=False,
+            dest="include_images",
+            help="Whether to include images or not (default: %(default)s)",
+        )
+
+    def execute(
+        self,
+        client: Client,
+        *,
+        fileformat: str,
+        filename: str,
+        status_check_period: int,
+        include_images: bool,
+        resource_id: int,
+    ) -> None:
+        if not filename:
+            filename = os.getcwd()
+
+        if filename.endswith((os.sep, os.altsep or os.sep)):
+            os.makedirs(filename, exist_ok=True)
+
+        self.repo(client).retrieve(obj_id=resource_id).export_dataset(
+            format_name=fileformat,
+            filename=filename,
+            pbar=DeferredTqdmProgressReporter(),
+            status_check_period=status_check_period,
+            include_images=include_images,
+            location=Location.LOCAL,
+        )
+
+
+class GenericImportDatasetCommand(GenericCommand):
+    import_method_name = "import_dataset"
+
+    def configure_parser(self, parser: argparse.ArgumentParser) -> None:
+        parser.add_argument(
+            "resource_id",
+            metavar=f"{self.resource_type_str}_id",
+            type=int,
+            help=f"{self.resource_type_str} ID",
+        )
+        parser.add_argument("filename", type=str, help="upload file")
+        parser.add_argument(
+            "--format",
+            dest="fileformat",
+            type=str,
+            default="CVAT 1.1",
+            help="annotation format (default: %(default)s)",
+        )
+
+    def execute(
+        self,
+        client: Client,
+        *,
+        fileformat: str,
+        filename: str,
+        resource_id: int,
+    ) -> None:
+        resource = self.repo(client).retrieve(obj_id=resource_id)
+        import_dataset = getattr(resource, self.import_method_name)
+        import_dataset(
+            format_name=fileformat,
+            filename=filename,
+            pbar=DeferredTqdmProgressReporter(),
+        )

{cvat_cli-2.64.0 → cvat_cli-2.66.0}/src/cvat_cli/_internal/commands_projects.py

@@ -7,7 +7,16 @@ import textwrap
 
 from cvat_sdk import Client, models
 
-from .command_base import CommandGroup, GenericCommand, GenericDeleteCommand, GenericListCommand
+from .command_base import (
+    CommandGroup,
+    GenericCommand,
+    GenericCreateFromBackupCommand,
+    GenericDeleteCommand,
+    GenericDownloadBackupCommand,
+    GenericExportDatasetCommand,
+    GenericImportDatasetCommand,
+    GenericListCommand,
+)
 from .parsers import parse_label_arg
 
 COMMANDS = CommandGroup(description="Perform operations on CVAT projects.")
@@ -87,3 +96,26 @@ class ProjectCreate:
 @COMMANDS.command_class("delete")
 class ProjectDelete(GenericDeleteCommand, GenericProjectCommand):
     pass
+
+
+@COMMANDS.command_class("backup")
+class ProjectBackup(GenericDownloadBackupCommand, GenericProjectCommand):
+    pass
+
+
+@COMMANDS.command_class("create-from-backup")
+class ProjectCreateFromBackup(GenericCreateFromBackupCommand, GenericProjectCommand):
+    pass
+
+
+@COMMANDS.command_class("export-dataset")
+class ProjectExportDataset(GenericExportDatasetCommand, GenericProjectCommand):
+    pass
+
+
+@COMMANDS.command_class("import-dataset")
+class ProjectImportDataset(GenericImportDatasetCommand, GenericProjectCommand):
+    description = textwrap.dedent("""\
+        Create tasks in a project from a dataset in the specified format
+        (e.g. 'YOLO 1.1'), including images and annotations.
+        """)

{cvat_cli-2.64.0 → cvat_cli-2.66.0}/src/cvat_cli/_internal/commands_tasks.py

@@ -5,18 +5,24 @@
 from __future__ import annotations
 
 import argparse
-import os
 import textwrap
 from collections.abc import Sequence
 
 import cvat_sdk.auto_annotation as cvataa
-from attr.converters import to_bool
 from cvat_sdk import Client, models
 from cvat_sdk.core.helpers import DeferredTqdmProgressReporter
 from cvat_sdk.core.proxies.tasks import ResourceType
-from cvat_sdk.core.proxies.types import Location
 
-from .command_base import CommandGroup, GenericCommand, GenericDeleteCommand, GenericListCommand
+from .command_base import (
+    CommandGroup,
+    GenericCommand,
+    GenericCreateFromBackupCommand,
+    GenericDeleteCommand,
+    GenericDownloadBackupCommand,
+    GenericExportDatasetCommand,
+    GenericImportDatasetCommand,
+    GenericListCommand,
+)
 from .common import FunctionLoader, configure_function_implementation_arguments
 from .parsers import parse_label_arg, parse_resource_type, parse_threshold
 
@@ -254,160 +260,27 @@ class TaskFrames:
 
 
 @COMMANDS.command_class("export-dataset")
-class TaskExportDataset:
-    description = textwrap.dedent("""\
-        Export a task as a dataset in the specified format (e.g. 'YOLO 1.1').
-        """)
-
-    def configure_parser(self, parser: argparse.ArgumentParser) -> None:
-        parser.add_argument("task_id", type=int, help="task ID")
-        parser.add_argument(
-            "filename",
-            type=str,
-            nargs="?",
-            default="",
-            help="output file or directory (default: current directory)",
-        )
-        parser.add_argument(
-            "--format",
-            dest="fileformat",
-            type=str,
-            default="CVAT for images 1.1",
-            help="annotation format (default: %(default)s)",
-        )
-        parser.add_argument(
-            "--completion_verification_period",
-            dest="status_check_period",
-            default=2,
-            type=float,
-            help="number of seconds to wait until checking if dataset building finished",
-        )
-        parser.add_argument(
-            "--with-images",
-            type=to_bool,
-            default=False,
-            dest="include_images",
-            help="Whether to include images or not (default: %(default)s)",
-        )
-
-    def execute(
-        self,
-        client: Client,
-        *,
-        task_id: int,
-        fileformat: str,
-        filename: str,
-        status_check_period: int,
-        include_images: bool,
-    ) -> None:
-        if not filename:
-            filename = os.getcwd()
-
-        if filename.endswith((os.sep, os.altsep or os.sep)):
-            os.makedirs(filename, exist_ok=True)
-
-        client.tasks.retrieve(obj_id=task_id).export_dataset(
-            format_name=fileformat,
-            filename=filename,
-            pbar=DeferredTqdmProgressReporter(),
-            status_check_period=status_check_period,
-            include_images=include_images,
-            location=Location.LOCAL,
-        )
+class TaskExportDataset(GenericExportDatasetCommand, GenericTaskCommand):
+    pass
 
 
 @COMMANDS.command_class("import-dataset")
-class TaskImportDataset:
+class TaskImportDataset(GenericImportDatasetCommand, GenericTaskCommand):
     description = textwrap.dedent("""\
         Import annotations into a task from a dataset in the specified format
         (e.g. 'YOLO 1.1').
         """)
-
-    def configure_parser(self, parser: argparse.ArgumentParser) -> None:
-        parser.add_argument("task_id", type=int, help="task ID")
-        parser.add_argument("filename", type=str, help="upload file")
-        parser.add_argument(
-            "--format",
-            dest="fileformat",
-            type=str,
-            default="CVAT 1.1",
-            help="annotation format (default: %(default)s)",
-        )
-
-    def execute(
-        self,
-        client: Client,
-        *,
-        task_id: int,
-        fileformat: str,
-        filename: str,
-    ) -> None:
-        client.tasks.retrieve(obj_id=task_id).import_annotations(
-            format_name=fileformat,
-            filename=filename,
-            pbar=DeferredTqdmProgressReporter(),
-        )
+    import_method_name = "import_annotations"
 
 
 @COMMANDS.command_class("backup")
-class TaskBackup:
-    description = """Download a task backup."""
-
-    def configure_parser(self, parser: argparse.ArgumentParser) -> None:
-        parser.add_argument("task_id", type=int, help="task ID")
-        parser.add_argument(
-            "filename",
-            type=str,
-            nargs="?",
-            default="",
-            help="output file or directory (default: current directory)",
-        )
-        parser.add_argument(
-            "--completion_verification_period",
-            dest="status_check_period",
-            default=2,
-            type=float,
-            help="time interval between checks if archive building has been finished, in seconds",
-        )
-
-    def execute(
-        self, client: Client, *, task_id: int, filename: str, status_check_period: int
-    ) -> None:
-        if not filename:
-            filename = os.getcwd()
-
-        if filename.endswith((os.sep, os.altsep or os.sep)):
-            os.makedirs(filename, exist_ok=True)
-
-        client.tasks.retrieve(obj_id=task_id).download_backup(
-            filename=filename,
-            status_check_period=status_check_period,
-            pbar=DeferredTqdmProgressReporter(),
-            location=Location.LOCAL,
-        )
+class TaskBackup(GenericDownloadBackupCommand, GenericTaskCommand):
+    pass
 
 
 @COMMANDS.command_class("create-from-backup")
-class TaskCreateFromBackup:
-    description = """Create a task from a backup file."""
-
-    def configure_parser(self, parser: argparse.ArgumentParser) -> None:
-        parser.add_argument("filename", type=str, help="upload file")
-        parser.add_argument(
-            "--completion_verification_period",
-            dest="status_check_period",
-            default=2,
-            type=float,
-            help="time interval between checks if archive processing was finished, in seconds",
-        )
-
-    def execute(self, client: Client, *, filename: str, status_check_period: int) -> None:
-        task = client.tasks.create_from_backup(
-            filename=filename,
-            status_check_period=status_check_period,
-            pbar=DeferredTqdmProgressReporter(),
-        )
-        print(task.id)
+class TaskCreateFromBackup(GenericCreateFromBackupCommand, GenericTaskCommand):
+    pass
 
 
 @COMMANDS.command_class("auto-annotate")

cvat_cli-2.66.0/src/cvat_cli/version.py

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

{cvat_cli-2.64.0 → cvat_cli-2.66.0}/src/cvat_cli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cvat-cli
-Version: 2.64.0
+Version: 2.66.0
 Summary: Command-line client for CVAT
 Author-email: "CVAT.ai Corporation" <support@cvat.ai>
 License-Expression: MIT
@@ -9,7 +9,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Operating System :: OS Independent
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
-Requires-Dist: cvat-sdk==2.64.0
+Requires-Dist: cvat-sdk==2.66.0
 Requires-Dist: attrs>=24.2.0
 Requires-Dist: Pillow>=10.3.0
 
@@ -22,8 +22,12 @@ comprehensive CVAT administration tool in the future.
 The following subcommands are supported:
 
 - Projects:
+  - `backup` - back up a project
   - `create` - create a new project
+  - `create-from-backup` - create a project from a backup file
   - `delete` - delete projects
+  - `export-dataset` - export a project as a dataset
+  - `import-dataset` - import annotations into a project from a dataset
   - `ls` - list all projects
 
 - Tasks:

{cvat_cli-2.64.0 → cvat_cli-2.66.0}/src/cvat_cli.egg-info/requires.txt

@@ -1,3 +1,3 @@
-cvat-sdk==2.64.0
+cvat-sdk==2.66.0
 attrs>=24.2.0
 Pillow>=10.3.0

cvat_cli-2.64.0/src/cvat_cli/_internal/command_base.py

@@ -1,124 +0,0 @@
-# Copyright (C) CVAT.ai Corporation
-#
-# SPDX-License-Identifier: MIT
-
-import argparse
-import json
-import textwrap
-import types
-from abc import ABCMeta, abstractmethod
-from collections.abc import Callable, Mapping, Sequence
-from typing import Protocol
-
-from cvat_sdk import Client
-
-
-class Command(Protocol):
-    @property
-    def description(self) -> str: ...
-
-    def configure_parser(self, parser: argparse.ArgumentParser) -> None: ...
-
-    # The exact parameters accepted by `execute` vary between commands,
-    # so we're forced to declare it like this instead of as a method.
-    @property
-    def execute(self) -> Callable[..., None]: ...
-
-
-class CommandGroup:
-    def __init__(self, *, description: str) -> None:
-        self._commands: dict[str, Command] = {}
-        self.description = description
-
-    def command_class(self, name: str):
-        def decorator(cls: type):
-            self._commands[name] = cls()
-            return cls
-
-        return decorator
-
-    def add_command(self, name: str, command: Command) -> None:
-        self._commands[name] = command
-
-    @property
-    def commands(self) -> Mapping[str, Command]:
-        return types.MappingProxyType(self._commands)
-
-    def configure_parser(self, parser: argparse.ArgumentParser) -> None:
-        subparsers = parser.add_subparsers(required=True)
-
-        for name, command in self._commands.items():
-            subparser = subparsers.add_parser(name, description=command.description)
-            subparser.set_defaults(_executor=command.execute)
-            command.configure_parser(subparser)
-
-    def execute(self) -> None:
-        # It should be impossible for a command group to be executed,
-        # because configure_parser requires that a subcommand is specified.
-        assert False, "unreachable code"
-
-
-class DeprecatedAlias:
-    def __init__(self, command: Command, replacement: str) -> None:
-        self._command = command
-        self._replacement = replacement
-
-    @property
-    def description(self) -> str:
-        return textwrap.dedent(f"""\
-            {self._command.description}
-            (Deprecated; use "{self._replacement}" instead.)
-            """)
-
-    def configure_parser(self, parser: argparse.ArgumentParser) -> None:
-        self._command.configure_parser(parser)
-
-    def execute(self, client: Client, **kwargs) -> None:
-        client.logger.warning('This command is deprecated. Use "%s" instead.', self._replacement)
-        self._command.execute(client, **kwargs)
-
-
-class GenericCommand(metaclass=ABCMeta):
-    @abstractmethod
-    def repo(self, client: Client): ...
-
-    @property
-    @abstractmethod
-    def resource_type_str(self) -> str: ...
-
-
-class GenericListCommand(GenericCommand):
-    @property
-    def description(self) -> str:
-        return f"List all CVAT {self.resource_type_str}s in either basic or JSON format."
-
-    def configure_parser(self, parser: argparse.ArgumentParser) -> None:
-        parser.add_argument(
-            "--json",
-            dest="use_json_output",
-            default=False,
-            action="store_true",
-            help="output JSON data",
-        )
-
-    def execute(self, client: Client, *, use_json_output: bool = False):
-        results = self.repo(client).list(return_json=use_json_output)
-        if use_json_output:
-            print(json.dumps(json.loads(results), indent=2))
-        else:
-            for r in results:
-                print(r.id)
-
-
-class GenericDeleteCommand(GenericCommand):
-    @property
-    def description(self):
-        return f"Delete a list of {self.resource_type_str}s, ignoring those which don't exist."
-
-    def configure_parser(self, parser: argparse.ArgumentParser) -> None:
-        parser.add_argument(
-            "ids", type=int, help=f"list of {self.resource_type_str} IDs", nargs="+"
-        )
-
-    def execute(self, client: Client, *, ids: Sequence[int]) -> None:
-        self.repo(client).remove_by_ids(ids)

cvat_cli-2.64.0/src/cvat_cli/version.py

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