hungerlib 2.0.4.dev0__tar.gz → 2.1.dev0__tar.gz

{hungerlib-2.0.4.dev0/src/hungerlib.egg-info → hungerlib-2.1.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hungerlib
-Version: 2.0.4.dev0
+Version: 2.1.dev0
 Summary: Powerful automation library for Pterodactyl.
 Author: iFamished
 License: MIT

{hungerlib-2.0.4.dev0 → hungerlib-2.1.dev0}/pyproject.toml

@@ -7,7 +7,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "hungerlib"
-version = "2.0.4-dev"
+version = "2.1-dev"
 description = "Powerful automation library for Pterodactyl."
 readme = "README.md"
 requires-python = ">=3.10"

hungerlib-2.1.dev0/src/hungerlib/config.py

@@ -0,0 +1,53 @@
+# =====================================
+#         CORE CONFIG SYSTEM
+# =====================================
+# The variables in this file can be used to control many things in Hungerlib's functions.
+# It helps keep track of constants and serves as an easy-to-use configuration system.
+
+from dataclasses import dataclass, field
+from pathlib import Path
+from hungerlib.addons.colormap import *
+from hungerlib.panel import Panel
+
+@dataclass
+class Config:
+    # panel defaults
+    panel_name: str | None = None
+    panel_url: str | None = None
+    panel_api_key: str | None = None
+    panel_headers: dict | None = None
+
+    # generic server defaults
+    gs_name: str | None = None
+    gs_panel_url: str | None = None
+    gs_panel_api_key: str | None = None
+    gs_server_id: str | None = None
+
+    # minecraft server defaults
+    mc_name: str | None = None
+    mc_panel_url: str | None = None
+    mc_panel_api_key: str | None = None
+    mc_server_id: str | None = None
+    mc_server_domain: str | None = None
+    mc_server_port: int = 25565
+    mc_rcon_port: int = 25575
+    mc_rcon_password: str | None = None
+    mc_tpsCommand: str = 'tt20 tps'
+
+    # Color maps
+    file_color_map: dict | None = None
+    origin_color_map: dict = field(default_factory=lambda: ASCI_COLOR_MAP.copy())
+    destination_color_map: dict = field(default_factory=lambda: ASCI_COLOR_MAP.copy())
+    mc_color_map: dict = field(default_factory=lambda: MC_COLOR_MAP.copy())
+
+    # Prefixes
+    info_prefix: str = '<white>[INFO]: '
+    warn_prefix: str = '<yellow>[WARN]: '
+    error_prefix: str = '<red>[ERROR]: '
+    console_backspaces: int = 8
+
+    log_path: Path = Path("/home/container/logs")
+    log_destination_method: str = 'rcon'
+
+# built-in default configuration
+DefaultConfig = Config()

{hungerlib-2.0.4.dev0 → hungerlib-2.1.dev0}/src/hungerlib/logger.py

@@ -16,7 +16,7 @@ class HungerLogger:
         self,
         loggerName,
         Config=DefaultConfig,
-        backspaces=0,
+        console_backspaces=0,
         logDir=None,
         server=None
     ):
