linode-cli 5.48.4__tar.gz → 5.49.0__tar.gz

linode_cli-5.49.0/MANIFEST.in

@@ -0,0 +1,2 @@
+include linodecli/data-3
+include linodecli/oauth-landing-page.html

{linode_cli-5.48.4/linode_cli.egg-info → linode_cli-5.49.0}/PKG-INFO

@@ -1,11 +1,9 @@
 Metadata-Version: 2.1
 Name: linode-cli
-Version: 5.48.4
-Summary: CLI for the Linode API
-Home-page: https://www.linode.com/docs/api/
-Author: Linode
-Author-email: developers@linode.com
-License: BSD 3-Clause License
+Version: 5.49.0
+Summary: The official command-line interface for interacting with the Linode API.
+Author-email: "Akamai Technologies Inc." <developers@linode.com>
+License: BSD-3-Clause
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
@@ -15,9 +13,20 @@ Requires-Dist: PyYAML
 Requires-Dist: packaging
 Requires-Dist: rich
 Requires-Dist: urllib3<3
-Requires-Dist: linode-metadata
+Requires-Dist: linode-metadata>=0.3.0
 Provides-Extra: obj
 Requires-Dist: boto3; extra == "obj"
+Provides-Extra: dev
+Requires-Dist: pylint>=2.17.4; extra == "dev"
+Requires-Dist: pytest>=7.3.1; extra == "dev"
+Requires-Dist: black>=23.1.0; extra == "dev"
+Requires-Dist: isort>=5.12.0; extra == "dev"
+Requires-Dist: autoflake>=2.0.1; extra == "dev"
+Requires-Dist: pytest-mock>=3.10.0; extra == "dev"
+Requires-Dist: requests-mock==1.12.1; extra == "dev"
+Requires-Dist: boto3-stubs[s3]; extra == "dev"
+Requires-Dist: build>=0.10.0; extra == "dev"
+Requires-Dist: twine>=4.0.2; extra == "dev"
 
 # linode-cli (lin)
 

{linode_cli-5.48.4 → linode_cli-5.49.0/linode_cli.egg-info}/PKG-INFO

@@ -1,11 +1,9 @@
 Metadata-Version: 2.1
 Name: linode-cli
-Version: 5.48.4
-Summary: CLI for the Linode API
-Home-page: https://www.linode.com/docs/api/
-Author: Linode
-Author-email: developers@linode.com
-License: BSD 3-Clause License
+Version: 5.49.0
+Summary: The official command-line interface for interacting with the Linode API.
+Author-email: "Akamai Technologies Inc." <developers@linode.com>
+License: BSD-3-Clause
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
@@ -15,9 +13,20 @@ Requires-Dist: PyYAML
 Requires-Dist: packaging
 Requires-Dist: rich
 Requires-Dist: urllib3<3
-Requires-Dist: linode-metadata
+Requires-Dist: linode-metadata>=0.3.0
 Provides-Extra: obj
 Requires-Dist: boto3; extra == "obj"
+Provides-Extra: dev
+Requires-Dist: pylint>=2.17.4; extra == "dev"
+Requires-Dist: pytest>=7.3.1; extra == "dev"
+Requires-Dist: black>=23.1.0; extra == "dev"
+Requires-Dist: isort>=5.12.0; extra == "dev"
+Requires-Dist: autoflake>=2.0.1; extra == "dev"
+Requires-Dist: pytest-mock>=3.10.0; extra == "dev"
+Requires-Dist: requests-mock==1.12.1; extra == "dev"
+Requires-Dist: boto3-stubs[s3]; extra == "dev"
+Requires-Dist: build>=0.10.0; extra == "dev"
+Requires-Dist: twine>=4.0.2; extra == "dev"
 
 # linode-cli (lin)
 

{linode_cli-5.48.4 → linode_cli-5.49.0}/linode_cli.egg-info/SOURCES.txt

@@ -1,10 +1,7 @@
 LICENSE
 MANIFEST.in
 README.md
-baked_version
-linode-cli.sh
 pyproject.toml
-requirements.txt
 setup.py
 linode_cli.egg-info/PKG-INFO
 linode_cli.egg-info/SOURCES.txt
@@ -19,10 +16,12 @@ linodecli/arg_helpers.py
 linodecli/cli.py
 linodecli/completion.py
 linodecli/data-3
+linodecli/help_pages.py
 linodecli/helpers.py
 linodecli/oauth-landing-page.html
 linodecli/output.py
 linodecli/overrides.py
