twc-cli 1.0.0rc0__py3-none-any.whl

twc/commands/ssh_key.py

@@ -0,0 +1,296 @@
+"""SSH-key management commands."""
+
+import os
+import sys
+
+import click
+from click_aliases import ClickAliasedGroup
+
+from twc import fmt
+from . import (
+    create_client,
+    handle_request,
+    options,
+    GLOBAL_OPTIONS,
+    OUTPUT_FORMAT_OPTION,
+)
+
+
+@handle_request
+def _ssh_key_list(client):
+    return client.get_ssh_keys()
+
+
+@handle_request
+def _ssh_key_get(client, *args):
+    return client.get_ssh_key(*args)
+
+
+@handle_request
+def _ssh_key_new(client, **kwargs):
+    return client.add_new_ssh_key(**kwargs)
+
+
+@handle_request
+def _ssh_key_edit(client, *args, **kwargs):
+    return client.update_ssh_key(*args, **kwargs)
+
+
+@handle_request
+def _ssh_key_add(client, *args, **kwargs):
+    return client.add_ssh_key_to_server(*args, **kwargs)
+
+
+@handle_request
+def _ssh_key_remove(client, *args):
+    return client.delete_ssh_key(*args)
+
+
+@handle_request
+def _ssh_key_remove_from_server(client, *args):
+    return client.delete_ssh_key_from_server(*args)
+
+
+# ------------------------------------------------------------- #
+# $ twc ssh-key                                                 #
+# ------------------------------------------------------------- #
+
+
+@click.group("ssh-key", cls=ClickAliasedGroup)
+@options(GLOBAL_OPTIONS[:2])
+def ssh_key():
+    """Manage SSH-keys."""
+
+
+# ------------------------------------------------------------- #
+# $ twc ssh-key list                                            #
+# ------------------------------------------------------------- #
+
+
+def print_ssh_keys(response: object):
+    table = fmt.Table()
+    table.header(["ID", "NAME", "DEFAULT", "SERVERS"])
+    keys = response.json()["ssh_keys"]
+    for key in keys:
+        table.row(
+            [
+                key["id"],
+                key["name"],
+                key["is_default"],
+                ", ".join([str(k["id"]) for k in key["used_by"]]),
+            ]
+        )
+    table.print()
+
+
+@ssh_key.command("list", aliases=["ls"], help="List SSH-keys.")
+@options(GLOBAL_OPTIONS)
+@options(OUTPUT_FORMAT_OPTION)
+def ssh_key_list(config, profile, verbose, output_format):
+    client = create_client(config, profile)
+    response = _ssh_key_list(client)
+    fmt.printer(
+        response,
+        output_format=output_format,
+        func=print_ssh_keys,
+    )
+
+
+# ------------------------------------------------------------- #
+# $ twc ssh-key get                                             #
+# ------------------------------------------------------------- #
+
+
+def print_ssh_key(response: object):
+    table = fmt.Table()
+    table.header(["ID", "NAME", "DEFAULT", "SERVERS"])
+    key = response.json()["ssh_key"]
+    table.row(
+        [
+            key["id"],
+            key["name"],
+            key["is_default"],
+            ", ".join([str(k["id"]) for k in key["used_by"]]),
+        ]
+    )
+    table.print()
+
+
+@ssh_key.command("get", help="Get SSH-key by ID.")
+@options(GLOBAL_OPTIONS)
+@options(OUTPUT_FORMAT_OPTION)
+@click.argument("ssh_key_id", required=True)
+def ssh_key_get(config, profile, verbose, output_format, ssh_key_id):
+    client = create_client(config, profile)
+    response = _ssh_key_get(client, ssh_key_id)
+    fmt.printer(
+        response,
+        output_format=output_format,
+        func=print_ssh_key,
+    )
+
+
+# ------------------------------------------------------------- #
+# $ twc ssh-key new                                             #
+# ------------------------------------------------------------- #
+
+
+@ssh_key.command("new", help="Add new SSH-key.")
+@options(GLOBAL_OPTIONS)
+@options(OUTPUT_FORMAT_OPTION)
+@click.option("--name", help="SSH-key display name.")
+@click.option(
+    "--default",
+    type=bool,
+    default=False,
+    show_default=True,
+    help="If True add this key to all new Cloud Servers.",
+)
+@click.argument("public_key_file", type=click.Path(exists=True), required=True)
+def ssh_key_new(
+    config, profile, verbose, output_format, name, default, public_key_file
+):
+    if not name:
+        name = os.path.basename(public_key_file)
+
+    try:
+        with open(public_key_file, "r", encoding="utf-8") as pubkey:
+            body = pubkey.read().strip()
+    except (OSError, IOError, FileNotFoundError) as error:
+        sys.exit(f"Error: {error}")
+
+    client = create_client(config, profile)
+    response = _ssh_key_new(
+        client,
+        name=name,
+        is_default=default,
+        body=body,
+    )
+
+    fmt.printer(response, output_format=output_format, func=print_ssh_key)
+
+
+# ------------------------------------------------------------- #
+# $ twc ssh-key edit                                            #
+# ------------------------------------------------------------- #
+
+
+@ssh_key.command("edit", help="Edit SSH-key and they properties.")
+@options(GLOBAL_OPTIONS)
+@options(OUTPUT_FORMAT_OPTION)
+@click.option("--name", default=None, help="SSH-key display name.")
+@click.option(
+    "--default",
+    type=bool,
+    default=False,
+    show_default=True,
+    help="If True add this key to all new Cloud Servers.",
+)
+@click.option(
+    "--file",
+    "public_key_file",
+    type=click.Path(),
+    default=None,
+    help="Public key file.",
+)
+@click.argument("ssh_key_id", required=True)
+def ssh_key_edit(
+    config,
+    profile,
+    verbose,
+    output_format,
+    name,
+    default,
+    public_key_file,
+    ssh_key_id,
+):
+    client = create_client(config, profile)
+    payload = {}
+
+    if name:
+        payload.update({"name": name})
+
+    if default:
+        payload.update({"is_default": default})
+
+    if public_key_file:
+        try:
+            with open(public_key_file, "r", encoding="utf-8") as pubkey:
+                body = pubkey.read().strip()
+                payload.update({"body": body})
+        except (OSError, IOError, FileNotFoundError) as error:
+            sys.exit(f"Error: {error}")
+
+    if not payload:
+        raise click.UsageError(
+            "Nothing to do. Set one of ['--name', '--file', '--default']"
+        )
+
+    response = _ssh_key_edit(client, ssh_key_id, data=payload)
+
+    fmt.printer(response, output_format=output_format, func=print_ssh_key)
+
+
+# ------------------------------------------------------------- #
+# $ twc ssh-key add                                             #
+# ------------------------------------------------------------- #
+
+
+@ssh_key.command(
+    "add", aliases=["copy"], help="Copy SSH-keys to Cloud Server."
+)
+@options(GLOBAL_OPTIONS)
+@click.option(
+    "--to-server",
+    "server_id",
+    type=int,
+    help="Cloud Server ID.",
+)
+@click.argument("ssh_key_ids", nargs=-1, required=True)
+def ssh_key_add(config, profile, verbose, server_id, ssh_key_ids):
+    client = create_client(config, profile)
+    response = _ssh_key_add(client, server_id, ssh_key_ids=list(ssh_key_ids))
+    if response.status_code == 204:
+        print(server_id)
+    else:
+        fmt.printer(response)
+
+
+# ------------------------------------------------------------- #
+# $ twc ssh-key remove                                          #
+# ------------------------------------------------------------- #
+
+
+@ssh_key.command("remove", aliases=["rm"], help="Remove SSH-keys.")
+@options(GLOBAL_OPTIONS)
+@click.option(
+    "--from-server",
+    "server_id",
+    type=int,
+    help="Remove SSH-key from Cloud Server instead of remove key itself.",
+)
+@click.confirmation_option(
+    prompt="If you do not specify '--from-server' option "
+    "SSH-key will be deleted\nfrom all servers where it was added "
+    "and also deleted itself.\nContinue?"
+)
+@click.argument("ssh_key_ids", nargs=-1, required=True)
+def ssh_key_remove(config, profile, verbose, server_id, ssh_key_ids):
+    client = create_client(config, profile)
+    if server_id:
+        if len(ssh_key_ids) >= 2:
+            raise click.UsageError("Cannot remove multiple keys from server.")
+        response = _ssh_key_remove_from_server(
+            client, server_id, list(ssh_key_ids)[0]
+        )
+        if response.status_code == 204:
+            print(list(ssh_key_ids)[0])
+        else:
+            fmt.printer(response)
+    else:
+        for key_id in ssh_key_ids:
+            response = _ssh_key_remove(client, key_id)
+            if response.status_code == 204:
+                print(key_id)
+            else:
+                fmt.printer(response)

