bsm-cli 1.6.0b3__py3-none-any.whl

bsm_cli/users.py

@@ -0,0 +1,245 @@
+import click
+import questionary
+from bsm_cli.decorators import pass_async_context
+
+
+async def interactive_user_workflow(ctx, client):  # noqa: C901
+    """Interactive menu for managing users."""
+    while True:
+        try:
+            users_list = await client.async_get_users()
+            click.clear()
+            click.secho("--- Manage Users ---", fg="magenta", bold=True)
+            for user in users_list:
+                click.echo(
+                    f"ID: {user.id} | Username: {user.username} | Role: {user.role} | Active: {user.is_active} | Type: {user.identity_type}"
+                )
+
+            choices = [
+                "List Users",
+                "Delete User",
+                "Set User Role",
+                "Enable User",
+                "Disable User",
+                "Generate Invite Link",
+                "Back",
+            ]
+            choice = await questionary.select(
+                "\nChoose an action:",
+                choices=choices,
+                use_indicator=True,
+            ).ask_async()
+
+            if choice is None or choice == "Back":
+                return
+
+            if choice == "List Users":
+                click.echo("\nUsers List:")
+                for user in users_list:
+                    click.echo(
+                        f"ID: {user.id} | Username: {user.username} | Role: {user.role} | Active: {user.is_active} | Type: {user.identity_type}"
+                    )
+                await questionary.press_any_key_to_continue().ask_async()
+
+            elif choice == "Delete User":
+                if not users_list:
+                    click.secho("No users found.", fg="yellow")
+                    await questionary.press_any_key_to_continue().ask_async()
+                    continue
+
+                user_choices = [
+                    questionary.Choice(title=f"{u.username} (ID: {u.id})", value=u.id)
+                    for u in users_list
+                ]
+                user_choices.append(questionary.Choice(title="Cancel", value="Cancel"))
+
+                user_id = await questionary.select(
+                    "Select user to delete:", choices=user_choices
+                ).ask_async()
+
+                if user_id and user_id != "Cancel":
+                    confirm = await questionary.confirm(
+                        f"Are you sure you want to delete user {user_id}?"
+                    ).ask_async()
+                    if confirm:
+                        response = await client.async_delete_user(user_id)
+                        click.echo(response.model_dump_json(indent=2))
+                        await questionary.press_any_key_to_continue().ask_async()
+
+            elif choice == "Set User Role":
+                if not users_list:
+                    click.secho("No users found.", fg="yellow")
+                    await questionary.press_any_key_to_continue().ask_async()
+                    continue
+
+                user_choices = [
+                    questionary.Choice(title=f"{u.username} (ID: {u.id})", value=u.id)
+                    for u in users_list
+                ]
+                user_choices.append(questionary.Choice(title="Cancel", value="Cancel"))
+
+                user_id = await questionary.select(
+                    "Select user to modify:", choices=user_choices
+                ).ask_async()
+
+                if user_id and user_id != "Cancel":
+                    role = await questionary.select(
+                        "Select new role:",
+                        choices=["user", "moderator", "admin"],
+                    ).ask_async()
+                    if role:
+                        response = await client.async_update_user_role(user_id, role)
+                        click.echo(response.model_dump_json(indent=2))
+                        await questionary.press_any_key_to_continue().ask_async()
+
+            elif choice == "Enable User":
+                if not users_list:
+                    click.secho("No users found.", fg="yellow")
+                    await questionary.press_any_key_to_continue().ask_async()
+                    continue
+
+                disabled_users = [u for u in users_list if not u.is_active]
+                if not disabled_users:
+                    click.secho("No disabled users found.", fg="yellow")
+                    await questionary.press_any_key_to_continue().ask_async()
+                    continue
+
+                user_choices = [
+                    questionary.Choice(title=f"{u.username} (ID: {u.id})", value=u.id)
+                    for u in disabled_users
+                ]
+                user_choices.append(questionary.Choice(title="Cancel", value="Cancel"))
+
+                user_id = await questionary.select(
+                    "Select user to enable:", choices=user_choices
+                ).ask_async()
+
+                if user_id and user_id != "Cancel":
+                    response = await client.async_enable_user(user_id)
+                    click.echo(response.model_dump_json(indent=2))
+                    await questionary.press_any_key_to_continue().ask_async()
+
+            elif choice == "Disable User":
+                if not users_list:
+                    click.secho("No users found.", fg="yellow")
+                    await questionary.press_any_key_to_continue().ask_async()
+                    continue
+
+                enabled_users = [u for u in users_list if u.is_active]
+                if not enabled_users:
+                    click.secho("No enabled users found.", fg="yellow")
+                    await questionary.press_any_key_to_continue().ask_async()
+                    continue
+
+                user_choices = [
+                    questionary.Choice(title=f"{u.username} (ID: {u.id})", value=u.id)
+                    for u in enabled_users
+                ]
+                user_choices.append(questionary.Choice(title="Cancel", value="Cancel"))
+
+                user_id = await questionary.select(
+                    "Select user to disable:", choices=user_choices
+                ).ask_async()
+
+                if user_id and user_id != "Cancel":
+                    response = await client.async_disable_user(user_id)
+                    click.echo(response.model_dump_json(indent=2))
+                    await questionary.press_any_key_to_continue().ask_async()
+
+            elif choice == "Generate Invite Link":
+                role = await questionary.select(
+                    "Select role for invite:",
+                    choices=["user", "moderator", "admin"],
+                ).ask_async()
+                if role:
+                    response = await client.async_generate_invite_token(role)
+                    click.echo(f"Invite Link: {response.registration_url}")
+                    await questionary.press_any_key_to_continue().ask_async()
+
+        except Exception as e:
+            click.secho(f"An error occurred: {e}", fg="red")
+            await questionary.press_any_key_to_continue().ask_async()
+
+
+@click.group(invoke_without_command=True)
+@click.pass_context
+async def users(ctx):
+    """Commands for managing users."""
+    if ctx.invoked_subcommand is None:
+        client = ctx.obj.get("client")
+        if not client:
+            click.secho("You are not logged in.", fg="red")
+            return
+        await interactive_user_workflow(ctx, client)
+
+
+@users.command()
+@pass_async_context
+async def list(ctx):
+    """List all users."""
+    client = ctx.obj["client"]
+    users = await client.async_get_users()
+    for user in users:
+        click.echo(
+            f"ID: {user.id} | Username: {user.username} | Role: {user.role} | Active: {user.is_active} | Type: {user.identity_type}"
+        )
+
+
+@users.command()
+@click.argument("user_id", type=int)
+@click.option("--yes", is_flag=True, help="Skip confirmation prompt")
+@pass_async_context
+async def delete(ctx, user_id: int, yes: bool):
+    """Delete a user."""
+    client = ctx.obj["client"]
+    if not yes:
+        confirm = await questionary.confirm(
+            f"Are you sure you want to delete user {user_id}?"
+        ).ask_async()
+        if not confirm:
+            click.echo("Aborted.")
+            return
+
+    response = await client.async_delete_user(user_id)
+    click.echo(response.model_dump_json(indent=2))
+
+
+@users.command()
+@click.argument("user_id", type=int)
+@click.argument("role", type=click.Choice(["user", "moderator", "admin"]))
+@pass_async_context
+async def set_role(ctx, user_id: int, role: str):
+    """Set a user's role."""
+    client = ctx.obj["client"]
+    response = await client.async_update_user_role(user_id, role)
+    click.echo(response.model_dump_json(indent=2))
+
+
+@users.command()
+@click.argument("user_id", type=int)
+@pass_async_context
+async def enable(ctx, user_id: int):
+    """Enable a user account."""
+    client = ctx.obj["client"]
+    response = await client.async_enable_user(user_id)
+    click.echo(response.model_dump_json(indent=2))
+
+
+@users.command()
+@click.argument("user_id", type=int)
+@pass_async_context
+async def disable(ctx, user_id: int):
+    """Disable a user account."""
+    client = ctx.obj["client"]
+    response = await client.async_disable_user(user_id)
+    click.echo(response.model_dump_json(indent=2))
+
+
+@users.command()
+@click.argument("role", type=click.Choice(["user", "moderator", "admin"]))
+@pass_async_context
+async def invite(ctx, role: str):
+    """Generate an invite link for a new user."""
+    client = ctx.obj["client"]
+    response = await client.async_generate_invite_token(role)
+    click.echo(f"Invite Link: {response.registration_url}")

