vortex-cli 4.17.2__tar.gz → 4.18.0__tar.gz

{vortex_cli-4.17.2/vortex_cli.egg-info → vortex_cli-4.18.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vortex_cli
-Version: 4.17.2
+Version: 4.18.0
 Summary: Vortex CLI
 Author-email: Jordan Amos <jordan.amos@gmail.com>
 License: MIT License

{vortex_cli-4.17.2 → vortex_cli-4.18.0}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "vortex_cli"
-version = "4.17.2"
+version = "4.18.0"
 description = "Vortex CLI"
 requires-python = ">=3.10"
 readme = { file = "README.md", content-type = "text/markdown" }

{vortex_cli-4.17.2 → vortex_cli-4.18.0}/vortex/cli.py

@@ -39,6 +39,19 @@ def _check_int_in_range(val: str, min_: int = 0, max_: int | None = 50) -> int:
     return new_val
 
 
+def _pmx_type(val: str) -> Path:
+    path = Path(val).resolve()
+    if path.suffix != ".pmx" or not path.is_file():
+        raise ArgumentTypeError(f"Invalid '.pmx' file {path}")
+    return path
+
+
+def _non_empty_string(val: str) -> str:
+    if not val.strip():
+        raise ArgumentTypeError("Value provided cannot be empty or just whitespace.")
+    return val
+
+
 def _add_server_option(parser: ArgumentParser) -> None:
     parser.add_argument(
         "--server",
@@ -75,39 +88,43 @@ def validate_args(
     clone_parser: ArgumentParser,
     db_parser: ArgumentParser,
 ) -> None:
-    if args.command == "new" and args.subcommand == "object":
-        missing_required_fields = not args.update_ids and not (
-            args.name and args.app_id and args.design_type
-        )
-        missing_content_type = (
-            args.design_type in (DesignType.RESOURCE, DesignType.DOCUMENTATION)
-            and not args.content_type
-        )
-        update_arg_contains_app_id = args.update_ids and args.app_id
-        update_is_missing_args = args.update_ids and not (
-            args.name
-            or args.app_id
-            or args.design_type
-            or args.comment
-            or args.inherit_from
-            or args.open_action
-            or args.save_action
-            or args.parent_page
-            or args.content_type
-        )
+    if args.command == "new":
         msg = None
-        if missing_required_fields:
-            msg = "--name, --app-id, and --type are required unless using --update"
-        elif missing_content_type:
-            msg = (
-                f"--type argument value '{args.design_type.name}' "
-                "requires --content-type"
+        is_update_mode = bool(args.update_ids)
+        if args.subcommand == "object":
+            missing_required_fields = not is_update_mode and not (
+                args.name and args.app_id and args.design_type
             )
-        elif update_arg_contains_app_id:
-            msg = "Can't use --app-id with --update"
-        elif update_is_missing_args:
-            msg = "Please specify an option to update"
-
+            missing_content_type = (
+                args.design_type in (DesignType.RESOURCE, DesignType.DOCUMENTATION)
+                and not args.content_type
+            )
+            update_arg_contains_app_id = is_update_mode and args.app_id
+            update_is_missing_args = is_update_mode and not (
+                args.name
+                or args.app_id
+                or args.design_type
+                or args.comment
+                or args.inherit_from
+                or args.open_action
+                or args.save_action
+                or args.parent_page
+                or args.content_type
+            )
+            if missing_required_fields:
+                msg = "--name, --app-id, and --type are required unless using --update"
+            elif missing_content_type:
+                msg = (
+                    f"--type argument value '{args.design_type.name}' "
+                    "requires --content-type"
+                )
+            elif update_arg_contains_app_id:
+                msg = "Can't use --app-id with --update"
+            elif update_is_missing_args:
+                msg = "Please specify an option to update"
+        elif args.subcommand == "app":
+            if not is_update_mode and not (args.name and args.group):
+                msg = "--name and --group are required when creating new applications."
         if msg:
             new_parser.error(msg)
 
@@ -303,10 +320,17 @@ def add_watch_parser(command_parser: _SubParsersAction[ArgumentParser]) -> None:
 
 
 def add_clean_parser(command_parser: _SubParsersAction[ArgumentParser]) -> None:
-    command_parser.add_parser(
+    clean_parser = command_parser.add_parser(
         "clean",
         help="Delete the cloned Puakma Application directories in the workspace",
     )
+    clean_parser.add_argument(
+        "--all",
+        "-a",
+        help="Set this flag to clean all servers",
+        action="store_true",
+    )
+    _add_server_option(clean_parser)
 
 
 def add_config_parser(command_parser: _SubParsersAction[ArgumentParser]) -> None:
@@ -456,23 +480,6 @@ def add_grep_parser(command_parser: _SubParsersAction[ArgumentParser]) -> None:
 def add_new_parser(
     command_parser: _SubParsersAction[ArgumentParser],
 ) -> ArgumentParser:
-    def _pmx_type(val: str) -> Path:
-        path = Path(val).resolve()
-        if path.suffix != ".pmx" or not path.is_file():
-            raise ArgumentTypeError(f"Invalid '.pmx' file {path}")
-        return path
-
-    def _add_update_option(parser: ArgumentParser) -> None:
-        parser.add_argument(
-            "--update",
-            "-u",
-            type=int,
-            nargs="*",
-            metavar="ID",
-            dest="update_ids",
-            help="Update a Design Object with the given ID instead",
-        )
-
     new_parser = command_parser.add_parser(
         "new",
         help="Create new Design Objects, Applications or Keywords",
@@ -484,14 +491,16 @@ def add_new_parser(
         nargs="*",
         metavar="ID",
         dest="update_ids",
-        help="Update a Design Object with the given ID instead",
+        help="Update mode. Entities with the given ID(s) are updated instead",
     )
     _add_server_option(new_parser)
 
     sub_parser = new_parser.add_subparsers(dest="subcommand")
 
     # Object parser
-    object_parser = sub_parser.add_parser("object", help="Create a new Design Object")
+    object_parser = sub_parser.add_parser(
+        "object", aliases=("obj",), help="Create/Update Design Objects"
+    )
     obj_optional_group = object_parser.add_argument_group("Design Object Options")
     _add_design_type_option(
         obj_optional_group,
@@ -522,33 +531,42 @@ def add_new_parser(
     )
 
     # App Parser
-    app_parser = sub_parser.add_parser("app", help="Create a new Puakama Application")
-    app_parser.add_argument("--name", "-n", help="The application name", required=True)
+    app_parser = sub_parser.add_parser("app", help="Create/Update Applications")
     app_parser.add_argument(
-        "--group", "-g", help="The application group", required=True
-    )
-    app_optional_group = app_parser.add_argument_group("Optional Arguments")
-    app_optional_group.add_argument("--description")
-    app_optional_group.add_argument("--inherit-from")
-    app_optional_group.add_argument("--template")
-    app_optional_group.add_argument(
-        "--import",
-        metavar="PMX_PATH",
-        type=_pmx_type,
-        dest="import_path",
-        help="Create the application from the given .pmx path",
+        "--name",
+        "-n",
+        help="The name of the application. Required if not updating.",
+        type=_non_empty_string,
+    )
+    app_parser.add_argument(
+        "--group",
+        "-g",
+        help="The application group",
+        default="",
+        type=lambda v: v.strip(),
+    )
+
+    optional_group = app_parser.add_argument_group(
+        "Optional Arguments (Not applicable when importing)"
+    )
+    optional_group.add_argument(
+        "--description", help="Brief description of the application"
+    )
+    optional_group.add_argument(
+        "--inherit-from", help="Parent application to inherit from"
+    )
+    optional_group.add_argument(
+        "--template", help="Template to base the application on"
     )
 
     # Keyword Parser
-    keyword_parser = sub_parser.add_parser("keyword", help="Create a new Keyword")
+    keyword_parser = sub_parser.add_parser(
+        "keyword", aliases=("kw",), help="Create/Update Keywords"
+    )
     keyword_parser.add_argument("--app-id", type=int, required=True)
     keyword_parser.add_argument("--name", "-n", help="The keyword name", required=True)
     keyword_parser.add_argument("--values", nargs="*", required=True)
 
-    _add_update_option(object_parser)
-    _add_update_option(app_parser)
-    _add_update_option(keyword_parser)
-
     return new_parser
 
 
@@ -682,3 +700,34 @@ def add_execute_parser(command_parser: _SubParsersAction[ArgumentParser]) -> Non
         help="View the agenda schedule. Alias for 'tell agenda schedule'",
     )
     _add_server_option(execute_parser)
+
+
+def add_import_parser(
+    command_parser: _SubParsersAction[ArgumentParser],
+) -> ArgumentParser:
+    import_parser = command_parser.add_parser(
+        "import",
+        help="Import a .pmx file to create an application.",
+    )
+    import_parser.add_argument(
+        "pmx_path",
+        metavar="PATH",
+        help="Path to a .pmx file to create an application from.",
+        type=_pmx_type,
+    )
+    import_parser.add_argument(
+        "--name",
+        "-n",
+        help="The application name.",
+        required=True,
+        type=_non_empty_string,
+    )
+    import_parser.add_argument(
+        "--group",
+        "-g",
+        help="The application group.",
+        default="",
+        type=lambda v: v.strip(),
+    )
+    _add_server_option(import_parser)
+    return import_parser

vortex_cli-4.18.0/vortex/commands/clean.py

@@ -0,0 +1,22 @@
+from __future__ import annotations
+
+import logging
+import shutil
+
+from vortex.models import PuakmaServer
+from vortex.workspace import Workspace
+
+logger = logging.getLogger("vortex")
+
+
+def clean(workspace: Workspace, server: PuakmaServer, include_all: bool = False) -> int:
+    cloned_apps = workspace.listapps(None if include_all else server)
+    if cloned_apps:
+        host_dirs = set(workspace.path / app.host for app in cloned_apps)
+        with workspace.exclusive_lock():
+            for host_dir in host_dirs:
+                shutil.rmtree(host_dir)
+                logger.debug(f"Deleted directory '{host_dir}'")
+            workspace.update_vscode_settings()
+    logger.info("Workspace cleaned")
+    return 0

{vortex_cli-4.17.2 → vortex_cli-4.18.0}/vortex/commands/clone.py

@@ -188,7 +188,7 @@ async def _aclone_app(
 async def _aclone_apps(
     workspace: Workspace,
     server: PuakmaServer,
-    app_ids: list[int],
+    app_ids: set[int],
     get_resources: bool,
     open_urls: bool,
 ) -> int:
@@ -233,10 +233,11 @@ def clone(
     if reclone:
         app_ids.extend(app.id for app in workspace.listapps(server))
 
+    unique_app_ids = set(app_ids)
     with (
         workspace.exclusive_lock(),
-        Spinner(f"Cloning {len(app_ids)} application(s)..."),
+        Spinner(f"Cloning {len(unique_app_ids)} application(s)..."),
     ):
         return asyncio.run(
-            _aclone_apps(workspace, server, app_ids, get_resources, open_urls)
+            _aclone_apps(workspace, server, unique_app_ids, get_resources, open_urls)
         )

{vortex_cli-4.17.2 → vortex_cli-4.18.0}/vortex/commands/export.py

@@ -21,7 +21,7 @@ def _save_bytes(data: bytes, output_path: Path) -> None:
 
 async def _aexport(
     server: PuakmaServer,
-    app_ids: list[int],
+    app_ids: set[int],
     output_dir: Path,
     timeout: int,
     include_source: bool,
@@ -86,7 +86,7 @@ async def _aexport_app_pmx(
 def export(
     workspace: Workspace,
     server: PuakmaServer,
-    app_ids: list[int],
+    app_ids: set[int],
     *,
     timeout: int,
     include_source: bool,

vortex_cli-4.18.0/vortex/commands/import_.py

@@ -0,0 +1,20 @@
+from __future__ import annotations
+
+import logging
+from pathlib import Path
+
+from vortex.models import PuakmaServer
+from vortex.spinner import Spinner
+
+logger = logging.getLogger("vortex")
+
+
+def import_(server: PuakmaServer, pmx_path: Path, name: str, group: str) -> int:
+    with Spinner("Importing..."):
+        with open(pmx_path, "rb") as f:
+            pmx_bytes = f.read()
+
+        with server as s:
+            app_id = s.download_designer.upload_pmx(group, name, pmx_bytes)
+    logger.info(f"Created Application {group}/{name} [{app_id}] from {pmx_path.name}")
+    return 0

{vortex_cli-4.17.2 → vortex_cli-4.18.0}/vortex/commands/new.py

@@ -6,7 +6,6 @@ import base64
 import logging
 import mimetypes
 from collections.abc import Iterable
-from pathlib import Path
 from typing import Any
 
 import tabulate
@@ -20,7 +19,6 @@ from vortex.models import DesignType
 from vortex.models import PuakmaApplication
 from vortex.models import PuakmaServer
 from vortex.soap import AppDesigner
-from vortex.spinner import Spinner
 from vortex.util import render_apps
 from vortex.util import render_objects
 from vortex.workspace import Workspace
@@ -303,17 +301,6 @@ def _new_object(
         return 0
 
 
-def _import_pmx(server: PuakmaServer, group: str, name: str, pmx_path: Path) -> int:
-    with Spinner("Importing..."):
-        with open(pmx_path, "rb") as f:
-            pmx_bytes = f.read()
-
-        with server as s:
-            app_id = s.download_designer.upload_pmx(group, name, pmx_bytes)
-    logger.info(f"Created Application {group}/{name} [{app_id}] from {pmx_path.name}")
-    return 0
-
-
 def _new_app(
     server: PuakmaServer,
     group: str,
@@ -321,11 +308,7 @@ def _new_app(
     inherit_from: str | None,
     template_name: str | None,
     description: str | None,
-    import_path: Path | None,
 ) -> int:
-    if import_path:
-        return _import_pmx(server, group, name, import_path)
-
     app = PuakmaApplication(-1, name, group, inherit_from, template_name, server.host)
     print("The following Application will be created:\n")
     render_apps([app], show_inherited=True)
@@ -398,7 +381,6 @@ def new(workspace: Workspace, server: PuakmaServer, args: argparse.Namespace) ->
             args.inherit_from,
             args.template,
             args.description,
-            args.import_path,
         )
     elif args.subcommand == "keyword":
         return _new_keyword(

{vortex_cli-4.17.2 → vortex_cli-4.18.0}/vortex/main.py

@@ -24,6 +24,7 @@ from vortex.commands.execute import execute
 from vortex.commands.export import export
 from vortex.commands.find import find
 from vortex.commands.grep import grep
+from vortex.commands.import_ import import_
 from vortex.commands.list import list_
 from vortex.commands.log import log
 from vortex.commands.new import new
@@ -95,6 +96,8 @@ def main(argv: Sequence[str] | None = None) -> int:
     cli.add_docs_parser(command_parser)
     cli.add_execute_parser(command_parser)
     cli.add_export_parser(command_parser)
+    cli.add_import_parser(command_parser)
+
     clone_parser = cli.add_clone_parser(command_parser)
     code_parser = cli.add_code_parser(command_parser)
     db_parser = cli.add_db_parser(command_parser)
@@ -124,9 +127,7 @@ def main(argv: Sequence[str] | None = None) -> int:
             return 0
 
         # Non server commands
-        if args.command == "clean":
-            return clean(workspace)
-        elif args.command == "code":
+        if args.command == "code":
             if args.help:
                 code_parser.print_help()
                 util.print_row_break()
@@ -136,8 +137,11 @@ def main(argv: Sequence[str] | None = None) -> int:
             return docs()
 
         server = workspace.read_server_from_config(server_name)
+        logger.debug(f"Using server {server}")
 
-        if args.command == "log":
+        if args.command == "clean":
+            return clean(workspace, server, args.all)
+        elif args.command == "log":
             return log(
                 server,
                 args.limit,
@@ -193,11 +197,13 @@ def main(argv: Sequence[str] | None = None) -> int:
             return export(
                 workspace,
                 server,
-                args.app_ids,
+                set(args.app_ids),
                 timeout=args.timeout,
                 export_dir=args.export_dir,
                 include_source=args.include_source,
             )
+        elif args.command == "import":
+            return import_(server, args.pmx_path, args.name, args.group)
         elif args.command == "watch":
             return watch(workspace, server)
         elif args.command == "find":
@@ -225,9 +231,9 @@ def main(argv: Sequence[str] | None = None) -> int:
                 include_resources=args.include_resources,
             )
         elif args.command == "new":
-            if args.subcommand not in ["object", "app", "keyword"]:
+            if args.subcommand not in ["object", "obj", "app", "keyword", "kw"]:
                 new_parser.error(
-                    "'new' command requires a sub command 'object', 'app' or 'keyword'"
+                    "'new' command requires a sub command 'object', 'obj', 'app' or 'keyword' or 'kw'"
                 )
             return new(workspace, server, args)
         elif args.command == "delete":

{vortex_cli-4.17.2 → vortex_cli-4.18.0}/vortex/models.py

@@ -368,7 +368,7 @@ class PuakmaApplication:
     @classmethod
     def from_dir(cls, path: Path) -> PuakmaApplication:
         """
-        Returns an instance of this class from the .PuakmaApplication.pickle file
+        Returns an instance of this class from the .pma file
         within the given directory.
         Raises ValueError if unsuccessful
         """

{vortex_cli-4.17.2 → vortex_cli-4.18.0}/vortex/spinner.py

@@ -5,7 +5,6 @@ import sys
 import threading
 import time
 from types import TracebackType
-from typing import Literal
 
 
 class Spinner:
@@ -53,6 +52,5 @@ class Spinner:
         exc_type: type[BaseException] | None,
         exc_val: BaseException | None,
         exc_tb: TracebackType | None = None,
-    ) -> Literal[False]:
+    ) -> None:
         self.stop()
-        return False

{vortex_cli-4.17.2 → vortex_cli-4.18.0/vortex_cli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vortex_cli
-Version: 4.17.2
+Version: 4.18.0
 Summary: Vortex CLI
 Author-email: Jordan Amos <jordan.amos@gmail.com>
 License: MIT License

{vortex_cli-4.17.2 → vortex_cli-4.18.0}/vortex_cli.egg-info/SOURCES.txt

@@ -26,6 +26,7 @@ vortex/commands/execute.py
 vortex/commands/export.py
 vortex/commands/find.py
 vortex/commands/grep.py
+vortex/commands/import_.py
 vortex/commands/list.py
 vortex/commands/log.py
 vortex/commands/new.py

vortex_cli-4.17.2/vortex/commands/clean.py

@@ -1,20 +0,0 @@
-from __future__ import annotations
-
-import logging
-import shutil
-
-from vortex.workspace import Workspace
-
-logger = logging.getLogger("vortex")
-
-
-def clean(workspace: Workspace) -> int:
-    app_dirs = workspace.listdir(strict=False)
-    if app_dirs:
-        with workspace.exclusive_lock():
-            for app_dir in app_dirs:
-                shutil.rmtree(app_dir)
-                logger.debug(f"Deleted directory '{app_dir}'")
-            workspace.update_vscode_settings()
-    logger.info("Workspace cleaned")
-    return 0