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

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

@@ -1,11 +1,31 @@
 Metadata-Version: 2.1
 Name: vortex_cli
-Version: 4.17.1
-Home-page: https://github.com/jordanamos/vortex-cli
-Author: Jordan Amos
-Author-email: jordan.amos@gmail.com
-License: MIT
-Keywords: vortex cli
+Version: 4.17.2
+Summary: Vortex CLI
+Author-email: Jordan Amos <jordan.amos@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2023 jordanamos
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Keywords: vortex,cli,puakma,tornado
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Natural Language :: English

vortex_cli-4.17.2/pyproject.toml

@@ -0,0 +1,139 @@
+# https://packaging.python.org/en/latest/tutorials/packaging-projects/#choosing-build-backend
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "vortex_cli"
+version = "4.17.2"
+description = "Vortex CLI"
+requires-python = ">=3.10"
+readme = { file = "README.md", content-type = "text/markdown" }
+license = { file = "LICENSE" }
+keywords = ["vortex", "cli", "puakma", "tornado"]
+dependencies = [
+    "httpx==0.24.1",
+    "tabulate==0.9.0",
+    "watchfiles==0.19.0"
+]
+authors = [
+    { name = "Jordan Amos", email = "jordan.amos@gmail.com" }
+]
+classifiers = [
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Natural Language :: English",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only"
+]
+
+[project.entry-points."console_scripts"]
+vortex = "vortex.__main__:main"
+
+[tool.setuptools.package-data]
+vortex = ["lib/puakma-6.0.37.jar", "docs/Blackbook.pdf"]
+
+[tool.mypy]
+check_untyped_defs = true
+disallow_any_generics = true
+disallow_incomplete_defs = true
+disallow_untyped_defs = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+
+[[tool.mypy.overrides]]
+module = ["tests.*", "testing.*"]
+disallow_untyped_defs = false
+
+[tool.ruff]
+# Exclude a variety of commonly ignored directories.
+exclude = [
+    ".bzr",
+    ".direnv",
+    ".eggs",
+    ".git",
+    ".git-rewrite",
+    ".hg",
+    ".ipynb_checkpoints",
+    ".mypy_cache",
+    ".nox",
+    ".pants.d",
+    ".pyenv",
+    ".pytest_cache",
+    ".pytype",
+    ".ruff_cache",
+    ".svn",
+    ".tox",
+    ".venv",
+    ".vscode",
+    "__pypackages__",
+    "_build",
+    "buck-out",
+    "build",
+    "dist",
+    "node_modules",
+    "site-packages",
+    "venv",
+]
+
+# Same as Black.
+line-length = 88
+indent-width = 4
+
+# Assume Python 3.10
+target-version = "py310"
+
+[tool.ruff.lint]
+# Enable Pyflakes (`F`) and a subset of the pycodestyle (`E`)  codes by default.
+# Unlike Flake8, Ruff doesn't enable pycodestyle warnings (`W`) or
+# McCabe complexity (`C901`) by default.
+
+# E = pycodestyle https://docs.astral.sh/ruff/rules/#error-e
+# F = pyflakes https://docs.astral.sh/ruff/rules/#pyflakes-f
+# UP = pyupgrade https://docs.astral.sh/ruff/rules/#pyupgrade-up
+# A = flake8 builtins https://docs.astral.sh/ruff/rules/#flake8-builtins-a
+# B = flake8 bugbear https://docs.astral.sh/ruff/rules/#flake8-bugbear-b
+# I = isort https://docs.astral.sh/ruff/rules/#isort-i
+select = ["E4", "E7", "E9", "F" ,"UP", "A", "B", "I"]
+
+# UP031 Use format specifiers instead of percent format
+ignore = ["UP031"]
+
+# Allow fix for all enabled rules (when `--fix`) is provided.
+fixable = ["ALL"]
+unfixable = []
+
+# Allow unused variables when underscore-prefixed.
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+
+[tool.ruff.format]
+# Like Black, use double quotes for strings.
+quote-style = "double"
+
+# Like Black, indent with spaces, rather than tabs.
+indent-style = "space"
+
+# Like Black, respect magic trailing commas.
+skip-magic-trailing-comma = false
+
+# Like Black, automatically detect the appropriate line ending.
+line-ending = "auto"
+
+# Enable auto-formatting of code examples in docstrings. Markdown,
+# reStructuredText code/literal blocks and doctests are all supported.
+#
+# This is currently disabled by default, but it is planned for this
+# to be opt-out in the future.
+docstring-code-format = false
+
+# Set the line length limit used when formatting code snippets in
+# docstrings.
+#
+# This only has an effect when the `docstring-code-format` setting is
+# enabled.
+docstring-code-line-length = "dynamic"
+
+[tool.ruff.lint.isort]
+force-single-line = true
+required-imports = ["from __future__ import annotations"]

