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

twc_cli-1.3.0/CHANGELOG.md

@@ -0,0 +1,62 @@
+# Релизы Timeweb Cloud CLI
+
+В этом файле описаны все значимые изменения в 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 database` (алиас `twc db`). Теперь можно:
+    - создавать и удалять управляемые базы данных;
+    - изменять параметры базы данных;
+    - работать с бэкапами баз данных.
+- Реализована возможность работы с токенами, которые требуют подтверждения удаления сервисов через проверочные коды.
+- Добавлены алиасы для основных команд, набирать команды стало ещё быстрее. Например, `twc server list` можно сократить до `twc s ls`. Смотрите список алиасов во встроенной справке `--help`.
+- Добавлены команды `twc server dash` и `twc server vnc`. С их помощью можно быстро перейти в дашборд и веб-консоль сервера соответсвенно. Ссылки откроются в браузере по умолчанию.
+
+Изменено:
+
+- Поменялся вывод команд `twc server list-presets` и `twc server backup list`, скрыты малоинформативные колонки.
+- Мелкие улучшения в коде.
+
+
+# Версия 1.1.0 (2023.03.24)
+
+Добавлено:
+
+- Добавлена команда `twc image` для управления образами дисков. Можно создавать образы из существующих дисков, загрузить свой образ по ссылке, удалять образы и выполнять другие базовые операции.
+- Добавлена возможность использовать UUID пользовательского образа при создании нового сервера (`twc server create`) и при переустановке сервера (`twc server reinstall`).
+- Добавлена команда `twc project` для управления проектами и ресурсами в них: создание, удаление, редактирование проектов, перемещение ресурсов между проектами.
+- В команду `twc server create` добавлена опция `--project-id`, которая позволяет переместить только что созданный сервер в указанный проект. Задать проект можно также через переменную окружения `TWC_PROJECT` и конфигурационный файл.
+- В команду `twc server reinstall` добавлена опция `--add-ssh-key`. Теперь опционально после переустановки на сервер будут добавлены SSH-ключи, которые были на нём ранее.
+- Добавлена команда `twc server disk list-all`. Она покажет список всех дисков со всех серверов.
+- Опция `--filter` в командах где она есть теперь поддерживает поиск по полям, содержащим значения в мегабайтах и гагибайтах.
+
+Изменено:
+
+- Команда `twc server reinstall` теперь не требует `--image` как обязательный аргумент. Если опция не задана будет выбрана ОС, которая уже установлена на сервере.
+- В команде `twc server clone` теперь используется новый метод клонирования сервера. В ответ команда вернёт информацию о клоне сервера.
+- В командах `twc server list` и `twc server logs` увеличен стандартный `--limit` до 500.
+- В локации `pl-1` (Польша, Гданьск) теперь разрешено добавлять IPv6-адреса.
+- В выводе `twc server list-presets` RAM и объём системного диска в табличном виде теперь отображаются в гигабайтах.
+
+Исправлено:
+
+- В выводе команды `twc server list-os-images` теперь правильно отображаем поле `REQUIREMENTS`.
+- Исправлена ошибка из-за которой опция `--filter` не фильтровала по ключам, содержащим знак подчёркивания.
+
+# Версия 1.0.0 (2023.02.27)
+
+Первый релиз.

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: twc-cli
-Version: 1.1.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.1.0 → twc_cli-1.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "twc-cli"
-version = "1.1.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.3.0/twc/__main__.py

@@ -0,0 +1,96 @@
+"""Command Line Interface initial module."""
+
+from gettext import gettext as _
+
+import click
+
+from .commands import options, GLOBAL_OPTIONS
+from .commands.account import account
+from .commands.config import config
+from .commands.server import server
+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):
+    """Add aliases for Click commands. Needs a global variable
+    ALIASES with dict. Exmaple:
+
+    @click.group(cls=AliasedCmdGroup)
+    def cli():
+        '''CLI.'''
+
+    cli.add_command(my_cmd)
+    ALIASES = {"my-cmd-alias": my_cmd}
+    """
+
+    def get_command(self, ctx, cmd_name):
+        """Add aliased commands to parser."""
+        try:
+            cmd_name = ALIASES[cmd_name].name
+        except KeyError:
+            pass
+        return super().get_command(ctx, cmd_name)
+
+    def format_commands(self, ctx, formatter) -> None:
+        commands = []
+        for subcommand in self.list_commands(ctx):
+            cmd = self.get_command(ctx, subcommand)
+            if cmd is None:
+                continue
+            if cmd.hidden:
+                continue
+            commands.append((subcommand, cmd))
+
+        if commands:
+            limit = formatter.width - 6 - max(len(cmd[0]) for cmd in commands)
+            rows = []
+            for subcommand, cmd in commands:
+                # Get command alias
+                alias = ""
+                for a in list(ALIASES.keys()):
+                    if ALIASES[a].name == cmd.name:
+                        alias = f" ({a})"
+                help_text = cmd.get_short_help_str(limit)
+                rows.append((subcommand + alias, help_text))
+            if rows:
+                with formatter.section(_("Commands")):
+                    formatter.write_dl(rows)
+
+
+@click.group(cls=AliasedCmdGroup)
+@options(GLOBAL_OPTIONS[:2])
+def cli():
+    """Timeweb Cloud Command Line Interface."""
+
+
+cli.add_command(account)
+cli.add_command(config)
+cli.add_command(server)
+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. --
+# If there are several aliases, only the last one will
+# be printed in the help text.
+ALIASES = {
+    "servers": server,
+    "s": server,
+    "keys": ssh_key,
+    "k": ssh_key,
+    "images": image,
+    "i": image,
+    "projects": project,
+    "p": project,
+    "dbs": database,
+    "db": database,
+    "storages": storage,
+    "s3": storage,
+}

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

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

{twc_cli-1.1.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:
@@ -850,3 +851,319 @@ class TimewebCloud(metaclass=TimewebCloudMeta):
         """List dedicated servers in project by project_id."""
         url = f"{self.api_url}/projects/{project_id}/resources/databases"
         return requests.get(url, headers=self.headers, timeout=self.timeout)
+
+    # -----------------------------------------------------------------------
+    # Databases
+
+    def get_databases(self, limit: int = 100, offset: int = 0):
+        """Get databases list."""
+        url = f"{self.api_url}/dbs"
+        return requests.get(
+            url,
+            headers=self.headers,
+            timeout=self.timeout,
+            params={"limit": limit, "offset": offset},
+        )
+
+    def get_database(self, db_id: int):
+        """Get database."""
+        url = f"{self.api_url}/dbs/{db_id}"
+        return requests.get(url, headers=self.headers, timeout=self.timeout)
+
+    def get_database_presets(self):
+        """Get database presets list."""
+        url = f"{self.api_url}/presets/dbs"
+        return requests.get(url, headers=self.headers, timeout=self.timeout)
+
+    def create_database(
+        self,
+        name: str = None,
+        dbms: str = None,
+        login: str = None,
+        password: str = None,
+        hash_type: str = None,
+        preset_id: int = None,
+        config_parameters: dict = None,
+    ):
+        """Create database."""
+        url = f"{self.api_url}/dbs"
+        self.headers.update({"Content-Type": "application/json"})
+        payload = {
+            "name": name,
+            "type": dbms,
+            "login": login,
+            "password": password,
+            "hash_type": hash_type,
+            "preset_id": preset_id,
+            "config_parameters": config_parameters,
+        }
+        return requests.post(
+            url,
+            headers=self.headers,
+            timeout=self.timeout,
+            data=json.dumps(payload),
+        )
+
+    def update_database(
+        self,
+        db_id: int,
+        name: str = None,
+        password: str = None,
+        preset_id: int = None,
+        config_parameters: dict = None,
+        external_ip: bool = None,
+    ):
+        """Update database."""
+        url = f"{self.api_url}/dbs/{db_id}"
+        self.headers.update({"Content-Type": "application/json"})
+        payload = {}
+        if name:
+            payload["name"] = name
+        if password:
+            payload["password"] = password
+        if preset_id:
+            payload["preset_id"] = preset_id
+        if config_parameters:
+            payload["config_parameters"] = config_parameters
+        if external_ip:
+            payload["is_external_ip"] = external_ip
+        return requests.patch(
+            url,
+            headers=self.headers,
+            timeout=self.timeout,
+            data=json.dumps(payload),
+        )
+
+    def delete_database(
+        self, db_id: int, delete_hash: str = None, code: int = None
+    ):
+        """Delete database."""
+        url = f"{self.api_url}/dbs/{db_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 get_database_backups(
+        self, db_id: int, limit: int = 100, offset: int = 0
+    ):
+        """List database backups."""
+        url = f"{self.api_url}/dbs/{db_id}/backups"
+        return requests.get(
+            url,
+            headers=self.headers,
+            timeout=self.timeout,
+            params={"limit": limit, "offset": offset},
+        )
+
+    def get_database_backup(self, db_id: int, backup_id: int):
+        """Get database backup."""
+        url = f"{self.api_url}/dbs/{db_id}/backups/{backup_id}"
+        return requests.get(url, headers=self.headers, timeout=self.timeout)
+
+    def create_database_backup(self, db_id: int):
+        """Create database backup."""
+        url = f"{self.api_url}/dbs/{db_id}/backups"
+        self.headers.update({"Content-Type": "application/json"})
+        payload = {}
+        return requests.post(
+            url,
+            headers=self.headers,
+            timeout=self.timeout,
+            data=json.dumps(payload),
+        )
+
+    def delete_database_backup(self, db_id: int, backup_id: int):
+        """Delete database backup."""
+        url = f"{self.api_url}/dbs/{db_id}/backups/{backup_id}"
+        return requests.delete(url, headers=self.headers, timeout=self.timeout)
+
+    def restore_database_backup(self, db_id: int, backup_id: int):
+        """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.3.0/twc/click_ext.py

@@ -0,0 +1,34 @@
+"""Click extensions."""
+
+import click
+
+
+class MutuallyExclusiveOption(click.Option):
+    """Add mutually exclusive options support for Click. Example::
+
+    @click.option(
+        "--dry",
+        is_flag=True,
+        cls=MutuallyExclusiveOption,
+        mutually_exclusive=["wet"],
+    )
+    @click.option("--wet", is_flag=True)
+    """
+
+    def __init__(self, *args, **kwargs):
+        self.mutually_exclusive = set(kwargs.pop("mutually_exclusive", []))
+        help = kwargs.get("help", "")  # pylint: disable=redefined-builtin
+        if self.mutually_exclusive:
+            kwargs["help"] = help + (
+                " NOTE: This argument is mutually exclusive with "
+                f"arguments: [{', '.join(self.mutually_exclusive)}]."
+            )
+        super().__init__(*args, **kwargs)
+
+    def handle_parse_result(self, ctx, opts, args):
+        if self.mutually_exclusive.intersection(opts) and self.name in opts:
+            raise click.UsageError(
+                f"Illegal usage: '{self.name}' is mutually exclusive with "
+                f"arguments: [{', '.join(self.mutually_exclusive)}]."
+            )
+        return super().handle_parse_result(ctx, opts, args)

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

@@ -24,14 +24,6 @@ from twc.api import (
 # Configuration
 
 
-USER_AGENT = f"TWC-CLI/{__version__} Python {__pyversion__}"
-DEFAULT_CONFIG = {"default": {"token": ""}}
-DEFAULT_CONFIGURATOR_ID = 11
-REGIONS_WITH_CONFIGURATOR = ["ru-1"]
-REGIONS_WITH_IPV6 = ["ru-1", "pl-1"]
-REGIONS_WITH_IMAGES = ["ru-1"]
-
-
 def get_default_config_file() -> str:
     if os.name == "nt":
         env_home = "USERPROFILE"
@@ -45,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):
@@ -196,36 +192,6 @@ class MutuallyExclusiveOption(click.Option):
         return super().handle_parse_result(ctx, opts, args)
 
 
-def confirm_action(question: str, default: str = "no"):
-    """Ask a yes/no question via input() and return their answer.
-
-    The "answer" return value is True for "yes" or False for "no".
-    """
-    valid = {
-        "yes": True,
-        "y": True,
-        "ye": True,
-        "no": False,
-        "n": False,
-    }
-    if default is None:
-        prompt = "[y/n]"
-    elif default == "yes":
-        prompt = "[Y/n]"
-    elif default == "no":
-        prompt = "[y/N]"
-    else:
-        raise ValueError(f"Invalid default answer: '{default}'")
-
-    while True:
-        choice = input(f"{question} {prompt}: ").lower()
-        if default is not None and choice == "":
-            return valid[default]
-        if choice in valid:
-            return valid[choice]
-        sys.exit("Please respond with 'yes' or 'no' (or 'y' or 'n').")
-
-
 # -----------------------------------------------------------------------
 # API interaction
 
@@ -274,14 +240,15 @@ def create_client(config, profile):
     debug(f"Args: {sys.argv[1:]}")
 
     env_token = os.getenv("TWC_TOKEN")
+    user_agent = f"TWC-CLI/{__version__} Python {__pyversion__}"
 
     if env_token:
         debug("Get Timeweb Cloud token from environment variable")
-        return TimewebCloud(env_token, user_agent=USER_AGENT)
+        return TimewebCloud(env_token, user_agent=user_agent)
 
     try:
         debug(f"Configuration: config file={config}; profile={profile}")
         token = load_config(config)[profile]["token"]
-        return TimewebCloud(token, user_agent=USER_AGENT)
+        return TimewebCloud(token, user_agent=user_agent)
     except KeyError:
         sys.exit(f"Profile '{profile}' not found in {config}")