@@ -26,7 +26,7 @@ class HungerLogger:
         If no Config class is defined, DefaultConfig is used.
         '''
         self.loggerName = loggerName
-        self.backspaces = '\b' * backspaces
+        self.console_backspaces = '\b' * console_backspaces
         self.config = Config
         self.server = server
 
@@ -79,9 +79,9 @@ class HungerLogger:
             return
         colored = self._apply_colors(msg, self.config.destination_color_map)
         if self.log_destination_method == 'rcon':
-            self.server._rcon_send(f'logtellraw targetless \"{self.backspaces}{colored}\"')
+            self.server._rcon_send(f'logtellraw targetless \"{self.console_backspaces}{colored}\"')
         if self.log_destination_method == 'api':
-            self.server.sendConsoleCommand(f'logtellraw targetless \"{self.backspaces}{colored}\"')
+            self.server.sendConsoleCommand(f'logtellraw targetless \"{self.console_backspaces}{colored}\"')
             
 
     def _log(self, level, msg, destination, origin, logs):

{hungerlib-2.0.4.dev0 → hungerlib-2.1.dev0}/src/hungerlib/panel.py

@@ -1,26 +1,23 @@
 import requests
 
+from hungerlib.api.command import CommandAPI
 from hungerlib.api.schedule import ScheduleAPI
 from hungerlib.api.filemanager import FileManagerAPI
 from hungerlib.api.backups import BackupsAPI
 from hungerlib.api.databases import DatabasesAPI
 from hungerlib.api.startup import StartupAPI
+from hungerlib.config import DefaultConfig
 
 
 class Panel:
-    """
-    High-level panel object.
-    Contains only:
-    - HTTP helpers
-    - authentication
-    - panel-wide utilities
-    - API module accessors
-    """
+    """High-level panel object"""
+    def __init__(self, name=None, url=None, api_key=None, Config=DefaultConfig):
+        self.Config = Config
 
-    def __init__(self, name, url, api_key):
-        self.name = name
-        self.url = url.rstrip("/")
-        self.api_key = api_key
+        # If Config is provided, use its defaults
+        self.name = name or Config.panel_name
+        self.url = (url or Config.panel_url).rstrip("/")
+        self.api_key = api_key or Config.panel_api_key 
 
         # API modules
         self.schedules = ScheduleAPI(self)
@@ -30,29 +27,28 @@ class Panel:
         self.startup = StartupAPI(self)
         self.commands = CommandAPI(self)
 
+
     def __str__(self):
         return f"Panel name: {self.name}\nURL: {self.url}\nAPI key: {self.api_key}"
 
-    # ------------------------------------------------------------
-    # HTTP CORE
-    # ------------------------------------------------------------
+    # http core
     @property
     def headers(self):
+        if self.Config and self.Config.panel_headers:
+            return self.Config.panel_headers
+
+
         return {
             "Authorization": f"Bearer {self.api_key}",
             "Accept": "application/json",
             "Content-Type": "application/json",
         }
-
     def get(self, path, timeout=5):
         return requests.get(f"{self.url}{path}", headers=self.headers, timeout=timeout)
-
     def post(self, path, json=None, timeout=5):
         return requests.post(f"{self.url}{path}", headers=self.headers, json=json, timeout=timeout)
-
     def delete(self, path, timeout=5):
         return requests.delete(f"{self.url}{path}", headers=self.headers, timeout=timeout)
-
     def patch(self, path, json=None, timeout=5):
         return requests.patch(f"{self.url}{path}", headers=self.headers, json=json, timeout=timeout)
 
@@ -64,16 +60,14 @@ class Panel:
             files=file_data
         )
 
-    # ------------------------------------------------------------
-    # PANEL HEALTH
-    # ------------------------------------------------------------
+
+    # panel health
     def ping(self):
         try:
             r = self.get("/api/client")
             return r.status_code == 200
         except:
             return False
-
     def validateAPI(self):
         r = self.get("/api/client/account")
         return r.status_code == 200

{hungerlib-2.0.4.dev0 → hungerlib-2.1.dev0}/src/hungerlib/servers/_generic.py

@@ -1,87 +1,74 @@
 # Universal server class
-import time
-import re
-import mcrcon
 from hungerlib.panel import Panel
-from hungerlib.config import Config
+from hungerlib.config import DefaultConfig
 
 
 class GenericServer:
     def __init__(
         self,
-        name,
-        panel: Panel,
-        server_id,
-        server_domain,
-        server_port,
-        rcon_port,
-        rcon_password,
-        Config: Config
+        name=None,
+        panel=None,
+        server_id=None,
+        Config=DefaultConfig
     ):
-        '''A universal server class'''
-        self.name = name
-        self.panel = panel
-        self.server_id = server_id
-        self.server_domain = server_domain
-        self.server_port = server_port
-        self.rcon_port = rcon_port
-        self.rcon_password = rcon_password
+        '''Generic server class'''
         self.Config = Config
-        self._cached_resources = None
 
-    # ============================================================
-    # INTERNAL HELPERS
-    # ============================================================
+        # name
+        self.name = name or Config.gs_name or "Unnamed Server"
+
+        # panel (must be explicit)
+        self.panel = panel
+        if not isinstance(self.panel, Panel):
+            raise TypeError("GenericServer requires a Panel instance")
+
+        # server_id (must be explicit or valid default)
+        self.server_id = server_id or Config.gs_server_id
+        if not isinstance(self.server_id, str):
+            raise TypeError("GenericServer requires a server_id string")
 
+        self._cached_resources = None
+
+    # internal helpers
     def _translate_mc_colors(self, msg):
         for tag, code in self.Config.mc_color_map.items():
             msg = msg.replace(tag, code)
         return msg
 
-    # ============================================================
-    # RESOURCE & STATUS
-    # ============================================================
-
+    # resource and status
     def refresh(self):
         r = self.panel.get(f"/api/client/servers/{self.server_id}/resources")
         self._cached_resources = r.json().get("attributes", {}).get("resources", {})
         return self._cached_resources
-
     def resources(self):
         return self._cached_resources or self.refresh()
-
     def getRAM(self, rounding=2, gb=False):
         mem = self.resources().get("memory_bytes")
         if mem is None:
             return None
         div = 1024 * 1024 * (1024 if gb else 1)
         return round(mem / div, rounding)
-
     def getCPU(self, rounding=2):
         cpu = self.resources().get("cpu_absolute")
         return round(cpu, rounding) if cpu is not None else None
-
     def getDisk(self, rounding=2, gb=False):
         disk = self.resources().get("disk_bytes")
         if disk is None:
             return None
         div = 1024 * 1024 * (1024 if gb else 1)
         return round(disk / div, rounding)
-
     def getNetworkIn(self, rounding=2, gb=False):
         rx = self.resources().get("network_rx_bytes")
         if rx is None:
             return None
         div = 1024 * 1024 * (1024 if gb else 1)
         return round(rx / div, rounding)
-
     def getNetworkOut(self, rounding=2, gb=False):
         tx = self.resources().get("network_tx_bytes")
         if tx is None:
             return None
         div = 1024 * 1024 * (1024 if gb else 1)
         return round(tx / div, rounding)
-
     def getUptime(self, formatted=False):
         uptime = self.resources().get("uptime")
         if uptime is None:
@@ -98,25 +85,19 @@ class GenericServer:
             return f"{minutes}m {secs}s"
         else:
             return f"{secs}s"
-
     def getStatus(self):
         r = self.panel.get(f"/api/client/servers/{self.server_id}/resources")
         return r.json().get("attributes", {}).get("current_state")
 
-    # ============================================================
-    # STATE HELPERS
-    # ============================================================
 
+    # state helpers
     def isOnline(self):
         return self.getStatus() == "running"
-
     def isOffline(self):
         return self.getStatus() == "offline"
 
-    # ============================================================
-    # POWER ACTIONS
-    # ============================================================
 
+    # power actions
     def powerAction(self, action):
         valid = {"start", "restart", "stop", "kill"}
         if action not in valid:
@@ -124,111 +105,78 @@ class GenericServer:
         payload = {"signal": action}
         r = self.panel.post(f"/api/client/servers/{self.server_id}/power", json=payload)
         return r.status_code, r.text
-
     def start(self): return self.powerAction("start")
     def restart(self): return self.powerAction("restart")
     def stop(self): return self.powerAction("stop")
     def kill(self): return self.powerAction("kill")
 
-    # ============================================================
-    # FILE MANAGER
-    # ============================================================
 
+    # file manager
     def listFiles(self, directory="/"):
         return self.panel.files.list(self.server_id, directory)
-
     def downloadFile(self, path):
         return self.panel.files.download(self.server_id, path)
-
     def uploadFile(self, directory, file_data):
         return self.panel.files.upload(self.server_id, directory, file_data)
-
     def deleteFiles(self, root, files):
         return self.panel.files.delete(self.server_id, root, files)
-
     def renameFiles(self, root, files):
         return self.panel.files.rename(self.server_id, root, files)
-
     def copyFiles(self, root, files):
         return self.panel.files.copy(self.server_id, root, files)
-
     def moveFiles(self, root, files):
         return self.panel.files.move(self.server_id, root, files)
-
     def createFolder(self, directory, name):
         return self.panel.files.create_folder(self.server_id, directory, name)
-
     def compress(self, root, files):
         return self.panel.files.compress(self.server_id, root, files)
-
     def decompress(self, file_path):
         return self.panel.files.decompress(self.server_id, file_path)
 
-    # ============================================================
-    # BACKUPS
-    # ============================================================
 
+    # backup manager
     def listBackups(self):
         return self.panel.backups.list(self.server_id)
-
     def createBackup(self, name="Auto Backup"):
         return self.panel.backups.create(self.server_id, name)
-
     def deleteBackup(self, backup_id):
         return self.panel.backups.delete(self.server_id, backup_id)
-
     def downloadBackup(self, backup_id):
         return self.panel.backups.download(self.server_id, backup_id)
 
-    # ============================================================
-    # DATABASES
-    # ============================================================
 
+    # database manager
     def listDatabases(self):
         return self.panel.databases.list(self.server_id)
-
     def createDatabase(self, name, remote="%", host=None):
         return self.panel.databases.create(self.server_id, name, remote, host)
-
     def rotateDatabasePassword(self, db_id):
         return self.panel.databases.rotate_password(self.server_id, db_id)
-
     def deleteDatabase(self, db_id):
         return self.panel.databases.delete(self.server_id, db_id)
 
-    # ============================================================
-    # STARTUP VARIABLES
-    # ============================================================
 
+    # startup variables
     def getStartupVariables(self):
         return self.panel.startup.list(self.server_id)
-
     def updateStartupVariable(self, key, value):
         return self.panel.startup.update(self.server_id, key, value)
 
-    # ============================================================
-    # SCHEDULES
-    # ============================================================
 
+    # schedules
     def listSchedules(self):
         return self.panel.schedules.list(self.server_id)
-
     def createSchedule(self, payload):
         return self.panel.schedules.create(self.server_id, payload)
-
     def updateSchedule(self, schedule_id, payload):
         return self.panel.schedules.update(self.server_id, schedule_id, payload)
-
     def deleteSchedule(self, schedule_id):
         return self.panel.schedules.delete(self.server_id, schedule_id)
-
     def runSchedule(self, schedule_id):
         return self.panel.schedules.run(self.server_id, schedule_id)
 
-    # ============================================================
-    # HEALTH SNAPSHOT
-    # ============================================================
 
+    # health snapshot
     def snapshot(self):
         return {
             "ram": self.getRAM(),

{hungerlib-2.0.4.dev0 → hungerlib-2.1.dev0}/src/hungerlib/servers/minecraft.py

@@ -3,44 +3,37 @@ import time
 import re
 import mcrcon
 from hungerlib.panel import Panel
-from hungerlib.config import Config
+from hungerlib.config import DefaultConfig
 from hungerlib.servers._generic import GenericServer
 
 
 class MinecraftServer(GenericServer):
     def __init__(
         self,
-        name,
-        panel,
-        server_id,
-        server_domain,
-        server_port,
-        Config,
+        name=None,
+        panel=None,
+        server_id=None,
+        server_domain=None,
+        server_port=None,
         rcon_port=None,
         rcon_password=None,
-        tpsCommand='ticks'
+        tpsCommand=None,
+        Config=DefaultConfig
     ):
-        '''
-        A highly configurable server class for Minecraft servers.
-        Supports Rcon.
-        '''
-        super().__init__(
-            name,
-            panel,
-            server_id,
-            server_domain,
-            server_port,
-            rcon_port,
-            rcon_password,
-            Config
-        )
-        self.tpsCommand = tpsCommand
+        super().__init__(name, panel, server_id, Config)
 
-    # ============================================================
-    # RCON HANDLER
-    # ============================================================
+        self.server_domain = server_domain or Config.mc_server_domain
+        self.server_port = server_port or Config.mc_server_port
+        self.rcon_port = rcon_port or Config.mc_rcon_port
+        self.rcon_password = rcon_password or Config.mc_rcon_password
+        self.tpsCommand = tpsCommand or Config.mc_tpsCommand
 
+
+
+    # rcon handler
     def _rcon_send(self, command):
+        if not self.server_domain or not self.rcon_password:
+            return None
         try:
             with mcrcon.MCRcon(self.server_domain, self.rcon_password, port=self.rcon_port) as m:
                 resp1 = m.command(command)
@@ -51,21 +44,13 @@ class MinecraftServer(GenericServer):
             print("RCON error:", e)
             return None
 
-    # ============================================================
-    # PLAYERS
-    # ============================================================
-
+    # getter methods
     def getPlayers(self):
         output = self._rcon_send("list")
         if not output:
             return None
         m = re.search(r"There are (\d+)", output)
         return int(m.group(1)) if m else None
-
-    # ============================================================
-    # TPS PARSER
-    # ============================================================
-
     def getTPS(self, type="raw", rounding=10):
         '''
         This has limitations and is not yet complete. It currently ONLY parses TT20's tps command.
