vortex-cli 4.0.2__tar.gz → 4.1.1__tar.gz

{vortex_cli-4.0.2 → vortex_cli-4.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vortex_cli
-Version: 4.0.2
+Version: 4.1.1
 Summary: Vortex CLI
 Home-page: https://github.com/jordanamos/vortex-cli
 Author: Jordan Amos

{vortex_cli-4.0.2 → vortex_cli-4.1.1}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = vortex_cli
-version = 4.0.2
+version = 4.1.1
 description = Vortex CLI
 long_description = file: README.md
 long_description_content_type = text/markdown
@@ -39,7 +39,7 @@ console_scripts =
 [options.package_data]
 vortex = 
 	puakma/**/*.jar
-	docs/tornado.pdf
+	docs/*.pdf
 
 [flake8]
 max-line-length = 88

{vortex_cli-4.0.2 → vortex_cli-4.1.1}/vortex/cli.py

@@ -41,6 +41,17 @@ def _add_design_type_option(
     )
 
 
+def _add_colour_option(
+    parser: ArgumentParser | _MutuallyExclusiveGroup,
+) -> None:
+    parser.add_argument(
+        "--no-colour",
+        action="store_false",
+        dest="use_colour",
+        help="Suppress coloured output",
+    )
+
+
 def add_code_parser(
     command_parser: _SubParsersAction[ArgumentParser],
 ) -> ArgumentParser:
@@ -192,6 +203,7 @@ def add_watch_parser(command_parser: _SubParsersAction[ArgumentParser]) -> None:
         ),
     )
     _add_server_option(watch_parser)
+    _add_colour_option(watch_parser)
 
 
 def add_clean_parser(command_parser: _SubParsersAction[ArgumentParser]) -> None:
@@ -264,6 +276,7 @@ def add_log_parser(command_parser: _SubParsersAction[ArgumentParser]) -> None:
     log_type_mutex.add_argument("--info-only", action="store_true")
     log_parser.add_argument("--keep-alive", action="store_true")
     _add_server_option(log_parser)
+    _add_colour_option(log_parser)
 
 
 def add_find_parser(command_parser: _SubParsersAction[ArgumentParser]) -> None:
@@ -313,6 +326,7 @@ def add_grep_parser(command_parser: _SubParsersAction[ArgumentParser]) -> None:
 
     _add_design_type_option(grep_design_type_mutex)
     _add_server_option(grep_parser)
+    _add_colour_option(grep_parser)
 
 
 def add_new_parser(
@@ -359,6 +373,7 @@ def add_delete_parser(command_parser: _SubParsersAction[ArgumentParser]) -> None
     )
     delete_parser.add_argument("obj_ids", nargs="+", type=int, metavar="DESIGN_ID")
     _add_server_option(delete_parser)
+    _add_colour_option(delete_parser)
 
 
 def add_db_parser(command_parser: _SubParsersAction[ArgumentParser]) -> None:

vortex_cli-4.1.1/vortex/colour.py

@@ -0,0 +1,40 @@
+from __future__ import annotations
+
+import os
+import sys
+
+
+NORMAL = "\033[m"
+RED = "\033[41m"
+BOLD = "\033[1m"
+GREEN = "\033[42m"
+YELLOW = "\033[43;30m"
+TURQUOISE = "\033[46;30m"
+
+_terminal_supports_colour = sys.stdout.isatty() and os.getenv("TERM") != "dumb"
+_use_colour = _terminal_supports_colour
+
+
+def set_use_colour(use_colour: bool) -> None:
+    global _use_colour
+    _use_colour = _terminal_supports_colour and use_colour
+
+
+def colour(
+    text: str,
+    colour: str,
+    replace_in: str | None = None,
+    use_colour: bool | None = None,
+) -> str:
+    _do_colour = _use_colour
+    if use_colour is not None:
+        _do_colour = _terminal_supports_colour and use_colour
+
+    if _do_colour:
+        coloured_text = f"{colour}{text}{NORMAL}"
+    else:
+        coloured_text = text
+
+    if replace_in:
+        coloured_text = replace_in.replace(text, coloured_text)
+    return coloured_text

{vortex_cli-4.0.2 → vortex_cli-4.1.1}/vortex/commands/delete.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 import asyncio
 import logging
 
-from vortex.colour import Colour
+from vortex import colour
 from vortex.models import DesignObject
 from vortex.models import PuakmaServer
 from vortex.soap import AppDesigner
@@ -16,6 +16,7 @@ logger = logging.getLogger("vortex")
 def delete(
     workspace: Workspace,
     server: PuakmaServer,
+    use_colour: bool,
     obj_ids: list[int],
 ) -> int:
     objs = []
@@ -30,7 +31,7 @@ def delete(
         logger.error(f"No cloned Design Object found with ID {obj_ids}")
         return 1
 
-    _deleted = Colour.highlight("deleted", Colour.RED)
+    _deleted = colour.colour("deleted", colour.RED, use_colour=use_colour)
     print(f"The following Design Objects will be {_deleted}:\n")
     render_objects(objs)
     if input("\n[Y/y] to continue:") not in ["Y", "y"]:

{vortex_cli-4.0.2 → vortex_cli-4.1.1}/vortex/commands/grep.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 import functools
 import re
 
-from vortex.colour import Colour
+from vortex import colour
 from vortex.models import DesignObject
 from vortex.models import DesignType
 from vortex.models import PuakmaServer
@@ -13,6 +13,7 @@ from vortex.workspace import Workspace
 def grep(
     workspace: Workspace,
     server: PuakmaServer,
+    use_colour: bool,
     pattern: str,
     *,
     app_ids: list[int] | None = None,
@@ -21,6 +22,8 @@ def grep(
     output_paths: bool = False,
     exclude_resources: bool = True,
 ) -> int:
+    colour.set_use_colour(use_colour)
+
     if exclude_resources:
         design_types = [t for t in DesignType if t != DesignType.RESOURCE]
 
@@ -77,5 +80,5 @@ def _output(
     else:
         matched_text = match.group().decode()
         line = text.splitlines()[line_indx].strip()
-        new_text = Colour.highlight(matched_text, Colour.RED, line)
-        print(f"{Colour.highlight(obj.file_name, Colour.BOLD)}:{line_no} {new_text}")
+        new_text = colour.colour(matched_text, colour.RED, line)
+        print(f"{colour.colour(obj.file_name, colour.BOLD)}:{line_no} {new_text}")

{vortex_cli-4.0.2 → vortex_cli-4.1.1}/vortex/commands/log.py

@@ -6,21 +6,22 @@ from datetime import datetime
 
 import tabulate
 
+from vortex import colour
 from vortex import util
-from vortex.colour import Colour
 from vortex.models import LogItem
 from vortex.models import PuakmaServer
 from vortex.spinner import Spinner
 
 _LOG_TYPE_COLOUR_MAP = {
-    "D": Colour.YELLOW,
-    "I": Colour.TURQUOISE,
-    "E": Colour.RED,
+    "D": colour.YELLOW,
+    "I": colour.TURQUOISE,
+    "E": colour.RED,
 }
 
 
 def log(
     server: PuakmaServer,
+    use_colour: bool,
     limit: int,
     source_filter: str | None,
     messsage_filter: str | None,
@@ -30,6 +31,7 @@ def log(
     keep_alive: bool = False,
     delay: int = 3,
 ) -> int:
+    colour.set_use_colour(use_colour)
     with server as s:
         get_logs = functools.partial(
             s.get_last_log_items,
@@ -68,7 +70,7 @@ def _format_log_rows(logs: list[LogItem]) -> list[tuple[str, str, str]]:
     for log in sorted(logs, key=lambda x: x.date):
         log_colour = _LOG_TYPE_COLOUR_MAP[log.type]
         row = (
-            Colour.highlight(datetime.strftime(log.date, "%H:%M:%S"), log_colour),
+            colour.colour(datetime.strftime(log.date, "%H:%M:%S"), log_colour),
             util.shorten_or_pad_text(log.item_source, min_len=30),
             log.msg,
         )

{vortex_cli-4.0.2 → vortex_cli-4.1.1}/vortex/commands/watch.py

@@ -11,7 +11,7 @@ from watchfiles import awatch
 from watchfiles import BaseFilter
 from watchfiles import Change
 
-from vortex.colour import Colour
+from vortex import colour
 from vortex.models import DesignObject
 from vortex.models import DesignObjectAmbiguousError
 from vortex.models import DesignObjectNotFound
@@ -281,7 +281,7 @@ class WorkspaceWatcher:
 
     def _confirm_change(self, change: Change, obj: DesignObject) -> bool:
         action = {
-            change.deleted: Colour.highlight("delete", Colour.RED),
+            change.deleted: colour.colour("delete", colour.RED),
             change.modified: "update",
             change.added: "create",
         }[change]
@@ -327,7 +327,7 @@ def _validate_java_class_file(
     return True, ""
 
 
-def watch(workspace: Workspace, server: PuakmaServer) -> int:
+def watch(workspace: Workspace, server: PuakmaServer, use_colour: bool) -> int:
     if not workspace.listdir():
         logger.error(f"No application directories to watch in workspace '{workspace}'")
         return 1
@@ -335,5 +335,6 @@ def watch(workspace: Workspace, server: PuakmaServer) -> int:
         workspace.exclusive_lock(),
         Spinner("Watching workspace, ^C to stop") as spinner,
     ):
+        colour.set_use_colour(use_colour)
         watcher = WorkspaceWatcher(workspace, server, spinner)
         return asyncio.run(watcher.watch())

{vortex_cli-4.0.2 → vortex_cli-4.1.1}/vortex/main.py

@@ -73,13 +73,13 @@ def main(argv: Sequence[str] | None = None) -> int:
         "--verbose",
         "--debug",
         "-v",
-        help="Set this flag to see DEBUG messages",
+        help="Show debug messages",
         action="store_true",
     )
     parser.add_argument(
         "--init",
         action="store_true",
-        help="Initialises the workspace and config files, if they don't already exist",
+        help="Initialise the workspace and config files, if they don't already exist",
     )
 
     command_parser = parser.add_subparsers(dest="command")
@@ -177,10 +177,11 @@ def main(argv: Sequence[str] | None = None) -> int:
                     export_pmx_path=args.pmx,
                 )
             elif args.command == "watch":
-                return watch(workspace, server)
+                return watch(workspace, server, args.use_colour)
             elif args.command == "log":
                 return log(
                     server,
+                    args.use_colour,
                     args.limit,
                     args.source,
                     args.message,
@@ -205,6 +206,7 @@ def main(argv: Sequence[str] | None = None) -> int:
                 return grep(
                     workspace,
                     server,
+                    args.use_colour,
                     args.pattern,
                     app_ids=args.app_ids,
                     design_types=args.design_type,
@@ -227,7 +229,7 @@ def main(argv: Sequence[str] | None = None) -> int:
                     save_action=args.save_action,
                 )
             elif args.command == "delete":
-                return delete(workspace, server, args.obj_ids)
+                return delete(workspace, server, args.use_colour, args.obj_ids)
             elif args.command == "copy":
                 return copy(
                     workspace,

{vortex_cli-4.0.2 → vortex_cli-4.1.1}/vortex_cli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vortex-cli
-Version: 4.0.2
+Version: 4.1.1
 Summary: Vortex CLI
 Home-page: https://github.com/jordanamos/vortex-cli
 Author: Jordan Amos

{vortex_cli-4.0.2 → vortex_cli-4.1.1}/vortex_cli.egg-info/SOURCES.txt

@@ -30,6 +30,7 @@ vortex/commands/log.py
 vortex/commands/new.py
 vortex/commands/upload.py
 vortex/commands/watch.py
+vortex/docs/Tornado Server Blackbook.pdf
 vortex/puakma/lib/XmlSchema-1.4.2.jar
 vortex/puakma/lib/activation-1.1.jar
 vortex/puakma/lib/annogen-0.1.0.jar

vortex_cli-4.0.2/vortex/colour.py

@@ -1,26 +0,0 @@
-from __future__ import annotations
-
-import os
-import sys
-from enum import Enum
-
-
-class Colour(Enum):
-    NORMAL = "\033[m"
-    RED = "\033[41m"
-    BOLD = "\033[1m"
-    GREEN = "\033[42m"
-    YELLOW = "\033[43;30m"
-    TURQUOISE = "\033[46;30m"
-
-    _use_colour = sys.stdout.isatty() and os.getenv("TERM") != "dumb"
-
-    @classmethod
-    def highlight(cls, text: str, colour: Colour, replace_in: str | None = None) -> str:
-        if cls._use_colour:
-            new_text = f"{colour.value}{text}{cls.NORMAL.value}"
-        else:
-            new_text = text
-        if replace_in:
-            new_text = replace_in.replace(text, new_text)
-        return new_text