warlock-manager 2.1.2__tar.gz → 2.2.0__tar.gz

{warlock_manager-2.1.2 → warlock_manager-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: warlock-manager
-Version: 2.1.2
+Version: 2.2.0
 Summary: Dependency library for game-server management applications.
 Author-email: Charlie Powell <cdp1337@bitsnbytes.dev>
 Maintainer-email: Charlie Powell <cdp1337@bitsnbytes.dev>
@@ -23,19 +23,20 @@ Classifier: Topic :: System :: Systems Administration
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: requests>=2.28
+Requires-Dist: requests>=2.33.1
 Requires-Dist: pyyaml>=6.0
 Requires-Dist: typer>=0.24.1
 Requires-Dist: rcon>=2.4.9
-Requires-Dist: typing_extensions>=4.9.0
+Requires-Dist: typing_extensions>=4.15.0
 Requires-Dist: systemdunitparser>=0.4
-Requires-Dist: packaging>=23.3
+Requires-Dist: packaging>=26.1
 Requires-Dist: psutil>=7.2.0
 Provides-Extra: dev
 Requires-Dist: pytest>=9; extra == "dev"
 Requires-Dist: flake8>=7.3.0; extra == "dev"
 Requires-Dist: pre-commit>=4.5.1; extra == "dev"
 Requires-Dist: pytest-cov>=7.0; extra == "dev"
+Requires-Dist: pydoc-markdown>=4.8.0; extra == "dev"
 Dynamic: license-file
 
 # Warlock Manager
@@ -44,7 +45,8 @@ Dynamic: license-file
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/warlock-manager)
 [![PyPI - Version](https://img.shields.io/pypi/v/warlock-manager)](https://pypi.org/project/warlock-manager/)
 
-Warlock Manager is a robust, extensible Python library for building game server management applications. It provides a comprehensive foundation for managing game applications, services, configurations, and server communications.
+Warlock Manager is a robust, extensible Python library for building game server management applications. 
+It provides a comprehensive foundation for managing game applications, services, configurations, and server communications.
 
 This is meant to be used with the [Warlock Game Manager](https://warlock.nexus) ([Github Repo](https://github.com/BitsNBytes25/Warlock)),
 but can be used independently.
@@ -66,6 +68,18 @@ Warlock Manager abstracts common game server management tasks, allowing you to b
 
 ### Core Components
 
+In this system, a game is defined as an 'Application' or 'App'.
+This management library is meant to manage one single app to allow it be extended
+to meet the requirements of that specific game.
+
+A map or instance of the game is defined as a 'Service'.
+Each service runs a single instance of the game executable.
+
+An app will have one or more services, based on the game.
+Some games support multiple services from a single game installation,
+some support multiple services from multiple binaries,
+and some only support a single instance.
+
 - **BaseApp**: Abstract base for game application managers
   - Multi-service instance support
   - Service lifecycle management
@@ -93,6 +107,10 @@ Warlock Manager abstracts common game server management tasks, allowing you to b
   - `RconService`: RCON protocol support
   - `SocketService`: Unix socket-based communication
 
+- **Mod Support**:
+  - `BaseMod`: Baseline mod class for basic functionality and skeleton structure
+  - `WarlockNexusMod`: Support for pulling mod metadata from hosted [Warlock.Nexus](https://warlock.nexus)
+
 ### Utilities
 
 - **CLI Framework**: Built on Typer for robust command-line interfaces
@@ -102,6 +120,27 @@ Warlock Manager abstracts common game server management tasks, allowing you to b
 - **Port Management**: Port discovery, allocation, and validation
 - **Data Filtering**: Sensitive data masking for safe logging
 
+### Default Features
+
+This library automatically provides commands for:
+
+- Service management (start, stop, restart, status)
+- Configuration management (get, set)
+- Port discovery and management
+- Metrics collection
+- Backup and restore operations
+- First-run setup
+
+
+Additionally, the included TUI application as provided by app provides an interactive menu system for:
+
+This provides an interactive menu system for:
+- Viewing service status and metrics
+- Managing service configurations
+- Controlling service lifecycle
+- Backup and data management
+- Creating new service instances
+
 ## Installation
 
 Install as a dependency in your project:
@@ -115,19 +154,19 @@ Or add to your `pyproject.toml`:
 ```toml
 [project]
 dependencies = [
-    "warlock-manager>=2.1.0",
+    "warlock-manager>=2.2.0",
 ]
 ```
 
 Or to your `requirements.txt`:
 
 ```
-warlock-manager>=2.1.0
+warlock-manager>=2.2.0
 ```
 
 ## Requirements
 
-- Python 3.10+
+- Python 3.10+ (3.11+ recommended)
 - Dependencies:
   - `requests>=2.28` - HTTP client library
   - `pyyaml>=6.0` - YAML parsing
@@ -139,96 +178,11 @@ warlock-manager>=2.1.0
 
 ## Quick Start
 
-### Creating a Game Manager
-
-For more detailed examples, check out the [Warlock Game Template](https://github.com/BitsNBytes25/Warlock-Game-Template)
+For detailed examples, check out the [Warlock Game Template](https://github.com/BitsNBytes25/Warlock-Game-Template)
 repository for a templated project you can fork and customize to quickly get started.
 
-Extend `BaseApp` to create a manager for your game:
-
-```python
-from warlock_manager.apps import BaseApp
-from warlock_manager.services import BaseService
-
-class MyGameApp(BaseApp):
-    def __init__(self):
-        super().__init__()
-        self.name = 'mygame'
-        self.desc = 'My Game Server'
-        self.service_prefix = 'mygame-'
-        
-    def get_app_directory(self) -> str:
-        return '/var/games/mygame'
-    
-    def detect_services(self) -> list:
-        # Detect existing game services
-        return []
-    
-    def create_service(self, name: str) -> BaseService:
-        # Create and return a new service instance
-        pass
-```
-
-### Creating a Game Service Handler
-
-Extend `BaseService` to implement service-specific logic:
-
-```python
-from warlock_manager.services import BaseService
-from warlock_manager.config import IniConfig
-
-class MyGameService(BaseService):
-    def __init__(self, service: str, game: BaseApp):
-        super().__init__(service, game)
-        
-        # Configure configuration files
-        self.configs['game_config'] = IniConfig(
-            '/var/games/mygame/game.ini'
-        )
-    
-    def get_port_definitions(self) -> list:
-        # Return list of port definitions: (port_number_or_config_key, 'tcp'/'udp', description)
-        return [
-            ('game_port', 'tcp', 'Game Server Port'),
-            ('query_port', 'udp', 'Query Port'),
-        ]
-    
-    def is_running(self) -> bool:
-        # Check if service is running
-        pass
-```
-
-### Building a CLI Application
-
-Use the built-in CLI framework:
-
-```python
-from warlock_manager.libs.app_runner import app_runner
-
-game = MyGameApp()
-cli_app = app_runner(game)
-
-if __name__ == '__main__':
-    cli_app()
-```
-
-This automatically provides commands for:
-- Service management (start, stop, restart, status)
-- Configuration management (get, set)
-- Port discovery and management
-- Metrics collection
-- Backup and restore operations
-- First-run setup
-
-
-Additionally, the included TUI application as provided by app provides an interactive menu system for:
-
-This provides an interactive menu system for:
-- Viewing service status and metrics
-- Managing service configurations
-- Controlling service lifecycle
-- Backup and data management
-- Creating new service instances
+Also check out the games listed as supported at [Warlock.Nexus](https://warlock.nexus) 
+to browse their source repos for more real-world implementations.
 
 ## Configuration
 
@@ -260,33 +214,6 @@ mygame:
     group: Network
 ```
 
-## Features System
-
-Control available functionality through the features system:
-
-```python
-class MyGameApp(BaseApp):
-    def __init__(self):
-        super().__init__()
-        
-        # Available features
-        self.features = {
-            'api',              # Server API support
-            'cmd',              # Command execution via API
-            'create_service',   # Create new service instances
-            'mods',             # Mod support
-        }
-        
-        # Disable specific features
-        self.disabled_features = {'mods'}
-```
-
-Available features:
-- `api` - Server API communication support
-- `cmd` - Command execution capabilities
-- `create_service` - Ability to create new service instances
-- `mods` - Mod/plugin support
-
 ## Development
 
 ### Setting Up Development Environment
@@ -304,6 +231,14 @@ source venv/bin/activate
 pip install -e ".[dev]"
 ```
 
+### Generating Documentation
+
+Documentation is generated using [pydoc-markdown](https://github.com/NiklasRosenstein/pydoc-markdown).
+
+```bash
+pydoc-markdown
+```
+
 ### Running Tests
 
 ```bash
@@ -324,55 +259,6 @@ Run linting checks:
 flake8 warlock_manager tests
 ```
 
-## API Reference
-
-### BaseApp
-
-Main application class for game server management.
-
-**Key Methods:**
-- `detect_services()`: Discover existing service instances
-- `create_service(name)`: Create a new service instance
-- `get_services()`: Get list of service instances
-- `get_options()`: Get application-level configuration options
-- `get_option_value(key)`: Get a configuration option value
-- `set_option(key, value)`: Set a configuration option
-- `start_all()`: Start all service instances
-- `stop_all()`: Stop all service instances
-- `is_active()`: Check if any service is running
-- `update()`: Update the application/game
-
-### BaseService
-
-Service instance handler for individual game servers.
-
-**Key Methods:**
-- `load()`: Load service configuration files
-- `get_options()`: Get service configuration options
-- `get_option_value(key)`: Get a configuration option
-- `set_option(key, value)`: Set a configuration option
-- `start()`: Start the service
-- `stop()`: Stop the service
-- `restart()`: Restart the service
-- `is_running()`: Check if service is running
-- `get_port()`: Get service's primary port
-- `get_ports()`: Get all port definitions
-- `is_enabled()`: Check if auto-start is enabled
-- `cmd(command)`: Send command to service
-- `get_player_count()`: Get current player count
-- `get_player_max()`: Get max player capacity
-- `backup()`: Create backup of service data
-- `restore(backup_path)`: Restore from backup
-
-### Configuration Classes
-
-All configuration classes extend `BaseConfig` and provide:
-- `load()`: Load configuration from file
-- `save()`: Save configuration to file
-- `get_option_value(key)`: Get option value
-- `set_option_value(key, value)`: Set option value
-- `exists()`: Check if configuration file exists
-
 ## License
 
 This project is licensed under the GNU Affero General Public License v3.0 or later - see the [LICENSE](LICENSE) file for details.

{warlock_manager-2.1.2 → warlock_manager-2.2.0}/README.md

@@ -4,7 +4,8 @@
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/warlock-manager)
 [![PyPI - Version](https://img.shields.io/pypi/v/warlock-manager)](https://pypi.org/project/warlock-manager/)
 
-Warlock Manager is a robust, extensible Python library for building game server management applications. It provides a comprehensive foundation for managing game applications, services, configurations, and server communications.
+Warlock Manager is a robust, extensible Python library for building game server management applications. 
+It provides a comprehensive foundation for managing game applications, services, configurations, and server communications.
 
 This is meant to be used with the [Warlock Game Manager](https://warlock.nexus) ([Github Repo](https://github.com/BitsNBytes25/Warlock)),
 but can be used independently.
@@ -26,6 +27,18 @@ Warlock Manager abstracts common game server management tasks, allowing you to b
 
 ### Core Components
 
+In this system, a game is defined as an 'Application' or 'App'.
+This management library is meant to manage one single app to allow it be extended
+to meet the requirements of that specific game.
+
+A map or instance of the game is defined as a 'Service'.
+Each service runs a single instance of the game executable.
+
+An app will have one or more services, based on the game.
+Some games support multiple services from a single game installation,
+some support multiple services from multiple binaries,
+and some only support a single instance.
+
 - **BaseApp**: Abstract base for game application managers
   - Multi-service instance support
   - Service lifecycle management
@@ -53,6 +66,10 @@ Warlock Manager abstracts common game server management tasks, allowing you to b
   - `RconService`: RCON protocol support
   - `SocketService`: Unix socket-based communication
 
+- **Mod Support**:
+  - `BaseMod`: Baseline mod class for basic functionality and skeleton structure
+  - `WarlockNexusMod`: Support for pulling mod metadata from hosted [Warlock.Nexus](https://warlock.nexus)
+
 ### Utilities
 
 - **CLI Framework**: Built on Typer for robust command-line interfaces
@@ -62,6 +79,27 @@ Warlock Manager abstracts common game server management tasks, allowing you to b
 - **Port Management**: Port discovery, allocation, and validation
 - **Data Filtering**: Sensitive data masking for safe logging
 
+### Default Features
+
+This library automatically provides commands for:
+
+- Service management (start, stop, restart, status)
+- Configuration management (get, set)
+- Port discovery and management
+- Metrics collection
+- Backup and restore operations
+- First-run setup
+
+
+Additionally, the included TUI application as provided by app provides an interactive menu system for:
+
+This provides an interactive menu system for:
+- Viewing service status and metrics
+- Managing service configurations
+- Controlling service lifecycle
+- Backup and data management
+- Creating new service instances
+
 ## Installation
 
 Install as a dependency in your project:
@@ -75,19 +113,19 @@ Or add to your `pyproject.toml`:
 ```toml
 [project]
 dependencies = [
-    "warlock-manager>=2.1.0",
+    "warlock-manager>=2.2.0",
 ]
 ```
 
 Or to your `requirements.txt`:
 
 ```
-warlock-manager>=2.1.0
+warlock-manager>=2.2.0
 ```
 
 ## Requirements
 
-- Python 3.10+
+- Python 3.10+ (3.11+ recommended)
 - Dependencies:
   - `requests>=2.28` - HTTP client library
   - `pyyaml>=6.0` - YAML parsing
@@ -99,96 +137,11 @@ warlock-manager>=2.1.0
 
 ## Quick Start
 
-### Creating a Game Manager
-
-For more detailed examples, check out the [Warlock Game Template](https://github.com/BitsNBytes25/Warlock-Game-Template)
+For detailed examples, check out the [Warlock Game Template](https://github.com/BitsNBytes25/Warlock-Game-Template)
 repository for a templated project you can fork and customize to quickly get started.
 
-Extend `BaseApp` to create a manager for your game:
-
-```python
-from warlock_manager.apps import BaseApp
-from warlock_manager.services import BaseService
-
-class MyGameApp(BaseApp):
-    def __init__(self):
-        super().__init__()
-        self.name = 'mygame'
-        self.desc = 'My Game Server'
-        self.service_prefix = 'mygame-'
-        
-    def get_app_directory(self) -> str:
-        return '/var/games/mygame'
-    
-    def detect_services(self) -> list:
-        # Detect existing game services
-        return []
-    
-    def create_service(self, name: str) -> BaseService:
-        # Create and return a new service instance
-        pass
-```
-
-### Creating a Game Service Handler
-
-Extend `BaseService` to implement service-specific logic:
-
-```python
-from warlock_manager.services import BaseService
-from warlock_manager.config import IniConfig
-
-class MyGameService(BaseService):
-    def __init__(self, service: str, game: BaseApp):
-        super().__init__(service, game)
-        
-        # Configure configuration files
-        self.configs['game_config'] = IniConfig(
-            '/var/games/mygame/game.ini'
-        )
-    
-    def get_port_definitions(self) -> list:
-        # Return list of port definitions: (port_number_or_config_key, 'tcp'/'udp', description)
-        return [
-            ('game_port', 'tcp', 'Game Server Port'),
-            ('query_port', 'udp', 'Query Port'),
-        ]
-    
-    def is_running(self) -> bool:
-        # Check if service is running
-        pass
-```
-
-### Building a CLI Application
-
-Use the built-in CLI framework:
-
-```python
-from warlock_manager.libs.app_runner import app_runner
-
-game = MyGameApp()
-cli_app = app_runner(game)
-
-if __name__ == '__main__':
-    cli_app()
-```
-
-This automatically provides commands for:
-- Service management (start, stop, restart, status)
-- Configuration management (get, set)
-- Port discovery and management
-- Metrics collection
-- Backup and restore operations
-- First-run setup
-
-
-Additionally, the included TUI application as provided by app provides an interactive menu system for:
-
-This provides an interactive menu system for:
-- Viewing service status and metrics
-- Managing service configurations
-- Controlling service lifecycle
-- Backup and data management
-- Creating new service instances
+Also check out the games listed as supported at [Warlock.Nexus](https://warlock.nexus) 
+to browse their source repos for more real-world implementations.
 
 ## Configuration
 
@@ -220,33 +173,6 @@ mygame:
     group: Network
 ```
 
-## Features System
-
-Control available functionality through the features system:
-
-```python
-class MyGameApp(BaseApp):
-    def __init__(self):
-        super().__init__()
-        
-        # Available features
-        self.features = {
-            'api',              # Server API support
-            'cmd',              # Command execution via API
-            'create_service',   # Create new service instances
-            'mods',             # Mod support
-        }
-        
-        # Disable specific features
-        self.disabled_features = {'mods'}
-```
-
-Available features:
-- `api` - Server API communication support
-- `cmd` - Command execution capabilities
-- `create_service` - Ability to create new service instances
-- `mods` - Mod/plugin support
-
 ## Development
 
 ### Setting Up Development Environment
@@ -264,6 +190,14 @@ source venv/bin/activate
 pip install -e ".[dev]"
 ```
 
+### Generating Documentation
+
+Documentation is generated using [pydoc-markdown](https://github.com/NiklasRosenstein/pydoc-markdown).
+
+```bash
+pydoc-markdown
+```
+
 ### Running Tests
 
 ```bash
@@ -284,55 +218,6 @@ Run linting checks:
 flake8 warlock_manager tests
 ```
 
-## API Reference
-
-### BaseApp
-
-Main application class for game server management.
-
-**Key Methods:**
-- `detect_services()`: Discover existing service instances
-- `create_service(name)`: Create a new service instance
-- `get_services()`: Get list of service instances
-- `get_options()`: Get application-level configuration options
-- `get_option_value(key)`: Get a configuration option value
-- `set_option(key, value)`: Set a configuration option
-- `start_all()`: Start all service instances
-- `stop_all()`: Stop all service instances
-- `is_active()`: Check if any service is running
-- `update()`: Update the application/game
-
-### BaseService
-
-Service instance handler for individual game servers.
-
-**Key Methods:**
-- `load()`: Load service configuration files
-- `get_options()`: Get service configuration options
-- `get_option_value(key)`: Get a configuration option
-- `set_option(key, value)`: Set a configuration option
-- `start()`: Start the service
-- `stop()`: Stop the service
-- `restart()`: Restart the service
-- `is_running()`: Check if service is running
-- `get_port()`: Get service's primary port
-- `get_ports()`: Get all port definitions
-- `is_enabled()`: Check if auto-start is enabled
-- `cmd(command)`: Send command to service
-- `get_player_count()`: Get current player count
-- `get_player_max()`: Get max player capacity
-- `backup()`: Create backup of service data
-- `restore(backup_path)`: Restore from backup
-
-### Configuration Classes
-
-All configuration classes extend `BaseConfig` and provide:
-- `load()`: Load configuration from file
-- `save()`: Save configuration to file
-- `get_option_value(key)`: Get option value
-- `set_option_value(key, value)`: Set option value
-- `exists()`: Check if configuration file exists
-
 ## License
 
 This project is licensed under the GNU Affero General Public License v3.0 or later - see the [LICENSE](LICENSE) file for details.

{warlock_manager-2.1.2 → warlock_manager-2.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "warlock-manager"
-version = "2.1.2"
+version = "2.2.0"
 description = "Dependency library for game-server management applications."
 readme = "README.md"
 requires-python = ">=3.10"
@@ -17,13 +17,13 @@ maintainers = [
 ]
 keywords = ["game-server", "management"]
 dependencies = [
-    "requests>=2.28",
+    "requests>=2.33.1",
     "pyyaml>=6.0",
     "typer>=0.24.1",
     "rcon>=2.4.9",
-    "typing_extensions>=4.9.0",
+    "typing_extensions>=4.15.0",
     "systemdunitparser>=0.4",
-    "packaging>=23.3",
+    "packaging>=26.1",
     "psutil>=7.2.0",
 ]
 classifiers = [
@@ -45,12 +45,24 @@ dev = [
     "flake8>=7.3.0",
     "pre-commit>=4.5.1",
     "pytest-cov>=7.0",
+    "pydoc-markdown>=4.8.0"
 ]
 
 [tool.setuptools.packages.find]
 where = ["."]
 include = ["warlock_manager*"]
 
+[[tool.pydoc-markdown.loaders]]
+type = "python"
+search_path = ["warlock_manager"]
+
+[tool.pydoc-markdown.renderer]
+type = "markdown"
+render_toc = false
+insert_header_anchors = false
+filename = "docs/warlock-manager.md"
+render_module_header = false
+
 [project.urls]
 "Bug Tracker" = "https://github.com/BitsNBytes25/Warlock-Manager/issues"
 "Homepage" = "https://warlock.nexus"

{warlock_manager-2.1.2 → warlock_manager-2.2.0}/tests/test_version.py

@@ -75,6 +75,7 @@ class TestVersionBooleanComparisons(unittest.TestCase):
 		self.assertFalse(is_version_newer("1.0.0", "2.0.0"))
 		self.assertTrue(is_version_newer("2.0.0", "1.0.0"))
 		self.assertFalse(is_version_newer("1.0.0", "1.0.0"))
+		self.assertFalse(is_version_newer("21.11.153", "25.1.154"))
 
 	def test_is_version_older(self):
 		self.assertFalse(is_version_older("2.0.0", "1.0.0"))