vortex_cli-4.17.2/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

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

@@ -1,13 +1,13 @@
 from __future__ import annotations
 
 import functools
-from argparse import _ArgumentGroup
-from argparse import _MutuallyExclusiveGroup
-from argparse import _SubParsersAction
 from argparse import ArgumentParser
 from argparse import ArgumentTypeError
 from argparse import Namespace
 from argparse import RawDescriptionHelpFormatter
+from argparse import _ArgumentGroup
+from argparse import _MutuallyExclusiveGroup
+from argparse import _SubParsersAction
 from pathlib import Path
 
 from vortex.models import DesignType
@@ -32,10 +32,10 @@ _EXECUTE_PARSER_DESCRIPTION = """\
 """
 
 
-def _check_int_in_range(val: str, min: int = 0, max: int | None = 50) -> int:
+def _check_int_in_range(val: str, min_: int = 0, max_: int | None = 50) -> int:
     new_val = int(val)
-    if new_val < min or (max is not None and new_val > max):
-        raise ArgumentTypeError(f"%s is not between {min} and {max}. " % val)
+    if new_val < min_ or (max_ is not None and new_val > max_):
+        raise ArgumentTypeError(f"%s is not between {min_} and {max_}. " % val)
     return new_val
 
 
@@ -248,28 +248,6 @@ def add_clone_parser(
         help="Open the application and webdesign URLs after cloning",
         action="store_true",
     )
-    clone_parser.add_argument(
-        "--export",
-        nargs="?",
-        metavar="DIR",
-        dest="export_path",
-        const="",
-        help=(
-            "Export applications in the .pmx format to a destination "
-            "folder. Default is 'exports' in the workspace."
-        ),
-        type=Path,
-    )
-    clone_parser.add_argument(
-        "--timeout",
-        "-t",
-        type=int,
-        default=100,
-        help=(
-            "Set the timeout duration in seconds when using --export. "
-            "Default is %(default)s."
-        ),
-    )
     _add_server_option(clone_parser)
     return clone_parser
 
@@ -373,6 +351,7 @@ def add_config_parser(command_parser: _SubParsersAction[ArgumentParser]) -> None
         "--set",
         help="Set an option value in a section. --set <section> <option> <value>",
         nargs=3,
+        dest="set_config",
         metavar=("SECTION", "OPTION", "VALUE"),
     )
     _add_server_option(config_parser)
@@ -399,7 +378,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", "-k", action="store_true")
 
