bsm-api-client 1.0.0__tar.gz

bsm_api_client-1.0.0/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_api_client-1.0.0/PKG-INFO

@@ -0,0 +1,127 @@
+Metadata-Version: 2.4
+Name: bsm-api-client
+Version: 1.0.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
+Project-URL: Bug Tracker, https://github.com/DMedina559/bsm-api-client/issues
+Project-URL: Changelog, https://github.com/DMedina559/bsm-api-client/blob/main/docs/CHANGELOG.md
+Keywords: minecraft,bedrock,server,manager,api,client,asyncio,aiohttp,bsm
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Framework :: AsyncIO
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp<4.0.0,>=3.8.0
+Dynamic: license-file
+
+<div style="text-align: center;">
+    <img src="https://raw.githubusercontent.com/dmedina559/bedrock-server-manager/main/bedrock_server_manager/web/static/image/icon/favicon.svg" alt="BSM Logo" width="150">
+</div>
+
+# bsm-api-client
+
+[![PyPI version](https://img.shields.io/pypi/v/bsm-api-client.svg)](https://pypi.org/project/bsm-api-client/)
+[![Python Versions](https://img.shields.io/pypi/pyversions/bsm_api_client.svg)](https://pypi.org/project/bsm-api-client/)
+[![License](https://img.shields.io/pypi/l/bsm-api-client.svg)](https://github.com/dmedina559/bsm-api-client/blob/main/LICENSE)
+
+## Introduction
+
+`bsm-api-client` is an asynchronous Python client library for interacting with the Bedrock Server Manager API. It provides a convenient way to manage Minecraft Bedrock Dedicated Servers through the manager's HTTP API.
+
+## Features
+
+*   Fully asynchronous using `asyncio` and `aiohttp`.
+*   Context manager support for session management.
+*   Handles authentication (JWT) automatically, including token refresh attempts.
+*   Provides methods for most BSM API endpoints:
+    *   Manager Information & Global Actions
+    *   Server Listing, Status & Configuration
+    *   Server Actions (Start, Stop, Command, Update, etc.)
+    *   Content Management (Backups, Worlds, Addons)
+    *   OS-specific Task Scheduling (Cron for Linux, Task Scheduler for Windows)
+*   Custom exceptions for specific API errors, providing context like status codes and API messages.
+*   Supports connecting via HTTP or HTTPS.
+
+## Installation
+
+Install the library using pip:
+
+```bash
+pip install bsm-api-client
+```
+
+## Quick Start
+
+Here's a basic example of how to initialize the client and fetch server information:
+
+For a complete list of endpoints and examples, see [API_DOCS.md](https://github.com/DMedina559/bsm-api-client/blob/main/docs/API_DOCS.md)
+
+```python
+import asyncio
+from bsm_api_client import BedrockServerManagerApi, APIError, CannotConnectError
+
+async def main():
+    client = BedrockServerManagerApi(
+        host="host",                   # e.g., "127.0.0.1" or "bsm.example.internal"
+        username="username",           # Username for BSM login
+        password="password",           # Password for BSM login
+        port=11325,                    # Optional: Not required for example if using domain such as bsm.example.internal
+        use_ssl=False                  # Set to True if your manager uses HTTPS
+        verify_ssl=True                # Set to False if using HTTPS with a self-signed cert
+    )
+
+    try:
+        async with client: # Handles session and token management
+            # Get manager info (no auth needed for this specific call, but client handles it)
+            manager_info = await client.async_get_info()
+            print(f"Manager OS: {manager_info.get('data', {}).get('os_type')}, Version: {manager_info.get('data', {}).get('app_version')}")
+
+            # Get list of all servers
+            servers = await client.async_get_servers_details()
+            if servers:
+                print("\nManaged Servers:")
+                for server in servers:
+                    print(f"  - Name: {server['name']}, Status: {server['status']}, Version: {server['version']}")
+            else:
+                print("No servers found.")
+
+            # Example: Start a specific server (replace 'MyServer' with an actual server name)
+            # server_name_to_start = "MyServer"
+            # if any(s['name'] == server_name_to_start for s in servers):
+            #     print(f"\nAttempting to start server: {server_name_to_start}")
+            #     start_response = await client.async_start_server(server_name_to_start)
+            #     print(f"Start response: {start_response.get('message')}")
+            # else:
+            #     print(f"\nServer '{server_name_to_start}' not found, cannot start.")
+
+    except AuthError as e:
+        print(f"Authentication Error: {e}")
+    except ServerNotFoundError as e:
+        print(f"Server Not Found Error: {e}")
+    except APIError as e:
+        print(f"An API Error occurred: {e}")
+        print(f"  Status Code: {e.status_code}")
+        print(f"  API Message: {e.api_message}")
+        print(f"  API Errors: {e.api_errors}")
+    except CannotConnectError as e:
+        print(f"Connection Error: {e}")
+    except ValueError as e:
+        print(f"Input Error: {e}")
+    finally:
+        # The `async with client:` block handles closing the session.
+        # If not using context manager, you would call:
+        # await client.close()
+        pass
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```

bsm_api_client-1.0.0/README.md

@@ -0,0 +1,102 @@
+<div style="text-align: center;">
+    <img src="https://raw.githubusercontent.com/dmedina559/bedrock-server-manager/main/bedrock_server_manager/web/static/image/icon/favicon.svg" alt="BSM Logo" width="150">
+</div>
+
+# bsm-api-client
+
+[![PyPI version](https://img.shields.io/pypi/v/bsm-api-client.svg)](https://pypi.org/project/bsm-api-client/)
+[![Python Versions](https://img.shields.io/pypi/pyversions/bsm_api_client.svg)](https://pypi.org/project/bsm-api-client/)
+[![License](https://img.shields.io/pypi/l/bsm-api-client.svg)](https://github.com/dmedina559/bsm-api-client/blob/main/LICENSE)
+
+## Introduction
+
+`bsm-api-client` is an asynchronous Python client library for interacting with the Bedrock Server Manager API. It provides a convenient way to manage Minecraft Bedrock Dedicated Servers through the manager's HTTP API.
+
+## Features
+
+*   Fully asynchronous using `asyncio` and `aiohttp`.
+*   Context manager support for session management.
+*   Handles authentication (JWT) automatically, including token refresh attempts.
+*   Provides methods for most BSM API endpoints:
+    *   Manager Information & Global Actions
+    *   Server Listing, Status & Configuration
+    *   Server Actions (Start, Stop, Command, Update, etc.)
+    *   Content Management (Backups, Worlds, Addons)
+    *   OS-specific Task Scheduling (Cron for Linux, Task Scheduler for Windows)
+*   Custom exceptions for specific API errors, providing context like status codes and API messages.
+*   Supports connecting via HTTP or HTTPS.
+
+## Installation
+
+Install the library using pip:
+
+```bash
+pip install bsm-api-client
+```
+
+## Quick Start
+
+Here's a basic example of how to initialize the client and fetch server information:
+
+For a complete list of endpoints and examples, see [API_DOCS.md](https://github.com/DMedina559/bsm-api-client/blob/main/docs/API_DOCS.md)
+
+```python
+import asyncio
+from bsm_api_client import BedrockServerManagerApi, APIError, CannotConnectError
+
+async def main():
+    client = BedrockServerManagerApi(
+        host="host",                   # e.g., "127.0.0.1" or "bsm.example.internal"
+        username="username",           # Username for BSM login
+        password="password",           # Password for BSM login
+        port=11325,                    # Optional: Not required for example if using domain such as bsm.example.internal
+        use_ssl=False                  # Set to True if your manager uses HTTPS
+        verify_ssl=True                # Set to False if using HTTPS with a self-signed cert
+    )
+
+    try:
+        async with client: # Handles session and token management
+            # Get manager info (no auth needed for this specific call, but client handles it)
+            manager_info = await client.async_get_info()
+            print(f"Manager OS: {manager_info.get('data', {}).get('os_type')}, Version: {manager_info.get('data', {}).get('app_version')}")
+
+            # Get list of all servers
+            servers = await client.async_get_servers_details()
+            if servers:
+                print("\nManaged Servers:")
+                for server in servers:
+                    print(f"  - Name: {server['name']}, Status: {server['status']}, Version: {server['version']}")
+            else:
+                print("No servers found.")
+
+            # Example: Start a specific server (replace 'MyServer' with an actual server name)
+            # server_name_to_start = "MyServer"
+            # if any(s['name'] == server_name_to_start for s in servers):
+            #     print(f"\nAttempting to start server: {server_name_to_start}")
+            #     start_response = await client.async_start_server(server_name_to_start)
+            #     print(f"Start response: {start_response.get('message')}")
+            # else:
+            #     print(f"\nServer '{server_name_to_start}' not found, cannot start.")
+
+    except AuthError as e:
+        print(f"Authentication Error: {e}")
+    except ServerNotFoundError as e:
+        print(f"Server Not Found Error: {e}")
+    except APIError as e:
+        print(f"An API Error occurred: {e}")
+        print(f"  Status Code: {e.status_code}")
+        print(f"  API Message: {e.api_message}")
+        print(f"  API Errors: {e.api_errors}")
+    except CannotConnectError as e:
+        print(f"Connection Error: {e}")
+    except ValueError as e:
+        print(f"Input Error: {e}")
+    finally:
+        # The `async with client:` block handles closing the session.
+        # If not using context manager, you would call:
+        # await client.close()
+        pass
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```

bsm_api_client-1.0.0/pyproject.toml

@@ -0,0 +1,40 @@
+# pyproject.toml
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "bsm-api-client"
+version = "1.0.0"
+authors = [
+    { name="DMedina559", email="dmedina559-github@outlook.com" },
+]
+description = "A Python client library for the Bedrock Server Manager API"
+readme = "README.md"
+license-files = ["LICENSE"]
+requires-python = ">=3.8"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Operating System :: OS Independent",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Framework :: AsyncIO",
+]
+dependencies = [
+    "aiohttp>=3.8.0,<4.0.0",
+]
+keywords = ["minecraft", "bedrock", "server", "manager", "api", "client", "asyncio", "aiohttp", "bsm"]
+
+[tool.setuptools.packages.find]
+where = ["src"] 
+include = ["bsm_api_client*"]
+
+[project.urls]
+"Homepage" = "https://github.com/DMedina559/bsm-api-client"
+"Bug Tracker" = "https://github.com/DMedina559/bsm-api-client/issues"
+"Changelog" = "https://github.com/DMedina559/bsm-api-client/blob/main/docs/CHANGELOG.md"

bsm_api_client-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

bsm_api_client-1.0.0/src/bsm_api_client/__init__.py

@@ -0,0 +1,40 @@
+# src/bsm_api_client/__init__.py
+"""Python client library for the Bedrock Server Manager API."""
+import logging
+from importlib import metadata
+
+from .exceptions import (
+    APIError,
+    AuthError,
+    NotFoundError,
+    ServerNotFoundError,
+    ServerNotRunningError,
+    CannotConnectError,
+    InvalidInputError,
+    OperationFailedError,
+    APIServerSideError,
+)
+from .api_client import BedrockServerManagerApi
+
+__all__ = [
+    "BedrockServerManagerApi",
+    "APIError",
+    "AuthError",
+    "ServerNotFoundError",
+    "ServerNotRunningError",
+    "CannotConnectError",
+    "InvalidInputError",
+    "OperationFailedError",
+    "APIServerSideError",
+    "__version__",
+]
+
+try:
+    __version__ = metadata.version(__name__)
+except metadata.PackageNotFoundError:
+    __version__ = "0.0.0"
+
+# Add a NullHandler to the root logger of the library.
+# This prevents log messages from being output by default if the
+# consuming application/script doesn't configure logging.
+logging.getLogger(__name__).addHandler(logging.NullHandler())

bsm_api_client-1.0.0/src/bsm_api_client/api_client.py

@@ -0,0 +1,33 @@
+# src/bsm_api_client/client.py
+"""Main API client class for Bedrock Server Manager.
+Combines the base client logic with specific endpoint method mixins.
+"""
+import logging
+from .client_base import ClientBase
+from .client._manager_methods import ManagerMethodsMixin
+from .client._server_info_methods import ServerInfoMethodsMixin
+from .client._server_action_methods import ServerActionMethodsMixin
+from .client._content_methods import ContentMethodsMixin
+from .client._scheduler_methods import SchedulerMethodsMixin
+
+_LOGGER = logging.getLogger(__name__.split(".")[0] + ".client")
+
+
+class BedrockServerManagerApi(
+    ClientBase,
+    ManagerMethodsMixin,
+    ServerInfoMethodsMixin,
+    ServerActionMethodsMixin,
+    ContentMethodsMixin,
+    SchedulerMethodsMixin,
+):
+    """
+    API Client for the Bedrock Server Manager.
+
+    This class combines the base connection/authentication logic with
+    methods for interacting with various API endpoints, organized via mixins.
+    """
+
+    # __init__ is inherited from ClientBase.
+    # All async API methods are inherited from mixins.
+    pass

bsm_api_client-1.0.0/src/bsm_api_client/client/__init__.py

@@ -0,0 +1 @@
+# src/bsm_api_client/client/__init__.py