twc-cli 1.2.0__tar.gz → 1.3.0__tar.gz

{twc_cli-1.2.0 → twc_cli-1.3.0}/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 В этом файле описаны все значимые изменения в Timeweb Cloud CLI. В выпусках мы придерживается правил [семантического версионирования](https://semver.org/lang/ru/).
 
+# Версия 1.3.0 (2023.04.13)
+
+Добавлено:
+
+- Добавлена команда `twc storage` (алиас `twc s3`) для управления бакетами в объектном хранилище Timeweb Cloud. Доступны базовые операции с бакетами. Также реализованы субкоманды для работы с доменами и пользователями хранилища. Обратите внимание, что в twc не планируется добавлять реализацию S3-клиента, пользуйтесь любым совместимым клиентом, например, [s3cmd](https://s3tools.org/s3cmd) или [rclone](https://rclone.org/), команда `twc s3 genconfig` позволит сгенерировать конфигурационный файл для этих утилит (см. документацию).
+- Добавлены субкоманды для `twc config`. Теперь можно: сделать дамп настроек CLI (`twc config dump`), изменять настройки без ручного редактирования файла (`twc config set`), получить путь до файла (`twc config file`), открыть файл в редакторе по умолчанию (`twc config edit`).
+
+Изменено:
+
+- Изменены тексты ошибок при работе с конфигурационным файлом, теперь они более наглядные и явно указывают на проблему.
+- Изменено поведение команды `twc config`. Теперь если уже иммется конфигурационный файл команда предложит добавить новый профиль или отредактировать существующий.
+
 # Версия 1.2.0 (2023.04.03)
 
 Добавлено:

{twc_cli-1.2.0 → twc_cli-1.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: twc-cli
-Version: 1.2.0
+Version: 1.3.0
 Summary: Timeweb Cloud Command Line Interface.
 Home-page: https://github.com/timeweb-cloud/twc
 License: MIT
@@ -15,6 +15,7 @@ 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: click-default-group (>=1.2.2,<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)

{twc_cli-1.2.0 → twc_cli-1.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "twc-cli"
-version = "1.2.0"
+version = "1.3.0"
 description = "Timeweb Cloud Command Line Interface."
 authors = ["ge <dev@timeweb.cloud>"]
 homepage = "https://github.com/timeweb-cloud/twc"
@@ -20,6 +20,7 @@ click = "^8.1.3"
 click-aliases = "^1.0.1"
 toml = "^0.10.2"
 pyyaml = "^6.0"
+click-default-group = "^1.2.2"
 
 [tool.poetry.group.dev.dependencies]
 black = "^22.12.0"

{twc_cli-1.2.0 → twc_cli-1.3.0}/twc/__main__.py

@@ -12,6 +12,7 @@ from .commands.ssh_key import ssh_key
 from .commands.image import image
 from .commands.project import project
 from .commands.database import database
+from .commands.storage import storage
 
 
 class AliasedCmdGroup(click.Group):
@@ -44,7 +45,7 @@ class AliasedCmdGroup(click.Group):
                 continue
             commands.append((subcommand, cmd))
 
-        if len(commands):
+        if commands:
             limit = formatter.width - 6 - max(len(cmd[0]) for cmd in commands)
             rows = []
             for subcommand, cmd in commands:
@@ -53,8 +54,8 @@ class AliasedCmdGroup(click.Group):
                 for a in list(ALIASES.keys()):
                     if ALIASES[a].name == cmd.name:
                         alias = f" ({a})"
-                help = cmd.get_short_help_str(limit)
-                rows.append((subcommand + alias, help))
+                help_text = cmd.get_short_help_str(limit)
+                rows.append((subcommand + alias, help_text))
             if rows:
                 with formatter.section(_("Commands")):
                     formatter.write_dl(rows)
@@ -73,6 +74,7 @@ cli.add_command(ssh_key)
 cli.add_command(image)
 cli.add_command(project)
 cli.add_command(database)
+cli.add_command(storage)
 
 
 # -- Aliases list for root level commands. --
@@ -89,4 +91,6 @@ ALIASES = {
     "p": project,
     "dbs": database,
     "db": database,
+    "storages": storage,
+    "s3": storage,
 }

{twc_cli-1.2.0 → twc_cli-1.3.0}/twc/__version__.py

@@ -9,5 +9,5 @@
 import sys
 
 
-__version__ = "1.2.0"
+__version__ = "1.3.0"
 __pyversion__ = sys.version.replace("\n", "")

{twc_cli-1.2.0 → twc_cli-1.3.0}/twc/api/client.py

@@ -32,14 +32,15 @@ def raise_exceptions(func):
         except AttributeError:
             is_json = False
 
-        if status_code in [200, 201, 400, 403, 404, 409, 429, 500]:
+        # Remove 201 to avoid API bug (201 with no body)
+        if status_code in [200, 400, 403, 404, 409, 429, 500]:
             if is_json:
                 return response  # Success
             raise NonJSONResponseError(
                 f"Code: {status_code}, Response body: {response.text}"
             )
 
-        if status_code == 204:
+        if status_code in [201, 204]:
             return response  # Success
 
         if status_code == 401:
@@ -985,3 +986,184 @@ class TimewebCloud(metaclass=TimewebCloudMeta):
         """Restore database backup."""
         url = f"{self.api_url}/dbs/{db_id}/backups/{backup_id}"
         return requests.put(url, headers=self.headers, timeout=self.timeout)
+
+    # -----------------------------------------------------------------------
+    # Object Storage
+
+    def get_storage_presets(self):
+        """Get storage presets list."""
+        url = f"{self.api_url}/presets/storages"
+        return requests.get(url, headers=self.headers, timeout=self.timeout)
+
+    def get_buckets(self):
+        """Get buckets list."""
+        url = f"{self.api_url}/storages/buckets"
+        return requests.get(url, headers=self.headers, timeout=self.timeout)
+
+    def create_bucket(
+        self, name: str = None, preset_id: int = None, is_public: bool = False
+    ):
+        """Create storage bucket."""
+        url = f"{self.api_url}/storages/buckets"
+        self.headers.update({"Content-Type": "application/json"})
+        if is_public:
+            bucket_type = "public"
+        else:
+            bucket_type = "private"
+        payload = {
+            "name": name,
+            "type": bucket_type,
+            "preset_id": preset_id,
+        }
+        return requests.post(
+            url,
+            headers=self.headers,
+            timeout=self.timeout,
+            data=json.dumps(payload),
+        )
+
+    def delete_bucket(
+        self, bucket_id: int, delete_hash: str = None, code: int = None
+    ):
+        """Delete storage bucket."""
+        url = f"{self.api_url}/storages/buckets/{bucket_id}"
+        params = {}
+        if delete_hash:
+            params["hash"] = delete_hash
+        if code:
+            params["code"] = code
+        return requests.delete(
+            url, headers=self.headers, timeout=self.timeout, params=params
+        )
+
+    def update_bucket(
+        self, bucket_id: int, preset_id: int = None, is_public: bool = None
+    ):
+        """Update storage bucket."""
+        url = f"{self.api_url}/storages/buckets/{bucket_id}"
+        self.headers.update({"Content-Type": "application/json"})
+        payload = {}
+        if is_public is None:
+            pass
+        elif is_public is False:
+            payload["bucket_type"] = "private"
+        elif is_public is True:
+            payload["bucket_type"] = "public"
+        if preset_id:
+            payload["preset_id"] = preset_id
+        return requests.patch(
+            url,
+            headers=self.headers,
+            timeout=self.timeout,
+            data=json.dumps(payload),
+        )
+
+    def get_storage_users(self):
+        """Get storage users list."""
+        url = f"{self.api_url}/storages/users"
+        return requests.get(url, headers=self.headers, timeout=self.timeout)
+
+    def update_storage_user_secret(
+        self, user_id: int = None, secret_key: str = None
+    ):
+        """Update storage user secret key."""
+        url = f"{self.api_url}/storages/users/{user_id}"
+        self.headers.update({"Content-Type": "application/json"})
+        payload = {"secret_key": secret_key}
+        return requests.patch(
+            url,
+            headers=self.headers,
+            timeout=self.timeout,
+            data=json.dumps(payload),
+        )
+
+    def get_storage_transfer_status(self, bucket_id: int = None):
+        """Get storage transfer status."""
+        url = f"{self.api_url}/storages/buckets/{bucket_id}/transfer-status"
+        return requests.get(url, headers=self.headers, timeout=self.timeout)
+
+    def start_storage_transfer(
+        self,
+        src_bucket: str = None,
+        dst_bucket: str = None,
+        access_key: str = None,
+        secret_key: str = None,
+        location: str = None,
+        endpoint: str = None,
+        force_path_style: bool = False,
+    ):
+        """Start file transfer from any S3-compatible storage to Timeweb Cloud
+        Object Storage.
+        """
+        url = f"{self.api_url}/storages/transfer"
+        self.headers.update({"Content-Type": "application/json"})
+        payload = {
+            "access_key": access_key,
+            "secret_key": secret_key,
+            "location": location,
+            "is_force_path_style": force_path_style,
+            "endpoint": endpoint,
+            "bucket_name": src_bucket,
+            "new_bucket_name": dst_bucket,
+        }
+        return requests.post(
+            url,
+            headers=self.headers,
+            timeout=self.timeout,
+            data=json.dumps(payload),
+        )
+
+    def get_bucket_subdomains(self, bucket_id: int = None):
+        """Get bucket subdomains list."""
+        url = f"{self.api_url}/storages/buckets/{bucket_id}/subdomains"
+        return requests.get(url, headers=self.headers, timeout=self.timeout)
+
+    def add_bucket_subdomains(
+        self,
+        bucket_id: int = None,
+        subdomains: list = None,
+    ):
+        """Add subdomains to bucket."""
+        url = f"{self.api_url}/storages/buckets/{bucket_id}/subdomains"
+        self.headers.update({"Content-Type": "application/json"})
+        payload = {
+            "subdomains": subdomains,
+        }
+        return requests.post(
+            url,
+            headers=self.headers,
+            timeout=self.timeout,
+            data=json.dumps(payload),
+        )
+
+    def delete_bucket_subdomains(
+        self,
+        bucket_id: int = None,
+        subdomains: list = None,
+    ):
+        """Delete bucket subdomains."""
+        url = f"{self.api_url}/storages/buckets/{bucket_id}/subdomains"
+        self.headers.update({"Content-Type": "application/json"})
+        payload = {
+            "subdomains": subdomains,
+        }
+        return requests.delete(
+            url,
+            headers=self.headers,
+            timeout=self.timeout,
+            data=json.dumps(payload),
+        )
+
+    def gen_cert_for_bucket_subdomain(self, subdomain: str = None):
+        """Generate TLS certificate for subdomain attached to bucket."""
+        url = f"{self.api_url}/storages/certificates/generate"
+        self.headers.update({"Content-Type": "application/json"})
+        payload = {
+            "subdomain": subdomain,
+        }
+        return requests.post(
+            url,
+            headers=self.headers,
+            timeout=self.timeout,
+            data=json.dumps(payload),
+        )

{twc_cli-1.2.0 → twc_cli-1.3.0}/twc/commands/__init__.py

@@ -37,10 +37,14 @@ def load_config(filepath: str = get_default_config_file()):
     try:
         with open(filepath, "r", encoding="utf-8") as file:
             return toml.load(file)
-    except (OSError, FileNotFoundError) as error:
-        sys.exit(f"Error: {filepath}: {error}: Try run 'twc config'")
+    except FileNotFoundError:
+        sys.exit(
+            f"Configuration file {filepath} not found. Try run 'twc config'"
+        )
+    except OSError as error:
+        sys.exit(f"Error: Cannot read configuration file {filepath}: {error}")
     except toml.TomlDecodeError as error:
-        sys.exit(f"Error: {filepath}: {error}")
+        sys.exit(f"Error: Check your TOML syntax in file {filepath}: {error}")
 
 
 def set_value_from_config(ctx, param, value):

twc_cli-1.3.0/twc/commands/config.py

@@ -0,0 +1,165 @@
+"""CLI configuration."""
+
+import os
+import sys
+import ctypes
+import json
+
+import yaml
+import toml
+import click
+from click_default_group import DefaultGroup
+
+from twc import fmt
+from twc import utils
+from twc.vars import DEFAULT_CONFIG
+from . import (
+    options,
+    load_config,
+    get_default_config_file,
+    GLOBAL_OPTIONS,
+)
+
+
+def write_to_file(data: str, filepath: str):
+    try:
+        with open(filepath, "w", encoding="utf-8") as file:
+            toml.dump(data, file)
+        if os.name == "nt":
+            hidden_file_attr = 0x02
+            ctypes.windll.kernel32.SetFileAttributesW(
+                filepath, hidden_file_attr
+            )
+        click.echo(f"Done! Configuration is saved in {filepath}")
+        sys.exit(0)
+    except OSError as error:
+        sys.exit(f"Error: {error}")
+
+
+def make_config(filepath: str = get_default_config_file()):
+    """Create new configuration file."""
+    if os.path.exists(filepath):
+        if click.confirm(
+            "You already have TWC CLI configured, continue?",
+            default=False,
+        ):
+            current_config = load_config()
+            profile = click.prompt("Enter profile name", default="default")
+            token = click.prompt(f"Enter API token for '{profile}'")
+            current_config[profile] = utils.merge_dicts(
+                current_config[profile],
+                {"token": token},
+            )
+            write_to_file(current_config, filepath)
+        else:
+            sys.exit("Aborted!")
+
+    click.echo("Create new configuration file. Enter your API token.")
+    while True:
+        token = input("Token: ")
+        if token:
+            DEFAULT_CONFIG.update({"default": {"token": token}})
+            break
+        click.echo("Please enter token. Press ^C to cancel.")
+    write_to_file(DEFAULT_CONFIG, filepath)
+
+
+# ------------------------------------------------------------- #
+# $ twc config                                                  #
+# ------------------------------------------------------------- #
+
+
+@click.group(
+    "config", cls=DefaultGroup, default="init", default_if_no_args=True
+)
+@options(GLOBAL_OPTIONS[:2])
+def config():
+    """Manage CLI configuration."""
+
+
+# ------------------------------------------------------------- #
+# $ twc config init                                             #
+# ------------------------------------------------------------- #
+
+
+@config.command("init", help="Create confiration file and profile.")
+@options(GLOBAL_OPTIONS[:2])
+def config_init():
+    make_config()
+
+
+# ------------------------------------------------------------- #
+# $ twc config file                                             #
+# ------------------------------------------------------------- #
+
+
+@config.command("file", help="Display path to configuration file.")
+@options(GLOBAL_OPTIONS[:4])
+def config_file(config, verbose):
+    click.echo(click.format_filename(config.encode()))
+
+
+# ------------------------------------------------------------- #
+# $ twc config dump                                             #
+# ------------------------------------------------------------- #
+
+
+@config.command("dump", help="Dump configuration.")
+@options(GLOBAL_OPTIONS)
+@click.option(
+    "--full", "full_dump", is_flag=True, help="Dump full configuration."
+)
+@click.option(
+    "--output",
+    "-o",
+    "output_format",
+    type=click.Choice(["toml", "yaml", "json"]),
+    default="toml",
+    show_default=True,
+    help="Output format.",
+)
+def config_dump(config, profile, verbose, full_dump, output_format):
+    if full_dump:
+        config_dict = load_config(config)
+    else:
+        config_dict = load_config(config)[profile]
+
+    if output_format == "toml":
+        fmt.print_colored(toml.dumps(config_dict), lang="toml")
+    elif output_format == "yaml":
+        fmt.print_colored(yaml.dump(config_dict), lang="yaml")
+    elif output_format == "json":
+        fmt.print_colored(json.dumps(config_dict), lang="json")
+
+
+# ------------------------------------------------------------- #
+# $ twc config set                                              #
+# ------------------------------------------------------------- #
+
+
+@config.command("set", help="Set config parameter.")
+@options(GLOBAL_OPTIONS)
+@click.argument("params", nargs=-1, metavar="PARAM=VALUE")
+def config_set(config, profile, verbose, params):
+    if not params:
+        raise click.UsageError("Nothing to do.")
+    config_dict = load_config(config)
+    params_dict = {}
+    for param in params:
+        key, value = param.split("=")
+        if value.isdigit():
+            value = int(value)
+        params_dict[key] = value
+    config_dict[profile] = utils.merge_dicts(config_dict[profile], params_dict)
+    write_to_file(config_dict, config)
+
+
+# ------------------------------------------------------------- #
+# $ twc config edit                                             #
+# ------------------------------------------------------------- #
+
+
+@config.command("edit", help="Open config file in default editor.")
+@options(GLOBAL_OPTIONS[:4])
+def config_edit(config, verbose):
+    click.launch(config)