+linodecli/version.py
 linodecli/baked/__init__.py
 linodecli/baked/colors.py
 linodecli/baked/operation.py
@@ -30,17 +29,20 @@ linodecli/baked/request.py
 linodecli/baked/response.py
 linodecli/configuration/__init__.py
 linodecli/configuration/auth.py
+linodecli/configuration/config.py
 linodecli/configuration/helpers.py
 linodecli/plugins/__init__.py
 linodecli/plugins/firewall-editor.py
 linodecli/plugins/get-kubeconfig.py
 linodecli/plugins/image-upload.py
 linodecli/plugins/metadata.py
+linodecli/plugins/plugins.py
 linodecli/plugins/region-table.py
 linodecli/plugins/ssh.py
 linodecli/plugins/obj/__init__.py
 linodecli/plugins/obj/buckets.py
 linodecli/plugins/obj/config.py
 linodecli/plugins/obj/helpers.py
+linodecli/plugins/obj/list.py
 linodecli/plugins/obj/objects.py
 linodecli/plugins/obj/website.py

linode_cli-5.49.0/linode_cli.egg-info/requires.txt

@@ -0,0 +1,22 @@
+openapi3
+requests
+PyYAML
+packaging
+rich
+urllib3<3
+linode-metadata>=0.3.0
+
+[dev]
+pylint>=2.17.4
+pytest>=7.3.1
+black>=23.1.0
+isort>=5.12.0
+autoflake>=2.0.1
+pytest-mock>=3.10.0
+requests-mock==1.12.1
+boto3-stubs[s3]
+build>=0.10.0
+twine>=4.0.2
+
+[obj]
+boto3

{linode_cli-5.48.4 → linode_cli-5.49.0}/linodecli/__init__.py

@@ -15,24 +15,20 @@ from rich.table import Table
 from linodecli import plugins
 
 from .arg_helpers import (
-    action_help,
     bake_command,
-    help_with_ops,
     register_args,
     register_plugin,
     remove_plugin,
 )
 from .cli import CLI
-from .completion import bake_completions, get_completions
+from .completion import get_completions
 from .configuration import ENV_TOKEN_NAME
+from .help_pages import print_help_action, print_help_default
 from .helpers import handle_url_overrides
 from .output import OutputMode
+from .version import __version__
 
-# this might not be installed at the time of building
-try:
-    VERSION = version("linode-cli")
-except:
-    VERSION = "building"
+VERSION = __version__
 
 BASE_URL = "https://api.linode.com/v4"
 
@@ -113,7 +109,7 @@ def main():  # pylint: disable=too-many-branches,too-many-statements
         if not parsed.command:
             # print version info and exit - but only if no command was given
             print(f"linode-cli {VERSION}")
-            print(f"Built off spec version {cli.spec_version}")
+            print(f"Built from spec version {cli.spec_version}")
             sys.exit(0)
         else:
             # something else might want to parse version
@@ -155,7 +151,7 @@ def main():  # pylint: disable=too-many-branches,too-many-statements
     # handle a help for the CLI
     if parsed.command is None or (parsed.command is None and parsed.help):
         parser.print_help()
-        help_with_ops(cli.ops, cli.config)
+        print_help_default(cli.ops, cli.config)
         sys.exit(0)
 
     # configure
@@ -209,11 +205,6 @@ def main():  # pylint: disable=too-many-branches,too-many-statements
             cli.config.remove_user(parsed.action)
         sys.exit(0)
 
-    # special command to bake shell completion script
-    if parsed.command == "bake-bash":
-        bake_completions(cli.ops)
-        sys.exit(0)
-
     # check for plugin invocation
     if parsed.command not in cli.ops and parsed.command in plugins.available(
         cli.config
@@ -257,6 +248,6 @@ def main():  # pylint: disable=too-many-branches,too-many-statements
 
     if parsed.command is not None and parsed.action is not None:
         if parsed.help:
-            action_help(cli, parsed.command, parsed.action)
+            print_help_action(cli, parsed.command, parsed.action)
             sys.exit(0)
         cli.handle_command(parsed.command, parsed.action, args)

{linode_cli-5.48.4 → linode_cli-5.49.0}/linodecli/arg_helpers.py

@@ -5,19 +5,17 @@ Argument parser for the linode CLI
 
 import os
 import sys
-import textwrap
 from importlib import import_module
 
 import requests
 import yaml
-from rich import box
-from rich import print as rprint
-from rich.table import Table
 
 from linodecli import plugins
-
-from .completion import bake_completions
-from .helpers import pagination_args_shared, register_args_shared
+from linodecli.helpers import (
+    pagination_args_shared,
+    register_args_shared,
+    register_debug_arg,
+)
 
 
 def register_args(parser):
@@ -141,12 +139,10 @@ def register_args(parser):
         action="store_true",
         help="Prints version information and exits.",
     )