bsm_cli/world.py

@@ -0,0 +1,171 @@
+import os
+
+import click
+import questionary
+from bsm_cli.decorators import monitor_task, pass_async_context
+
+from bsm_api_client.models import FileNamePayload
+
+
+@click.group()
+def world():
+    """Manages server worlds."""
+    pass
+
+
+@world.command("install")
+@click.option(
+    "-s", "--server", "server_name", required=True, help="Name of the target server."
+)
+@click.option(
+    "-f",
+    "--file",
+    "world_file_path",
+    type=click.Path(exists=True, dir_okay=False, resolve_path=True),
+    help="Path to the .mcworld file to install. Skips interactive menu.",
+)
+@pass_async_context
+async def install_world(ctx, server_name: str, world_file_path: str):
+    """Installs a world from a .mcworld file, replacing the server's current world."""
+    client = ctx.obj.get("client")
+    if not client:
+        click.secho("You are not logged in.", fg="red")
+        return
+
+    try:
+        selected_file = world_file_path
+
+        if not selected_file:
+            click.secho(
+                f"Entering interactive world installation for server: {server_name}",
+                fg="yellow",
+            )
+            response = await client.async_get_content_worlds()
+            available_files = response.files
+
+            if not available_files:
+                click.secho(
+                    "No .mcworld files found in the content/worlds directory. Nothing to install.",
+                    fg="yellow",
+                )
+                return
+
+            file_map = {os.path.basename(f): f for f in available_files}
+            choices = sorted(list(file_map.keys())) + ["Cancel"]
+            selection = await questionary.select(
+                "Select a world to install:", choices=choices
+            ).ask_async()
+
+            if not selection or selection == "Cancel":
+                raise click.Abort()
+            selected_file = file_map[selection]
+
+        filename = os.path.basename(selected_file)
+        click.secho(
+            f"\nWARNING: Installing '{filename}' will REPLACE the current world data for server '{server_name}'.",
+            fg="red",
+            bold=True,
+        )
+        if not await questionary.confirm(
+            "This action cannot be undone. Are you sure?", default=False
+        ).ask_async():
+            raise click.Abort()
+
+        click.echo(f"Installing world '{filename}'...")
+        payload = FileNamePayload(filename=filename)
+        response = await client.async_install_server_world(server_name, payload)
+
+        if response.task_id:
+            await monitor_task(
+                client,
+                response.task_id,
+                f"World '{filename}' installed successfully",
+                "Failed to install world",
+            )
+        elif response.status == "success":
+            click.secho(f"World '{filename}' installed successfully.", fg="green")
+        else:
+            click.secho(f"Failed to install world: {response.message}", fg="red")
+
+    except Exception as e:
+        click.secho(f"An error occurred: {e}", fg="red")
+
+
+@world.command("export")
+@click.option(
+    "-s",
+    "--server",
+    "server_name",
+    required=True,
+    help="Name of the server whose world to export.",
+)
+@pass_async_context
+async def export_world(ctx, server_name: str):
+    """Exports the server's current active world to a .mcworld file."""
+    client = ctx.obj.get("client")
+    if not client:
+        click.secho("You are not logged in.", fg="red")
+        return
+
+    click.echo(f"Attempting to export world for server '{server_name}'...")
+    try:
+        response = await client.async_export_server_world(server_name)
+        if response.task_id:
+            await monitor_task(
+                client,
+                response.task_id,
+                "World exported successfully",
+                "Failed to export world",
+            )
+        elif response.status == "success":
+            click.secho("World exported successfully.", fg="green")
+        else:
+            click.secho(f"Failed to export world: {response.message}", fg="red")
+    except Exception as e:
+        click.secho(f"An error occurred during export: {e}", fg="red")
+
+
+@world.command("reset")
+@click.option(
+    "-s",
+    "--server",
+    "server_name",
+    required=True,
+    help="Name of the server whose world to reset.",
+)
+@click.option("-y", "--yes", is_flag=True, help="Bypass the confirmation prompt.")
+@pass_async_context
+async def reset_world(ctx, server_name: str, yes: bool):
+    """Deletes the current active world data for a server."""
+    client = ctx.obj.get("client")
+    if not client:
+        click.secho("You are not logged in.", fg="red")
+        return
+
+    if not yes:
+        click.secho(
+            f"WARNING: This will permanently delete the current world for server '{server_name}'.",
+            fg="red",
+            bold=True,
+        )
+        click.confirm(
+            "This action cannot be undone. Are you sure you want to reset the world?",
+            abort=True,
+        )
+
+    click.echo(f"Resetting world for server '{server_name}'...")
+    try:
+        response = await client.async_reset_server_world(server_name)
+        if response.task_id:
+            await monitor_task(
+                client,
+                response.task_id,
+                "World has been reset successfully",
+                "Failed to reset world",
+            )
+        elif response.status == "success":
+            click.secho("World has been reset successfully.", fg="green")
+        else:
+            click.secho(f"Failed to reset world: {response.message}", fg="red")
+    except Exception as e:
+        click.secho(f"An error occurred during reset: {e}", fg="red")