@@ -82,20 +67,15 @@ class MinecraftServer(GenericServer):
         )
         if not m:
             return None
-
         raw, avg, acc = map(float, m.groups())
         table = {"raw": raw, "avg": avg, "acc": acc}
         value = table.get(type, avg)
-
         return round(value, rounding) if rounding else value
 
-    # ============================================================
-    # COMMANDS
-    # ============================================================
 
+    # commands
     def sendConsoleCommand(self, command):
         return self.panel.commands.send(self.server_id, command)
-
     def sendBroadcast(self, message):
         translated = self._translate_mc_colors(message)
         safe = translated.replace('"', '\\"')

{hungerlib-2.0.4.dev0 → hungerlib-2.1.dev0/src/hungerlib.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hungerlib
-Version: 2.0.4.dev0
+Version: 2.1.dev0
 Summary: Powerful automation library for Pterodactyl.
 Author: iFamished
 License: MIT

hungerlib-2.0.4.dev0/src/hungerlib/config.py

@@ -1,22 +0,0 @@
-# HungerLib's core config system
-
-from dataclasses import dataclass, field
-from pathlib import Path
-from hungerlib.addons.colormap import *
-
-@dataclass
-class Config:
-    file_color_map: dict | None = None
-    origin_color_map: dict = field(default_factory=lambda: ASCI_COLOR_MAP.copy())
-    destination_color_map: dict = field(default_factory=lambda: ASCI_COLOR_MAP.copy())
-    mc_color_map: dict = field(default_factory=lambda: MC_COLOR_MAP.copy())
-
-    info_prefix: str = '<white>[INFO]: '
-    warn_prefix: str = '<yellow>[WARN]: '
-    error_prefix: str = '<red>[ERROR]: '
-    backspaces: int = 8
-
-    log_path: Path = Path("/home/container/logs")
-    log_destination_method: str = 'rcon'
-
-DefaultConfig = Config()