-    parser.add_argument(
-        "--debug", action="store_true", help="Enable verbose HTTP debug output."
-    )
 
     pagination_args_shared(parser)
     register_args_shared(parser)
+    register_debug_arg(parser)
 
     return parser
 
@@ -180,7 +176,7 @@ def register_plugin(module, config, ops):
         msg = "Plugin name conflicts with CLI operation - registration failed."
         return msg, 12
 
-    if plugin_name in plugins.available_local:
+    if plugin_name in plugins.AVAILABLE_LOCAL:
         msg = "Plugin name conflicts with internal CLI plugin - registration failed."
         return msg, 13
 
@@ -222,7 +218,7 @@ def remove_plugin(plugin_name, config):
     """
     Remove a plugin
     """
-    if plugin_name in plugins.available_local:
+    if plugin_name in plugins.AVAILABLE_LOCAL:
         msg = f"{plugin_name} is bundled with the CLI and cannot be removed"
         return msg, 13
 
@@ -247,176 +243,6 @@ def remove_plugin(plugin_name, config):
     return f"Plugin {plugin_name} removed", 0
 
 
-# pylint: disable=too-many-locals
-def help_with_ops(ops, config):
-    """
-    Prints help output with options from the API spec
-    """
-
-    # Environment variables overrides
-    print("\nEnvironment variables:")
-    env_variables = {
-        "LINODE_CLI_TOKEN": "A Linode Personal Access Token for the CLI to make requests with. "
-        "If specified, the configuration step will be skipped.",
-        "LINODE_CLI_CA": "The path to a custom Certificate Authority file to verify "
-        "API requests against.",
-        "LINODE_CLI_API_HOST": "Overrides the target host for API requests. "
-        "(e.g. 'api.linode.com')",
-        "LINODE_CLI_API_VERSION": "Overrides the target Linode API version for API requests. "
-        "(e.g. 'v4beta')",
-        "LINODE_CLI_API_SCHEME": "Overrides the target scheme used for API requests. "
-        "(e.g. 'https')",
-    }
-
-    table = Table(show_header=True, header_style="", box=box.SQUARE)
-    table.add_column("Name")
-    table.add_column("Description")
-
-    for k, v in env_variables.items():
-        table.add_row(k, v)
-
-    rprint(table)
-
-    # commands to manage CLI users (don't call out to API)
-    print("\nCLI user management commands:")
-    um_commands = [["configure", "set-user", "show-users"], ["remove-user"]]
-    table = Table(show_header=False)
-    for cmd in um_commands:
-        table.add_row(*cmd)
-    rprint(table)
-
-    # commands to manage plugins (don't call out to API)
-    print("\nCLI Plugin management commands:")
-    pm_commands = [["register-plugin", "remove-plugin"]]
-    table = Table(show_header=False)
-    for cmd in pm_commands:
-        table.add_row(*cmd)
-    rprint(table)
-
-    # other CLI commands
-    print("\nOther CLI commands:")
-    other_commands = [["completion"]]
-    table = Table(show_header=False)
-    for cmd in other_commands:
-        table.add_row(*cmd)
-    rprint(table)
-
-    # commands generated from the spec (call the API directly)
-    print("\nAvailable commands:")
-
-    content = list(sorted(ops.keys()))
-    proc = []
-    for i in range(0, len(content), 3):
-        proc.append(content[i : i + 3])
-    if content[i + 3 :]:
-        proc.append(content[i + 3 :])
-
-    table = Table(show_header=False)
-    for cmd in proc:
-        table.add_row(*cmd)
-    rprint(table)
-
-    # plugins registered to the CLI (do arbitrary things)
-    if plugins.available(config):
-        # only show this if there are any available plugins
-        print("Available plugins:")
-
-        plugin_content = list(plugins.available(config))
-        plugin_proc = []
-
-        for i in range(0, len(plugin_content), 3):
-            plugin_proc.append(plugin_content[i : i + 3])
-        if plugin_content[i + 3 :]:
-            plugin_proc.append(plugin_content[i + 3 :])
-
-        plugin_table = Table(show_header=False)
-        for plugin in plugin_proc:
-            plugin_table.add_row(*plugin)
-        rprint(plugin_table)
-
-    print("\nTo reconfigure, call `linode-cli configure`")
-    print(
-        "For comprehensive documentation,"
-        "visit https://www.linode.com/docs/api/"
-    )
-
-
-def action_help(cli, command, action):  # pylint: disable=too-many-branches
-    """
-    Prints help relevant to the command and action
-    """
-    try:
-        op = cli.find_operation(command, action)
-    except ValueError:
-        return
-    print(f"linode-cli {command} {action}", end="")
-
-    for param in op.params:
-        pname = param.name.upper()
-        print(f" [{pname}]", end="")
-
-    print()
-    print(op.summary)
-
-    if op.docs_url:
-        rprint(f"API Documentation: [link={op.docs_url}]{op.docs_url}[/link]")
-
-    if len(op.samples) > 0:
-        print()
-        print(f"Example Usage{'s' if len(op.samples) > 1 else ''}: ")
-
-        rprint(
-            *[
-                # Indent all samples for readability; strip and trailing newlines
-                textwrap.indent(v.get("source").rstrip(), "  ")
-                for v in op.samples
-            ],
-            sep="\n\n",
-        )
-
-    print()
-    if op.method == "get" and op.action == "list":
-        filterable_attrs = [
-            attr for attr in op.response_model.attrs if attr.filterable
-        ]
-
-        if filterable_attrs:
-            print("You may filter results with:")
-            for attr in filterable_attrs:
-                print(f"  --{attr.name}")
-            print(
-                "Additionally, you may order results using --order-by and --order."
-            )
-        return
-    if op.args:
-        print("Arguments:")
-        for arg in sorted(op.args, key=lambda s: not s.required):
-            if arg.read_only:
-                continue
-            is_required = (
-                "(required) "
-                if op.method in {"post", "put"} and arg.required
-                else ""
-            )
-
-            extensions = []
-
-            if arg.format == "json":
-                extensions.append("JSON")
-
-            if arg.nullable:
-                extensions.append("nullable")
-
-            if arg.is_parent:
-                extensions.append("conflicts with children")
-
-            suffix = (
-                f" ({', '.join(extensions)})" if len(extensions) > 0 else ""
-            )
-
-            print(f"  --{arg.path}: {is_required}{arg.description}{suffix}")
-
-
 def bake_command(cli, spec_loc):
     """
     Handle a bake command from args
@@ -436,4 +262,3 @@ def bake_command(cli, spec_loc):
         sys.exit(2)
 
     cli.bake(spec)
-    bake_completions(cli.ops)

{linode_cli-5.48.4 → linode_cli-5.49.0}/linodecli/baked/colors.py

@@ -1,11 +1,22 @@
 """