bsm_cli-1.6.0b3.dist-info/METADATA

@@ -0,0 +1,77 @@
+Metadata-Version: 2.4
+Name: bsm-cli
+Version: 1.6.0b3
+Summary: A CLI for managing Bedrock servers via BSM API
+Author-email: DMedina559 <dmedina559-github@outlook.com>
+Project-URL: Homepage, https://github.com/DMedina559/bsm-api-client
+Keywords: minecraft,bedrock,server,manager,cli
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Developers
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click<8.5,>=8.2.0
+Requires-Dist: questionary<2.2,>=2.1.0
+Requires-Dist: bsm-api-client
+Provides-Extra: dev
+Requires-Dist: pytest<9.2,>=8.4.0; extra == "dev"
+Requires-Dist: pytest-mock<3.16,>=3.14.0; extra == "dev"
+Requires-Dist: pytest-asyncio<1.5,>=1.1.0; extra == "dev"
+Requires-Dist: black<26.6,>=25.1.0; extra == "dev"
+Requires-Dist: flake8<7.4,>=7.3.0; extra == "dev"
+Requires-Dist: isort<8.1,>=5.13.0; extra == "dev"
+Requires-Dist: mypy<2.2,>=1.10.0; extra == "dev"
+Requires-Dist: bedrock-server-manager<3.11.0,>=3.10.0b3; extra == "dev"
+Requires-Dist: pre-commit<4.7,>=4.6.0; extra == "dev"
+Dynamic: license-file
+
+<div style="text-align: center;">
+    <img src="https://raw.githubusercontent.com/DMedina559/bsm-frontend/main/frontend/public/image/icon/favicon.svg" alt="BSM Logo" width="150">
+</div>
+
+# bsm-cli
+
+<p align="center">
+  <a href="https://github.com/DMedina559/bsm-api-client/releases">
+    <img alt="Stable" src="https://img.shields.io/github/v/release/DMedina559/bsm-api-client?label=Stable&color=blue">
+  </a>
+  <a href="https://github.com/DMedina559/bsm-api-client/releases">
+    <img alt="Pre-Release" src="https://img.shields.io/github/v/release/DMedina559/bsm-api-client?include_prereleases&label=Pre-Release&color=red">
+  </a>
+  <a href="https://github.com/DMedina559/bsm-api-client/actions">
+    <img alt="Tests" src="https://img.shields.io/github/actions/workflow/status/DMedina559/bsm-api-client/build-test.yml?label=Tests&event=push">
+  </a>
+</p>
+
+## Introduction
+
+`bsm-cli` is a command-line interface tool for managing Minecraft Bedrock Dedicated Servers via the Bedrock Server Manager API.
+
+## Features
+
+*   Full CLI interface using `click` and `questionary`.
+*   Interactive menus for server management.
+*   Realtime server state updates via WebSocket.
+*   Seamlessly manages configuration for server and backups.
+
+## Installation
+
+Install the library using pip:
+
+```bash
+pip install bsm-cli
+```
+
+## Quick Start
+
+You can invoke the CLI using:
+
+```bash
+bsm-cli
+```
+
+Which will trigger the interactive menu allowing you to manage and configure your Bedrock Dedicated Servers.

