bsm-api-client 1.2.0__tar.gz → 1.3.0__tar.gz

{bsm_api_client-1.2.0/src/bsm_api_client.egg-info → bsm_api_client-1.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bsm-api-client
-Version: 1.2.0
+Version: 1.3.0
 Summary: A Python client library for the Bedrock Server Manager API
 Author-email: DMedina559 <dmedina559-github@outlook.com>
 Project-URL: Homepage, https://github.com/DMedina559/bsm-api-client
@@ -21,12 +21,13 @@ Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: aiohttp<4.0.0,>=3.8.0
-Requires-Dist: pydantic<2.12,>=2.11.0
+Requires-Dist: pydantic<2.13,>=2.11.0
 Provides-Extra: dev
 Requires-Dist: pytest<8.5,>=8.4.0; extra == "dev"
-Requires-Dist: pytest-asyncio<1.2.0,>=1.1.0; extra == "dev"
-Requires-Dist: black<25.2,>=25.1.0; extra == "dev"
+Requires-Dist: pytest-asyncio<1.3.0,>=1.1.0; extra == "dev"
+Requires-Dist: black<25.12,>=25.1.0; extra == "dev"
 Requires-Dist: flake8<7.4,>=7.3.0; extra == "dev"
+Requires-Dist: bedrock-server-manager<3.7.0,>=3.6.0b1; extra == "dev"
 Provides-Extra: cli
 Requires-Dist: click<8.3,>=8.2.0; extra == "cli"
 Requires-Dist: questionary<2.2,>=2.1.0; extra == "cli"

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

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "bsm-api-client"
-version = "1.2.0"
+version = "1.3.0"
 authors = [
     { name="DMedina559", email="dmedina559-github@outlook.com" },
 ]
@@ -28,15 +28,16 @@ classifiers = [
 ]
 dependencies = [
     "aiohttp >= 3.8.0,<4.0.0",
-    "pydantic >= 2.11.0,<2.12",
+    "pydantic >= 2.11.0,< 2.13",
 ]
 
 [project.optional-dependencies]
 dev = [
     "pytest >=8.4.0,<8.5",
-    "pytest-asyncio >= 1.1.0,<1.2.0",
-    "black >=25.1.0,<25.2",
+    "pytest-asyncio >= 1.1.0,< 1.3.0",
+    "black >=25.1.0,<25.12",
     "flake8 >=7.3.0,<7.4",
+    "bedrock-server-manager >=3.6.0b1,<3.7.0",
 ]
 cli = [
     "click >=8.2.0,<8.3",

{bsm_api_client-1.2.0 → bsm_api_client-1.3.0}/src/bsm_api_client/api_client.py

@@ -12,6 +12,7 @@ from .client._server_info_methods import ServerInfoMethodsMixin
 from .client._server_action_methods import ServerActionMethodsMixin
 from .client._content_methods import ContentMethodsMixin
 from .client._plugin_methods import PluginMethodsMixin
+from .client._account_methods import AccountMethodsMixin
 
 _LOGGER = logging.getLogger(__name__.split(".")[0] + ".client")
 
@@ -23,6 +24,7 @@ class BedrockServerManagerApi(
     ServerActionMethodsMixin,
     ContentMethodsMixin,
     PluginMethodsMixin,
+    AccountMethodsMixin,
 ):
     """API Client for the Bedrock Server Manager.
 

{bsm_api_client-1.2.0 → bsm_api_client-1.3.0}/src/bsm_api_client/cli/__main__.py

@@ -15,7 +15,6 @@ from .auth import auth
 from .server import server
 from .addon import addon
 from .backup import backup
-from .cleanup import cleanup
 from .player import player
 from .plugins import plugin
 from .allowlist import allowlist
@@ -23,6 +22,8 @@ from .permissions import permissions
 from .properties import properties
 from .system import system
 from .world import world
+from .account import account
+from .content import content
 from .main_menus import main_menu
 from .decorators import AsyncGroup
 
@@ -60,7 +61,6 @@ cli.add_command(auth)
 cli.add_command(server)
 cli.add_command(addon)
 cli.add_command(backup)
-cli.add_command(cleanup)
 cli.add_command(player)
 cli.add_command(plugin)
 cli.add_command(allowlist)
@@ -68,6 +68,8 @@ cli.add_command(permissions)
 cli.add_command(properties)
 cli.add_command(system)
 cli.add_command(world)
+cli.add_command(account)
+cli.add_command(content)
 
 if __name__ == "__main__":
     cli()

bsm_api_client-1.3.0/src/bsm_api_client/cli/account.py

@@ -0,0 +1,74 @@
+# src/bsm_api_client/cli/account.py
+"""CLI commands for account management."""
+import click
+from .decorators import pass_async_context
+
+
+@click.group()
+def account():
+    """Commands for managing your account."""
+    pass
+
+
+@account.command()
+@pass_async_context
+async def details(ctx):
+    """Get your account details."""
+    client = ctx.obj["client"]
+    details = await client.async_get_account_details()
+    click.echo(details.model_dump_json(indent=2))
+
+
+@account.command()
+@click.option("--theme", prompt="Theme name", help="The name of the theme to set.")
+@pass_async_context
+async def update_theme(ctx, theme):
+    """Update your theme."""
+    from bsm_api_client.models import ThemeUpdate
+
+    client = ctx.obj["client"]
+    payload = ThemeUpdate(theme=theme)
+    response = await client.async_update_theme(payload)
+    click.echo(response.model_dump_json(indent=2))
+
+
+@account.command()
+@click.option("--full-name", prompt="Full Name", help="Your full name.")
+@click.option("--email", prompt="Email", help="Your email address.")
+@pass_async_context
+async def update_profile(ctx, full_name, email):
+    """Update your profile."""
+    from bsm_api_client.models import ProfileUpdate
+
+    client = ctx.obj["client"]
+    payload = ProfileUpdate(full_name=full_name, email=email)
+    response = await client.async_update_profile(payload)
+    click.echo(response.model_dump_json(indent=2))
+
+
+@account.command()
+@click.option(
+    "--current-password",
+    prompt=True,
+    hide_input=True,
+    confirmation_prompt=False,
+    help="Your current password.",
+)
+@click.option(
+    "--new-password",
+    prompt=True,
+    hide_input=True,
+    confirmation_prompt=True,
+    help="Your new password.",
+)
+@pass_async_context
+async def change_password(ctx, current_password, new_password):
+    """Change your password."""
+    from bsm_api_client.models import ChangePasswordRequest
+
+    client = ctx.obj["client"]
+    payload = ChangePasswordRequest(
+        current_password=current_password, new_password=new_password
+    )
+    response = await client.async_change_password(payload)
+    click.echo(response.model_dump_json(indent=2))

{bsm_api_client-1.2.0 → bsm_api_client-1.3.0}/src/bsm_api_client/cli/addon.py

@@ -1,6 +1,7 @@
 import click
 import os
 import questionary
+from .decorators import pass_async_context, monitor_task
 from bsm_api_client.models import FileNamePayload
 
 
@@ -21,7 +22,7 @@ def addon():
     type=click.Path(exists=True, dir_okay=False, resolve_path=True),
     help="Path to the addon file (.mcpack, .mcaddon); skips interactive menu.",
 )
-@click.pass_context
+@pass_async_context
 async def install_addon(ctx, server_name: str, addon_file_path: str):
     """Installs a behavior or resource pack addon to a specified server."""
     client = ctx.obj.get("client")
@@ -62,7 +63,14 @@ async def install_addon(ctx, server_name: str, addon_file_path: str):
 
         payload = FileNamePayload(filename=addon_filename)
         response = await client.async_install_server_addon(server_name, payload)
-        if response.status == "success":
+        if response.task_id:
+            await monitor_task(
+                client,
+                response.task_id,
+                f"Addon '{addon_filename}' installed successfully",
+                "Failed to install addon",
+            )
+        elif response.status == "success":
             click.secho(f"Addon '{addon_filename}' installed successfully.", fg="green")
         else:
             click.secho(f"Failed to install addon: {response.message}", fg="red")

{bsm_api_client-1.2.0 → bsm_api_client-1.3.0}/src/bsm_api_client/cli/auth.py

@@ -3,6 +3,13 @@ from .config import Config
 from bsm_api_client import BedrockServerManagerApi, AuthError
 
 
+def _validate_and_get_url(url: str) -> str:
+    """Validates and returns a url with a scheme."""
+    if not url.startswith("http://") and not url.startswith("https://"):
+        return f"http://{url}"
+    return url
+
+
 @click.group()
 def auth():
     """Manages authentication."""
@@ -29,7 +36,8 @@ async def login(ctx, base_url, username, password, verify_ssl, token):
     config = ctx.obj["config"]
 
     if base_url:
-        config.set("base_url", base_url)
+        validated_url = _validate_and_get_url(base_url)
+        config.set("base_url", validated_url)
 
     config.set("verify_ssl", verify_ssl)
 
@@ -42,6 +50,9 @@ async def login(ctx, base_url, username, password, verify_ssl, token):
         await interactive_login(ctx)
         return
 
+    if username and not password:
+        password = click.prompt("Password", hide_input=True)
+
     client = BedrockServerManagerApi(
         base_url=config.base_url,
         username=username,
@@ -64,8 +75,12 @@ async def interactive_login(ctx):
     username = click.prompt("Username")
     password = click.prompt("Password", hide_input=True)
 
+    validated_url = _validate_and_get_url(config.base_url)
+    if validated_url != config.base_url:
+        config.set("base_url", validated_url)
+
     client = BedrockServerManagerApi(
-        base_url=config.base_url,
+        base_url=validated_url,
         username=username,
         password=password,
         verify_ssl=config.verify_ssl,

{bsm_api_client-1.2.0 → bsm_api_client-1.3.0}/src/bsm_api_client/cli/backup.py

@@ -1,6 +1,7 @@
 import click
 import os
 import questionary
+from .decorators import pass_async_context, monitor_task
 from bsm_api_client.models import BackupActionPayload, RestoreActionPayload
 
 
@@ -27,7 +28,7 @@ def backup():
     "file_to_backup",
     help="Specific file to back up (required if --type=config).",
 )
-@click.pass_context
+@pass_async_context
 async def create_backup(ctx, server_name: str, backup_type: str, file_to_backup: str):
     """Creates a backup of specified server data."""
     client = ctx.obj.get("client")
@@ -51,16 +52,30 @@ async def create_backup(ctx, server_name: str, backup_type: str, file_to_backup:
         )
         response = await client.async_trigger_server_backup(server_name, payload)
 
-        if response.status == "success":
-            click.secho("Backup completed successfully.", fg="green")
+        if response.task_id:
+            await monitor_task(
+                client,
+                response.task_id,
+                "Backup completed successfully",
+                "Failed to create backup",
+            )
             click.echo("Pruning old backups...")
             prune_response = await client.async_prune_server_backups(server_name)
-            if prune_response.status == "success":
+            if prune_response.task_id:
+                await monitor_task(
+                    client,
+                    prune_response.task_id,
+                    "Pruning complete",
+                    "Failed to prune backups",
+                )
+            elif prune_response.status == "success":
                 click.secho("Pruning complete.", fg="green")
             else:
                 click.secho(
                     f"Failed to prune backups: {prune_response.message}", fg="red"
                 )
+        elif response.status == "success":
+            click.secho("Backup completed successfully.", fg="green")
         else:
             click.secho(f"Failed to create backup: {response.message}", fg="red")
 
@@ -79,7 +94,7 @@ async def create_backup(ctx, server_name: str, backup_type: str, file_to_backup:
     type=click.Path(exists=True, dir_okay=False, resolve_path=True),
     help="Path to the backup file to restore; skips interactive menu.",
 )
-@click.pass_context
+@pass_async_context
 async def restore_backup(ctx, server_name: str, backup_file_path: str):
     """Restores server data from a specified backup file."""
     client = ctx.obj.get("client")
@@ -116,7 +131,14 @@ async def restore_backup(ctx, server_name: str, backup_file_path: str):
         )
         response = await client.async_restore_server_backup(server_name, payload)
 
-        if response.status == "success":
+        if response.task_id:
+            await monitor_task(
+                client,
+                response.task_id,
+                "Restore completed successfully",
+                "Failed to restore backup",
+            )
+        elif response.status == "success":
             click.secho("Restore completed successfully.", fg="green")
         else:
             click.secho(f"Failed to restore backup: {response.message}", fg="red")
@@ -133,7 +155,7 @@ async def restore_backup(ctx, server_name: str, backup_file_path: str):
     required=True,
     help="Name of the server whose backups to prune.",
 )
-@click.pass_context
+@pass_async_context
 async def prune_backups(ctx, server_name: str):
     """Deletes old backups for a server."""
     client = ctx.obj.get("client")
@@ -144,7 +166,14 @@ async def prune_backups(ctx, server_name: str):
     try:
         click.echo(f"Pruning old backups for server '{server_name}'...")
         response = await client.async_prune_server_backups(server_name)
-        if response.status == "success":
+        if response.task_id:
+            await monitor_task(
+                client,
+                response.task_id,
+                "Pruning complete",
+                "Failed to prune backups",
+            )
+        elif response.status == "success":
             click.secho("Pruning complete.", fg="green")
         else:
             click.secho(f"Failed to prune backups: {response.message}", fg="red")

bsm_api_client-1.3.0/src/bsm_api_client/cli/content.py

@@ -0,0 +1,20 @@
+# src/bsm_api_client/cli/content.py
+"""CLI commands for content management."""
+import click
+from .decorators import pass_async_context
+
+
+@click.group()
+def content():
+    """Commands for managing content."""
+    pass
+
+
+@content.command()
+@click.argument("file_path", type=click.Path(exists=True, dir_okay=False))
+@pass_async_context
+async def upload(ctx, file_path):
+    """Upload a content file."""
+    client = ctx.obj["client"]
+    response = await client.async_upload_content(file_path)
+    click.echo(response)

bsm_api_client-1.3.0/src/bsm_api_client/cli/decorators.py

@@ -0,0 +1,73 @@
+import asyncio
+import functools
+import time
+import click
+
+
+class AsyncGroup(click.Group):
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.async_context_settings = {}
+
+    def context(self, f):
+        self.async_context_settings["context"] = f
+        return f
+
+    def invoke(self, ctx):
+        ctx.obj = ctx.obj or {}
+        if self.async_context_settings.get("context"):
+
+            async def runner():
+                async with self.async_context_settings["context"](ctx):
+                    result = super(AsyncGroup, self).invoke(ctx)
+                    if asyncio.iscoroutine(result):
+                        await result
+
+            return asyncio.run(runner())
+
+        result = super().invoke(ctx)
+        if asyncio.iscoroutine(result):
+            return asyncio.run(result)
+        return result
+
+
+def pass_async_context(f):
+    @functools.wraps(f)
+    def wrapper(*args, **kwargs):
+        ctx = click.get_current_context()
+        return f(ctx, *args, **kwargs)
+
+    return wrapper
+
+
+async def monitor_task(
+    client, task_id: str, success_message: str, failure_message: str
+):
+    """Polls the status of a background task until it completes."""
+    click.echo("Task started in the background. Polling for completion...")
+    while True:
+        try:
+            status_response = await client.async_get_task_status(task_id)
+            status = status_response.get("status")
+            message = status_response.get("message", "No message provided.")
+
+            if status == "success":
+                click.secho(f"{success_message}: {message}", fg="green")
+                break
+            elif status == "error":
+                click.secho(
+                    f"{failure_message}: {message}",
+                    fg="red",
+                )
+                break
+            elif status == "pending":
+                # Still waiting, continue loop
+                pass
+            else:
+                # Handle unexpected status
+                click.secho(f"Unknown task status received: {status}", fg="yellow")
+
+            time.sleep(2)
+        except Exception as e:
+            click.secho(f"An error occurred while monitoring task: {e}", fg="red")
+            break

{bsm_api_client-1.2.0 → bsm_api_client-1.3.0}/src/bsm_api_client/cli/main_menus.py

@@ -82,7 +82,7 @@ async def main_menu(ctx: click.Context):
             await ctx.invoke(list_servers)
 
             # --- Dynamically build menu choices ---
-            response = await client.async_get_servers_details()
+            response = await client.async_get_servers()
             server_names = (
                 [s["name"] for s in response.servers] if response.servers else []
             )

{bsm_api_client-1.2.0 → bsm_api_client-1.3.0}/src/bsm_api_client/cli/server.py

@@ -2,7 +2,7 @@ import os
 import time
 import click
 import questionary
-from .decorators import pass_async_context
+from .decorators import pass_async_context, monitor_task
 from bsm_api_client.models import InstallServerPayload, CommandPayload
 
 
@@ -61,7 +61,7 @@ async def list_servers(ctx, loop, server_name):
         return
 
     async def _display_status():
-        response = await client.async_get_servers_details()
+        response = await client.async_get_servers()
         all_servers = response.servers
 
         if server_name:
@@ -120,7 +120,7 @@ async def start_server(ctx, server_name: str):
 @click.option(
     "-s", "--server", "server_name", required=True, help="Name of the server to stop."
 )
-@click.pass_context
+@pass_async_context
 async def stop_server(ctx, server_name: str):
     """Sends a graceful stop command to a running Bedrock server."""
     client = ctx.obj.get("client")
@@ -131,7 +131,14 @@ async def stop_server(ctx, server_name: str):
     click.echo(f"Attempting to stop server '{server_name}'...")
     try:
         response = await client.async_stop_server(server_name)
-        if response.status == "success":
+        if response.task_id:
+            await monitor_task(
+                client,
+                response.task_id,
+                "Server stopped successfully",
+                "Failed to stop server",
+            )
+        elif response.status == "success":
             click.secho(f"Stop signal sent to server '{server_name}'.", fg="green")
         else:
             click.secho(f"Failed to stop server: {response.message}", fg="red")
@@ -147,7 +154,7 @@ async def stop_server(ctx, server_name: str):
     required=True,
     help="Name of the server to restart.",
 )
-@click.pass_context
+@pass_async_context
 async def restart_server(ctx, server_name: str):
     """Gracefully restarts a specific Bedrock server."""
     client = ctx.obj.get("client")
@@ -158,7 +165,14 @@ async def restart_server(ctx, server_name: str):
     click.echo(f"Attempting to restart server '{server_name}'...")
     try:
         response = await client.async_restart_server(server_name)
-        if response.status == "success":
+        if response.task_id:
+            await monitor_task(
+                client,
+                response.task_id,
+                "Server restarted successfully",
+                "Failed to restart server",
+            )
+        elif response.status == "success":
             click.secho(f"Restart signal sent to server '{server_name}'.", fg="green")
         else:
             click.secho(f"Failed to restart server: {response.message}", fg="red")
@@ -233,23 +247,12 @@ async def install(ctx):
         install_result = await client.async_install_new_server(payload)
 
         if install_result.task_id:
-            time.sleep(5)  # Give the server time to start installation
-            click.echo("Server installation started. Polling for completion...")
-            while True:
-                status_response = await client.async_get_task_status(
-                    install_result.task_id
-                )
-                if status_response["status"] == "success":
-                    click.secho(
-                        "Server installation completed successfully.", fg="green"
-                    )
-                    break
-                elif status_response["status"] == "error":
-                    click.secho(
-                        f"Installation failed: {status_response['message']}", fg="red"
-                    )
-                    return
-                time.sleep(2)
+            await monitor_task(
+                client,
+                install_result.task_id,
+                "Server installation completed successfully",
+                "Installation failed",
+            )
         elif install_result.status == "success":
             click.secho("Server files installed successfully.", fg="green")
         else:
@@ -283,7 +286,7 @@ async def install(ctx):
 @click.option(
     "-s", "--server", "server_name", required=True, help="Name of the server to update."
 )
-@click.pass_context
+@pass_async_context
 async def update(ctx, server_name: str):
     """Checks for and applies updates to an existing Bedrock server."""
     client = ctx.obj.get("client")
@@ -294,7 +297,14 @@ async def update(ctx, server_name: str):
     click.echo(f"Checking for updates for server '{server_name}'...")
     try:
         response = await client.async_update_server(server_name)
-        if response.status == "success":
+        if response.task_id:
+            await monitor_task(
+                client,
+                response.task_id,
+                "Server update completed successfully",
+                "Failed to update server",
+            )
+        elif response.status == "success":
             click.secho("Update check complete.", fg="green")
         else:
             click.secho(f"Failed to update server: {response.message}", fg="red")
@@ -307,7 +317,7 @@ async def update(ctx, server_name: str):
     "-s", "--server", "server_name", required=True, help="Name of the server to delete."
 )
 @click.option("-y", "--yes", is_flag=True, help="Bypass the confirmation prompt.")
-@click.pass_context
+@pass_async_context
 async def delete_server(ctx, server_name: str, yes: bool):
     """Deletes all data for a server, including world, configs, and backups."""
     client = ctx.obj.get("client")
@@ -329,7 +339,14 @@ async def delete_server(ctx, server_name: str, yes: bool):
     click.echo(f"Proceeding with deletion of server '{server_name}'...")
     try:
         response = await client.async_delete_server(server_name)
-        if response.status == "success":
+        if response.task_id:
+            await monitor_task(
+                client,
+                response.task_id,
+                "Server deleted successfully",
+                "Failed to delete server",
+            )
+        elif response.status == "success":
             click.secho(
                 f"Server '{server_name}' and all its data have been deleted.",
                 fg="green",