-Applies shell color escapes for pretty printing
+Applies shell color escapes for pretty printing.
 """
 
 import os
 import platform
 
+CLEAR_COLOR = "\x1b[0m"
+COLOR_CODE_MAP = {
+    "red": "\x1b[31m",
+    "green": "\x1b[32m",
+    "yellow": "\x1b[33m",
+    "black": "\x1b[30m",
+    "white": "\x1b[40m",
+}
+
+
 DO_COLORS = True
+
 # !! Windows compatibility for ANSI color codes !!
 #
 # If we're running on windows, we need to run the "color" command to enable
@@ -30,21 +41,20 @@ if platform.system() == "Windows":
         DO_COLORS = False
 
 
-CLEAR_COLOR = "\x1b[0m"
-COLOR_CODE_MAP = {
-    "red": "\x1b[31m",
-    "green": "\x1b[32m",
-    "yellow": "\x1b[33m",
-    "black": "\x1b[30m",
-    "white": "\x1b[40m",
-}
-
-
-def colorize_string(string, color):
+def colorize_string(string: str, color: str) -> str:
     """
     Returns the requested string, wrapped in ANSI color codes to colorize it as
     requested.  On platforms where colors are not supported, this just returns
     the string passed into it.
+
+    :param string: The content to colorize.
+    :type string: str
+    :param color: The color to colorize the string with.
+                  (one of red, green, yellow, black, white)
+    :type color: str
+
+    :returns: The colorized string.
+    :rtype: string
     """
     if not DO_COLORS:
         return string