bsm_cli-1.6.0b3.dist-info/RECORD

@@ -0,0 +1,26 @@
+bsm_cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bsm_cli/__main__.py,sha256=Jb5mbgqzvXtgoy2qW8yvNPqMnq7jbBJfPJurnOUxszc,2221
+bsm_cli/account.py,sha256=xnaFNhuskKt3biYnwO6pePkGb_iYGKOE5PVsMD6SHu4,2156
+bsm_cli/addon.py,sha256=xfq_zEfS5OreoRnhSLSmP5y_sx6zkCOqzLkdd-8KdKs,14072
+bsm_cli/allowlist.py,sha256=fqyaa8YwsCV9KuI3Lh79vmCoUr5KqgFFbPd2skxx72k,7814
+bsm_cli/auth.py,sha256=AJK7daic0TbM15GFn77bn9WdFuH14fZtR3nfLJRvLCM,3012
+bsm_cli/backup.py,sha256=-GpRTX2AnEGYBVXxlciKKOMmjn6Y32Ei5y7g6JlFOrU,8792
+bsm_cli/bans.py,sha256=9ohs2ofAvXT022hWyE5Ibbj6rrzELua88FGFFlp_KY0,6024
+bsm_cli/config.py,sha256=iRrilB7b9g6P79O4pznBz--M3d8555j1qAQXsXn-jVI,2528
+bsm_cli/content.py,sha256=F631Dpryi_UiFnkhCk-aVbrNlDyyaS7LjOCFunMgbQg,513
+bsm_cli/decorators.py,sha256=9-bsWWCOUQUDrX7oRRD4gvzqKRPVOUXcSFgGrvxtM_U,5031
+bsm_cli/main_menus.py,sha256=XuuTU49_Ypo1lT1AuUbwu643LDCyrIdSU3hCox5yjn4,10546
+bsm_cli/permissions.py,sha256=5DQ0-TFERdwjDWBFPC8ZyEWLnsAPgjKO4vaxqSrb2zU,6356
+bsm_cli/player.py,sha256=vQygt9j8SAgAZKydz5lWJkEiPWkLJ3u2hYGvBjQxdc4,1922
+bsm_cli/plugins.py,sha256=gMEqRgX8pe_4fg6UtVLGtybLOmZu-CaJj_yC5xi-vTY,10400
+bsm_cli/properties.py,sha256=eoGQE_-g3Y9GbM_nbb3hClH1SPd8poV6pWXERT2Kwe0,7021
+bsm_cli/server.py,sha256=GfQ1fl-Z6u6409_HwUaS3jvEqbULLwqjqADxbDJ63Wc,17309
+bsm_cli/system.py,sha256=y1XAbiWv0TaGpbE0LMfkMVfyY18L8RoMWVS3eijyLNM,4886
+bsm_cli/users.py,sha256=lg2dkaUyay9F1rJnYY2XgLeW0MX9PI74vSTK3n4_sm0,9550
+bsm_cli/world.py,sha256=AszZrZmWhJD_xioasZldxfLWfCxjqwLhn38KQhz0zgI,5653
+bsm_cli-1.6.0b3.dist-info/licenses/LICENSE,sha256=dsRN6HXDmbpw1K4fTVXgOrzgsWZOjJ03O09ZkjQUR_A,1062
+bsm_cli-1.6.0b3.dist-info/METADATA,sha256=BIdWVEXn7n94OsYZrKW8kEPil-mpucZNAGgxeH58i5g,2782
+bsm_cli-1.6.0b3.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+bsm_cli-1.6.0b3.dist-info/entry_points.txt,sha256=VvvRZ2PKz2fxBr36ZXiG1Fu84KVMgAr7Vtsq8X3IQr4,49
+bsm_cli-1.6.0b3.dist-info/top_level.txt,sha256=b9po-lHYQ4duM9sNLw8dxxhhj3ow8cTBHAy61cIs4Ys,8
+bsm_cli-1.6.0b3.dist-info/RECORD,,

bsm_cli-1.6.0b3.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

bsm_cli-1.6.0b3.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+bsm-cli = bsm_cli.__main__:cli

bsm_cli-1.6.0b3.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Danny
+
+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.

bsm_cli-1.6.0b3.dist-info/top_level.txt

@@ -0,0 +1 @@
+bsm_cli