-    _positive_int = functools.partial(_check_int_in_range, min=1)
+    _positive_int = functools.partial(_check_int_in_range, min_=1)
     log_parser.add_argument(
         "--delay",
         "-d",

{vortex_cli-4.17.1 → vortex_cli-4.17.2}/vortex/commands/clean.py

@@ -5,7 +5,6 @@ import shutil
 
 from vortex.workspace import Workspace
 
-
 logger = logging.getLogger("vortex")
 
 

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

@@ -86,7 +86,7 @@ def _parse_app_xml(
     major, minor = (int(v) for v in java_version_ele.text.split(".", maxsplit=1))
     version: JavaClassVersion = (major, minor)
     app = PuakmaApplication(
-        id=int(app_ele.attrib["id"]),
+        id_=int(app_ele.attrib["id"]),
         name=app_ele.attrib["name"],
         group=app_ele.attrib["group"],
         inherit_from=app_ele.attrib["inherit"],
@@ -168,8 +168,8 @@ async def _aclone_app(
     app.design_objects = _match_and_validate_design_objs(app, objs, eles)
     app_dir = workspace.mkdir(app, True)
 
-    for dir in DesignType.dirs():
-        (app_dir / dir).mkdir()
+    for dir_ in DesignType.dirs():
+        (app_dir / dir_).mkdir()
 
     try:
         logger.debug(f"Saving {len(objs)} Design Objects for [{app}]...")
@@ -235,7 +235,7 @@ def clone(
 
     with (
         workspace.exclusive_lock(),
-        Spinner(f"Cloning{len(app_ids)} application(s)..."),
+        Spinner(f"Cloning {len(app_ids)} application(s)..."),
     ):
         return asyncio.run(
             _aclone_apps(workspace, server, app_ids, get_resources, open_urls)

{vortex_cli-4.17.1 → vortex_cli-4.17.2}/vortex/commands/config.py

@@ -20,7 +20,7 @@ def config(
     output_workspace_path: bool = False,
     output_server_config: bool = False,
     list_servers: bool = False,
-    set: tuple[str, str, str] | None = None,
+    set_config: tuple[str, str, str] | None = None,
 ) -> int:
     if print_sample:
         print(SAMPLE_CONFIG, end="")
@@ -37,6 +37,6 @@ def config(
     elif list_servers:
         for s in workspace.list_servers():
             print(s)
-    elif set:
-        workspace.set_config(*set)
+    elif set_config:
+        workspace.set_config(*set_config)
     return 0

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

@@ -94,7 +94,7 @@ def export(
 ) -> int:
     with (
         workspace.exclusive_lock(),
-        Spinner(f"Exoprting {len(app_ids)} application(s)..."),
+        Spinner(f"Exporting {len(app_ids)} application(s)..."),
     ):
         if export_dir is None:
             export_dir = workspace.exports_dir

{vortex_cli-4.17.1 → vortex_cli-4.17.2}/vortex/commands/find.py

@@ -20,7 +20,7 @@ def find(
     search_inherits_from: bool = False,
 ) -> int:
     if app_ids:
-        apps = [workspace.lookup_app(server, id) for id in app_ids]
+        apps = [workspace.lookup_app(server, id_) for id_ in app_ids]
     else:
         apps = workspace.listapps(server)
 

{vortex_cli-4.17.1 → vortex_cli-4.17.2}/vortex/commands/watch.py

@@ -7,9 +7,9 @@ import sys
 from pathlib import Path
 from typing import Literal
 
-from watchfiles import awatch
 from watchfiles import BaseFilter
 from watchfiles import Change
+from watchfiles import awatch
 
 from vortex.colour import Colour
 from vortex.models import DesignObject
@@ -299,7 +299,7 @@ class WorkspaceWatcher:
             sys.stdout.flush()
             res = sys.stdin.readline().strip()
         except (KeyboardInterrupt, Exception) as e:
-            raise asyncio.CancelledError(e)
+            raise asyncio.CancelledError(e) from e
         else:
             return res in ["Y", "y"]
         finally:

{vortex_cli-4.17.1 → vortex_cli-4.17.2}/vortex/constants.py

@@ -2,5 +2,4 @@ from __future__ import annotations
 
 import importlib.metadata
 
-
 VERSION = importlib.metadata.version("vortex_cli")

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

@@ -28,12 +28,11 @@ from vortex.commands.list import list_
 from vortex.commands.log import log
 from vortex.commands.new import new
 from vortex.commands.watch import watch
-from vortex.logging import logging_handler
 from vortex.logging import LoggingHandler
+from vortex.logging import logging_handler
 from vortex.workspace import Workspace
 from vortex.workspace import WorkspaceError
 
-
 logger = logging.getLogger("vortex")
 
 
@@ -43,9 +42,9 @@ def error_handler() -> Generator[None]:
         yield
     except (WorkspaceError, HTTPStatusError) as e:
         logger.error(e)
-        raise SystemExit(1)
+        raise SystemExit(1) from e
     except KeyboardInterrupt:
-        raise SystemExit(130)
+        raise SystemExit(130) from None
     except Exception as e:
         msg = f"An unexpected error occured. {e}".rstrip()
         logger.critical(msg)
@@ -161,7 +160,7 @@ def main(argv: Sequence[str] | None = None) -> int:
                 output_workspace_path=args.output_workspace_path,
                 output_server_config=args.output_server_config,
                 list_servers=args.list_servers,
-                set=args.set,
+                set_config=args.set_config,
             )
         elif args.command in ("list", "ls"):
             local_only = args.show_local_only or args.command == "ls"

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

@@ -14,9 +14,9 @@ from enum import IntEnum
 from io import StringIO
 from pathlib import Path
 from types import TracebackType
+from typing import TYPE_CHECKING
 from typing import Any
 from typing import NamedTuple
-from typing import TYPE_CHECKING
 
 import httpx
 
@@ -252,7 +252,18 @@ class PuakmaServer:
         query = _PUAKMA_APPLICATION_QUERY % where.getvalue()
         where.close()
         resp = self.database_designer.execute_query(self.puakma_db_conn_id, query)
-        return [PuakmaApplication(**app, host=self.host) for app in resp]
+        ret = []
+        for app_dict in resp:
+            app = PuakmaApplication(
+                app_dict["id"],
+                app_dict["name"],
+                app_dict["group"],
+                app_dict["inherit_from"],
+                app_dict["template_name"],
+                self.host,
+            )
+            ret.append(app)
+        return ret
 
     def get_last_log_items(
         self,
@@ -306,7 +317,7 @@ class PuakmaApplication:
 
     def __init__(
         self,
-        id: int,
+        id_: int,
         name: str,
         group: str,
         inherit_from: str | None,
@@ -315,7 +326,7 @@ class PuakmaApplication:
         db_connections: tuple[DatabaseConnection, ...] | None = None,
         java_class_version: JavaClassVersion | None = None,
     ) -> None:
-        self.id = id
+        self.id = id_
         self.name = name
         self.group = group
         # Some apps dont have a group. Adding a palce holder will
@@ -368,7 +379,7 @@ class PuakmaApplication:
             if not isinstance(app, cls):
                 raise TypeError(f"Unexpected instance of type {type(app)}")
         except Exception as e:
-            raise ValueError(f"Error initialising {cls}: {e}")
+            raise ValueError(f"Error initialising {cls}: {e}") from e
         else:
             return app
 
@@ -669,7 +680,9 @@ class DesignPath:
             if must_exist and not path.exists():
                 raise ValueError(f"Design Object '{path}' does not exist")
         except ValueError as e:
-            raise InvalidDesignPathError(f"Invalid path to Design Object '{path}': {e}")
+            raise InvalidDesignPathError(
+                f"Invalid path to Design Object '{path}': {e}"
+            ) from e
 
         self.workspace = workspace
         self.path = path

{vortex_cli-4.17.1 → vortex_cli-4.17.2}/vortex/workspace.py

@@ -119,9 +119,9 @@ class Workspace:
 
     def init(self) -> None:
         dirs = [self.path, self.config_dir]
-        for dir in dirs:
-            if not dir.is_dir():
-                dir.mkdir()
+        for dir_ in dirs:
+            if not dir_.is_dir():
+                dir_.mkdir()
 
         if not self.server_config_file.exists():
             with open(self.server_config_file, "w") as f:
@@ -218,7 +218,7 @@ class Workspace:
             config.write(f)
 
     def listapps(self, server: PuakmaServer | None = None) -> list[PuakmaApplication]:
-        return [PuakmaApplication.from_dir(dir) for dir in self.listdir(server)]
+        return [PuakmaApplication.from_dir(dir_) for dir_ in self.listdir(server)]
 
     def list_servers(self) -> list[str]:
         config = configparser.ConfigParser()
@@ -300,14 +300,14 @@ class Workspace:
         vortex_dirs = [self.vscode_dir, self.config_dir, self.exports_dir]
         if self.logs_dir.is_dir():
             vortex_dirs.append(self.logs_dir)
-        folders = [{"path": str(dir)} for dir in vortex_dirs]
+        folders = [{"path": str(dir_)} for dir_ in vortex_dirs]
         folders.extend(
             [
                 {
-                    "path": str(dir),
-                    "name": str(PuakmaApplication.from_dir(dir)),
+                    "path": str(dir_),
+                    "name": str(PuakmaApplication.from_dir(dir_)),
                 }
-                for dir in self.listdir(server)
+                for dir_ in self.listdir(server)
             ]
         )
         folder_settings = {"folders": folders}

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

@@ -1,11 +1,31 @@
 Metadata-Version: 2.1
 Name: vortex_cli
-Version: 4.17.1
-Home-page: https://github.com/jordanamos/vortex-cli
-Author: Jordan Amos
-Author-email: jordan.amos@gmail.com
-License: MIT
-Keywords: vortex cli
+Version: 4.17.2
+Summary: Vortex CLI
+Author-email: Jordan Amos <jordan.amos@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2023 jordanamos
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Keywords: vortex,cli,puakma,tornado
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Natural Language :: English

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

@@ -1,7 +1,6 @@
 LICENSE
 README.md
-setup.cfg
-setup.py
+pyproject.toml
 vortex/__init__.py
 vortex/__main__.py
 vortex/cli.py

vortex_cli-4.17.1/setup.cfg

@@ -1,60 +0,0 @@
-[metadata]
-name = vortex_cli
-version = 4.17.1
-long_description = file: README.md
-long_description_content_type = text/markdown
-url = https://github.com/jordanamos/vortex-cli
-author = Jordan Amos
-author_email = jordan.amos@gmail.com
-license = MIT
-license_files = LICENSE
-classifiers = 
-	Intended Audience :: Developers
-	License :: OSI Approved :: MIT License
-	Natural Language :: English
-	Programming Language :: Python
-	Programming Language :: Python :: 3
-	Programming Language :: Python :: 3 :: Only
-keywords = vortex cli
-vdescription = Vortex CLI
-
-[options]
-packages = find:
-install_requires = 
-	httpx==0.24.1
-	tabulate==0.9.0
-	watchfiles==0.19.0
-python_requires = >=3.10
-
-[options.packages.find]
-exclude = 
-	tests*
-	testing*
-
-[options.entry_points]
-console_scripts = 
-	vortex = vortex.__main__:main
-
-[options.package_data]
-vortex = 
-	lib/puakma-6.0.37.jar
-	docs/Blackbook.pdf
-
-[flake8]
-max-line-length = 88
-
-[mypy]
-check_untyped_defs = true
-disallow_any_generics = true
-disallow_incomplete_defs = true
-disallow_untyped_defs = true
-warn_redundant_casts = true
-warn_unused_ignores = true
-
-[mypy-tests.*]
-disallow_untyped_defs = false
-
-[egg_info]
-tag_build = 
-tag_date = 0
-

vortex_cli-4.17.1/setup.py

@@ -1,5 +0,0 @@
-from __future__ import annotations
-
-from setuptools import setup
-
-setup()

{vortex_cli-4.17.1 → vortex_cli-4.17.2}/vortex/soap.py

@@ -7,17 +7,17 @@ import logging
 import xml.etree.ElementTree as ET
 from abc import ABC
 from collections.abc import Generator
+from typing import TYPE_CHECKING
 from typing import Any
 from typing import Literal
 from typing import NamedTuple
 from typing import NoReturn
-from typing import TYPE_CHECKING
 
 from vortex import constants as C
 
 if TYPE_CHECKING:
-    from vortex.models import PuakmaServer
     from vortex.models import DesignObject
+    from vortex.models import PuakmaServer
 
 
 logger = logging.getLogger("vortex")

{vortex_cli-4.17.1 → vortex_cli-4.17.2}/vortex/util.py

@@ -12,9 +12,9 @@ from collections.abc import Generator
 from collections.abc import Iterable
 from pathlib import Path
 from types import TracebackType
-from typing import Any
 from typing import IO
 from typing import TYPE_CHECKING
+from typing import Any
 
 import tabulate