twc/fmt.py

@@ -0,0 +1,188 @@
+"""Format console output."""
+
+import re
+import sys
+import json
+
+import click
+import yaml
+
+
+class Table:
+    """Print table. Example::
+
+    >>> t = Table()
+    >>> t.header(['KEY', 'VALUE'])  # header is optional
+    >>> t.row(['key 1', 'value 1'])
+    >>> t.row(['key 2', 'value 2'])
+    >>> t.rows(
+    ...     [
+    ...         ['key 3', 'value 3'],
+    ...         ['key 4', 'value 4']
+    ...     ]
+    >>> )
+    >>> t.print()
+
+    """
+
+    def __init__(self, whitespace: str = "\t"):
+        self.__rows = []
+        self.__whitespace = whitespace
+
+    def header(self, columns: list):
+        """Add `columns` list as first element in `rows` list."""
+        self.__rows.insert(0, [str(col) for col in columns])
+
+    def row(self, row: list):
+        """Add new row to table."""
+        self.__rows.append([str(col) for col in row])
+
+    def rows(self, rows: list):
+        """Add multiple rows to table."""
+        for row in rows:
+            self.row(row)
+
+    def print(self):
+        """Print table content to terminal."""
+        widths = [max(map(len, col)) for col in zip(*self.__rows)]
+        for row in self.__rows:
+            click.echo(
+                self.__whitespace.join(
+                    (val.ljust(width) for val, width in zip(row, widths))
+                )
+            )
+
+
+class Printer:
+    """Display data in different formats."""
+
+    def __init__(self, data: object):
+        self._data = data
+
+    def raw(self):
+        """Print raw API response text (mostly raw JSON)."""
+        click.echo(self._data.text)
+
+    def colorize(self, data: str, lang: str = "json"):
+        """Print colorized output. Fallback to non-color."""
+        try:
+            from pygments import highlight
+            from pygments.lexers import JsonLexer, YamlLexer
+            from pygments.formatters import TerminalFormatter
+
+            if lang == "json":
+                lexer = JsonLexer()
+            elif lang == "yaml":
+                lexer = YamlLexer()
+
+            click.echo(highlight(data, lexer, TerminalFormatter()).strip())
+        except ImportError:
+            click.echo(data)
+
+    def pretty_json(self):
+        """Print colorized JSON output. Fallback to non-color output if
+        Pygments not installed and fallback to raw output on JSONDecodeError.
+        """
+        try:
+            json_data = json.dumps(
+                self._data.json(), indent=4, sort_keys=True, ensure_ascii=False
+            )
+            self.colorize(json_data, lang="json")
+        except json.JSONDecodeError:
+            self.raw()
+
+    def pretty_yaml(self):
+        """Print colorized YAML output. Fallback to non-color output if
+        Pygments not installed and fallback to raw output on YAMLError.
+        """
+        try:
+            yaml_data = yaml.dump(
+                self._data.json(), sort_keys=True, allow_unicode=True
+            )
+            self.colorize(yaml_data, lang="yaml")
+        except yaml.YAMLError:
+            self.raw()
+
+    def print(self, output_format: str = "raw", func=None, **kwargs):
+        """Print `requests.Response` object.
+        - If `output_format` is 'raw' print raw HTTP body text.
+        - If `output_format` is 'json' print colorized JSON.
+        - If `output_format` is 'yaml' print colorized YAML.
+        - If function `func` is passed use it to print response data.
+        """
+        if output_format == "raw":
+            self.raw()
+        elif output_format == "json":
+            self.pretty_json()
+        elif output_format == "yaml":
+            self.pretty_yaml()
+        else:
+            try:
+                if func:
+                    func(self._data, **kwargs)
+            except KeyError:  # fallback to 'json' or 'raw' on error
+                click.echo(
+                    "Error: Cannot represent output. Fallback to JSON.",
+                    err=True,
+                )
+                self.pretty_json()
+
+
+def printer(response: object, output_format: str = "raw", func=None, **kwargs):
+    """Print `requests.Response` object.
+    This is the same as `Printer(*args, **kwargs).print()`.
+    """
+    to_print = Printer(response)
+    if func:
+        to_print.print(output_format, func=func, **kwargs)
+    else:
+        to_print.print(output_format, **kwargs)
+
+
+def query_dict(data: dict, keys: list):
+    """Return value of dict by list of keys. For example::
+
+    >>> mydict = {'server':{'os':{'name':'ubuntu','version':'22.04',}}}
+    >>> query = 'server.os.name'
+    >>> result = query_dict(mydict, query.split('.'))
+
+    In result: 'ubuntu'
+    """
+    exp = ""
+    for key in keys:
+        if re.match(r"^[a-zA-Z0-9]+$", key):
+            exp = exp + f"['{key}']"
+    try:
+        # pylint: disable=eval-used
+        return eval(f"{data}{exp}", {"__builtins__": {}}, {})
+    except TypeError:
+        return None
+
+
+def filter_list(objects: list, filters: str) -> list:
+    """Filter list of objects. Return filtered list.
+
+    `filters` is a string with following format::
+
+        ``<key>:<value>,<key>:<value>``
+
+    Key-Value pairs count is unlimited. Available filter keys and
+    values depends on passed object.
+    """
+    if not re.match(r"^(([a-zA-Z0-9._-]+:[a-zA-Z0-9._-]+),?)+$", filters):
+        sys.exit("Error: Invalid filter format")
+
+    for key_val in filters.split(","):
+        try:
+            key, val = key_val.split(":")
+            objects = list(
+                filter(
+                    # pylint: disable=cell-var-from-loop
+                    # This is fine
+                    lambda x: str(query_dict(x, key.split("."))) == val,
+                    objects,
+                )
+            )
+        except (KeyError, ValueError):
+            return []
+    return objects

twc_cli-1.0.0rc0.dist-info/COPYING

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright © 2023 TWC Developers
+
+
+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.

twc_cli-1.0.0rc0.dist-info/METADATA

@@ -0,0 +1,80 @@
+Metadata-Version: 2.1
+Name: twc-cli
+Version: 1.0.0rc0
+Summary: Timeweb Cloud Command Line Interface.
+Home-page: https://github.com/timeweb-cloud/twc
+License: MIT
+Author: ge
+Author-email: dev@timeweb.cloud
+Requires-Python: >=3.7,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Dist: click (>=8.1.3,<9.0.0)
+Requires-Dist: click-aliases (>=1.0.1,<2.0.0)
+Requires-Dist: pygments (>=2.14.0,<3.0.0)
+Requires-Dist: pyyaml (>=6.0,<7.0)
+Requires-Dist: requests (>=2.28.1,<3.0.0)
+Requires-Dist: toml (>=0.10.2,<0.11.0)
+Project-URL: Repository, https://github.com/timeweb-cloud/twc
+Description-Content-Type: text/markdown
+
+![TWC CLI](https://github.com/timeweb-cloud/twc/blob/master/artwork/logo.svg)
+
+Timeweb Cloud Command Line Interface and simple SDK 💫
+
+> [Документация на русском](https://github.com/timeweb-cloud/twc/blob/master/docs/ru/README.md) 🇷🇺
+
+# Installation
+
+```
+pip install twc-cli
+```
+
+# Getting started
+
+Get Timeweb Cloud [access token](https://timeweb.cloud/my/api-keys) and
+configure **twc** with command:
+
+```
+twc config
+```
+
+Enter your access token and hit `Enter`.
+
+Configuration done! Let's use:
+
+```
+twc --help
+```
+
+# Shell completion
+
+## Bash
+
+Add this to **~/.bashrc**:
+
+```
+eval "$(_TWC_COMPLETE=bash_source twc)"
+```
+
+## Zsh
+
+Add this to **~/.zshrc**:
+
+```
+eval "$(_TWC_COMPLETE=zsh_source twc)"
+```
+
+## Fish
+
+Add this to **~/.config/fish/completions/tw.fish**:
+
+```
+eval (env _TWC_COMPLETE=fish_source twc)
+```
+

twc_cli-1.0.0rc0.dist-info/RECORD

@@ -0,0 +1,19 @@
+CHANGELOG.md,sha256=DqT4vfLwfbjWLzfhXd2ijzshUHX_xT8BZcGU9eub37o,39
+COPYING,sha256=fpJLxZS_kHr_659xkpmqEtqHeZp6lQR9CmKCwnYbsmE,1089
+twc/__init__.py,sha256=NwPAMNw3NuHdWGQvWS9_lromVF6VM194oVOipojfJns,113
+twc/__main__.py,sha256=ZqBKuNFBa-Q-hsRk7jhZPT5H2Lg7l99Hk_phl53S6U0,459
+twc/__version__.py,sha256=PSBZ7n33LNwjZEyFsYWX2QQn2SbLMNXgZLUZg9iAjuQ,420
+twc/api/__init__.py,sha256=1OFp1sNrikcJH_JjkhGjnnKpyfg-SCOH_RBkgG-Mqw8,59
+twc/api/client.py,sha256=yfQJJoDyM86IZe281HTnVPa85u7wEvkDjAIpmlgn0NE,21064
+twc/api/exceptions.py,sha256=-IKU8HEaFvmvvHd3NaiF6ticnONrGz7L9TYSTF9d5Lg,851
+twc/commands/__init__.py,sha256=6vih8qQcZXh5FX4Wv-mplTw6ooz_kMBkGNmaczFKAsg,8319
+twc/commands/account.py,sha256=FsqjIiPjCCQ6yvrea3ElzsgbZ1B8nTzNOpTuzlPFcME,5368
+twc/commands/config.py,sha256=93awq8dnjs7hB6Ffo8PAj03yMR1M_SI23TFPlNry8A8,1471
+twc/commands/server.py,sha256=G5w4JOPQT_mR2ez1MhXXWahQtSLEVycSueu4VJkbbAU,65333
+twc/commands/ssh_key.py,sha256=6ucRbeOegiLENuqHTdqb7X0bK4__n-_i1Iog6VS0IOk,8218
+twc/fmt.py,sha256=Hso-xiWXPhz6aFLL5BVLrgtr3Wr7DBESqetJqYA9g90,5716
+twc_cli-1.0.0rc0.dist-info/COPYING,sha256=fpJLxZS_kHr_659xkpmqEtqHeZp6lQR9CmKCwnYbsmE,1089
+twc_cli-1.0.0rc0.dist-info/METADATA,sha256=Wc1z9T0TyQGJzsAXgGoFee8MAxuXraRTBzRVxGRzei0,1777
+twc_cli-1.0.0rc0.dist-info/WHEEL,sha256=vVCvjcmxuUltf8cYhJ0sJMRDLr1XsPuxEId8YDzbyCY,88
+twc_cli-1.0.0rc0.dist-info/entry_points.txt,sha256=tmTaVRhm8BkNrXC_9XJMum7O9wFVOvkXcBetxmahWvE,40
+twc_cli-1.0.0rc0.dist-info/RECORD,,

twc_cli-1.0.0rc0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 1.4.0
+Root-Is-Purelib: true
+Tag: py3-none-any

twc_cli-1.0.0rc0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+twc=twc.__main__:cli
+