mc5-api-client 1.0.19__tar.gz → 1.0.21__tar.gz

{mc5_api_client-1.0.19/src/mc5_api_client.egg-info → mc5_api_client-1.0.21}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mc5_api_client
-Version: 1.0.19
+Version: 1.0.21
 Summary: A comprehensive Python library for interacting with the Modern Combat 5 API
 Home-page: https://pypi.org/project/mc5-api-client/
 Author: Chizoba
@@ -143,10 +143,109 @@ Think of this as your remote control for Modern Combat 5! Here's what you can do
 ### 🎉 MC5 API Client v1.0.18 - Super Easy Interface & Clean API!
 
 ```bash
-pip install mc5_api_client==1.0.18
+pip install mc5_api_client==1.0.20
 ```
 
-### ✅ **Major Features Completed!**
+## 🎯 **Usage Examples**
+
+### **🎮 Basic Usage (MC5Client)**
+```python
+from mc5_api_client import MC5Client
+
+# Initialize the client
+client = MC5Client(
+    client_id="1875:55979:6.0.0a:windows:windows",
+    username="your_credential",
+    password="your_password"
+)
+
+# Authenticate
+client.authenticate()
+
+# Get profile
+profile = client.get_profile()
+print(f"Profile: {profile}")
+
+# Get events
+events = client.get_events()
+print(f"Events: {len(events)} found")
+
+# Server status (NEW!)
+status = client.get_server_status()
+print(f"Server Status: {status['status']}")
+
+# Close connection
+client.close()
+```
+
+### **🎯 MC5ApiClient (Backward Compatible)**
+```python
+from mc5_api_client import MC5ApiClient
+
+# MC5ApiClient is an alias for MC5Client
+client = MC5ApiClient(
+    client_id="1875:55979:6.0.0a:windows:windows",
+    username="your_credential",
+    password="your_password"
+)
+
+# Use the same methods as MC5Client
+client.authenticate()
+status = client.get_server_status()
+info = client.get_server_info()
+```
+
+### **🔧 Quick Functions (Standalone)**
+```python
+from mc5_api_client import quick_get_account_info, quick_get_active_sessions
+
+# Quick functions are standalone, not client methods
+# They require credentials as parameters
+account_info = quick_get_account_info("your_credential", "your_password")
+sessions = quick_get_active_sessions("your_password")
+```
+
+### **🎮 Game Launch & Service Location (NEW!)**
+```python
+from mc5_api_client import MC5Easy, get_all_services, create_federation_session
+
+# Get all MC5 services dynamically
+services = get_all_services()
+print(f"Found {len(services)} services:")
+for service, endpoint in services.items():
+    print(f"  {service}: {endpoint}")
+
+# Create federation session for game launch
+session = create_federation_session(username, password)
+if session.get("success"):
+    print(f"Room ID: {session['room_id']}")
+    print(f"Controller: {session['controller_host']}")
+
+# Or use MC5Easy for complete game management
+with MC5Easy(username, password) as mc5:
+    launch_info = mc5.launch_game_session()
+    print(f"Game ready: {launch_info['launch_command']}")
+```
+
+### **🌐 Global ID & Device Management (NEW!)**
+```python
+from mc5_api_client import get_global_id, generate_device_id
+
+# Get global device ID
+global_id = get_global_id()
+print(f"Global ID: {global_id}")
+
+# Generate unique device ID
+device_id = generate_device_id()
+print(f"Device ID: {device_id}")
+
+# With MC5Easy
+with MC5Easy(username, password) as mc5:
+    device_info = mc5.get_device_info()
+    print(f"Device: {device_info}")
+```
+
+## 📱 **Run Examples:** Completed!
 
 **🎯 Super Easy Interface (NEW in v1.0.18):**
 - ✅ **MC5Easy Module** - One-line functions for everyday tasks
@@ -1348,8 +1447,6 @@ finally:
 **Security Benefits:**
 - ✅ **Additional Layer**: Tokens are encrypted before transmission
 - ✅ **Custom Nonce**: Support for custom nonce values
-- ✅ **Backward Compatible**: Works with existing authentication flow
-- ✅ **Error Handling**: Proper validation and error recovery
 
 ### 🏆 **Checking Leaderboards**
 
@@ -1369,7 +1466,6 @@ if hasattr(client, 'get_leaderboard'):
     # print(f"Top {len(leaderboard.get('players', []))} players")
 else:
     print("❌ get_leaderboard method not found")
-```
 
 ### 🖥️ CLI Commands - Currently Available
 

{mc5_api_client-1.0.19 → mc5_api_client-1.0.21}/README.md

@@ -65,10 +65,109 @@ Think of this as your remote control for Modern Combat 5! Here's what you can do
 ### 🎉 MC5 API Client v1.0.18 - Super Easy Interface & Clean API!
 
 ```bash
-pip install mc5_api_client==1.0.18
+pip install mc5_api_client==1.0.20
 ```
 
-### ✅ **Major Features Completed!**
+## 🎯 **Usage Examples**
+
+### **🎮 Basic Usage (MC5Client)**
+```python
+from mc5_api_client import MC5Client
+
+# Initialize the client
+client = MC5Client(
+    client_id="1875:55979:6.0.0a:windows:windows",
+    username="your_credential",
+    password="your_password"
+)
+
+# Authenticate
+client.authenticate()
+
+# Get profile
+profile = client.get_profile()
+print(f"Profile: {profile}")
+
+# Get events
+events = client.get_events()
+print(f"Events: {len(events)} found")
+
+# Server status (NEW!)
+status = client.get_server_status()
+print(f"Server Status: {status['status']}")
+
+# Close connection
+client.close()
+```
+
+### **🎯 MC5ApiClient (Backward Compatible)**
+```python
+from mc5_api_client import MC5ApiClient
+
+# MC5ApiClient is an alias for MC5Client
+client = MC5ApiClient(
+    client_id="1875:55979:6.0.0a:windows:windows",
+    username="your_credential",
+    password="your_password"
+)
+
+# Use the same methods as MC5Client
+client.authenticate()
+status = client.get_server_status()
+info = client.get_server_info()
+```
+
+### **🔧 Quick Functions (Standalone)**
+```python
+from mc5_api_client import quick_get_account_info, quick_get_active_sessions
+
+# Quick functions are standalone, not client methods
+# They require credentials as parameters
+account_info = quick_get_account_info("your_credential", "your_password")
+sessions = quick_get_active_sessions("your_password")
+```
+
+### **🎮 Game Launch & Service Location (NEW!)**
+```python
+from mc5_api_client import MC5Easy, get_all_services, create_federation_session
+
+# Get all MC5 services dynamically
+services = get_all_services()
+print(f"Found {len(services)} services:")
+for service, endpoint in services.items():
+    print(f"  {service}: {endpoint}")
+
+# Create federation session for game launch
+session = create_federation_session(username, password)
+if session.get("success"):
+    print(f"Room ID: {session['room_id']}")
+    print(f"Controller: {session['controller_host']}")
+
+# Or use MC5Easy for complete game management
+with MC5Easy(username, password) as mc5:
+    launch_info = mc5.launch_game_session()
+    print(f"Game ready: {launch_info['launch_command']}")
+```
+
+### **🌐 Global ID & Device Management (NEW!)**
+```python
+from mc5_api_client import get_global_id, generate_device_id
+
+# Get global device ID
+global_id = get_global_id()
+print(f"Global ID: {global_id}")
+
+# Generate unique device ID
+device_id = generate_device_id()
+print(f"Device ID: {device_id}")
+
+# With MC5Easy
+with MC5Easy(username, password) as mc5:
+    device_info = mc5.get_device_info()
+    print(f"Device: {device_info}")
+```
+
+## 📱 **Run Examples:** Completed!
 
 **🎯 Super Easy Interface (NEW in v1.0.18):**
 - ✅ **MC5Easy Module** - One-line functions for everyday tasks
@@ -1270,8 +1369,6 @@ finally:
 **Security Benefits:**
 - ✅ **Additional Layer**: Tokens are encrypted before transmission
 - ✅ **Custom Nonce**: Support for custom nonce values
-- ✅ **Backward Compatible**: Works with existing authentication flow
-- ✅ **Error Handling**: Proper validation and error recovery
 
 ### 🏆 **Checking Leaderboards**
 
@@ -1291,7 +1388,6 @@ if hasattr(client, 'get_leaderboard'):
     # print(f"Top {len(leaderboard.get('players', []))} players")
 else:
     print("❌ get_leaderboard method not found")
-```
 
 ### 🖥️ CLI Commands - Currently Available
 

{mc5_api_client-1.0.19 → mc5_api_client-1.0.21}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "mc5_api_client"
-version = "1.0.19"
+version = "1.0.21"
 description = "A comprehensive Python library for interacting with the Modern Combat 5 API"
 readme = "README.md"
 license = {file = "LICENSE"}

{mc5_api_client-1.0.19 → mc5_api_client-1.0.21}/setup.py

@@ -33,7 +33,7 @@ def read_requirements():
 setup(
     name="mc5_api_client",
     use_scm_version=False,
-    version="1.0.19",
+    version="1.0.21",
     description="A comprehensive Python library for interacting with the Modern Combat 5 API",
     long_description=read_readme(),
     long_description_content_type="text/markdown",

{mc5_api_client-1.0.19 → mc5_api_client-1.0.21}/src/mc5_api_client/__init__.py

@@ -15,7 +15,7 @@ messaging, and more.
 
 from typing import Optional, Dict, Any
 
-__version__ = "1.0.19"
+__version__ = "1.0.21"
 __author__ = "Chizoba"
 __email__ = "chizoba2026@hotmail.com"
 __license__ = "MIT"
@@ -88,6 +88,37 @@ from .auth import TokenGenerator
 from .exceptions import MC5APIError, AuthenticationError, RateLimitError
 from .help import help, examples, quick_reference
 
+# Automatic Squad Management (NEW!)
+from .client import MC5Client
+
+# Add automatic squad management methods as standalone functions
+def get_my_squad_id(client=None, **kwargs):
+    """Get user's squad ID automatically."""
+    if client is None:
+        client = MC5Client(**kwargs)
+    return client.get_my_squad_id()
+
+def get_my_squad_info(client=None, **kwargs):
+    """Get user's squad information automatically."""
+    if client is None:
+        client = MC5Client(**kwargs)
+    return client.get_my_squad_info()
+
+def update_my_squad_info(client=None, **squad_kwargs):
+    """Update user's squad information automatically."""
+    client_kwargs = {k: v for k, v in squad_kwargs.items() if k in ['username', 'password', 'client_id']}
+    update_kwargs = {k: v for k, v in squad_kwargs.items() if k not in ['username', 'password', 'client_id']}
+    
+    if client is None:
+        client = MC5Client(**client_kwargs)
+    return client.update_my_squad_info(**update_kwargs)
+
+def get_my_squad_members(client=None, **kwargs):
+    """Get user's squad members automatically."""
+    if client is None:
+        client = MC5Client(**kwargs)
+    return client.get_my_squad_members()
+
 # Add MC5ApiClient as an alias for backward compatibility
 MC5ApiClient = MC5Client
 from .admin_client import (
@@ -399,9 +430,13 @@ __all__ = [
     "MC5Easy",
     "quick_connect",
     "check_my_daily_tasks",
-    "get_my_mc5_profile",
-    "find_mc5_player",
-    "get_global_id",
+    "get_server_status",
+    "get_online_players", 
+    "get_server_info",
+    "get_my_squad_id",
+    "get_my_squad_info",
+    "update_my_squad_info",
+    "get_my_squad_members",
     "generate_device_id",
     "create_federation_session",
     "locate_service",

{mc5_api_client-1.0.19 → mc5_api_client-1.0.21}/src/mc5_api_client/client.py

@@ -1652,6 +1652,186 @@ class MC5Client(SquadBattleMixin, FederationMixin, AlertsMixin, AccountMixin, Tr
                 "timestamp": time.time()
             }
     
+    # Automatic Squad Management (NEW!)
+    
+    def get_my_squad_id(self) -> Optional[str]:
+        """
+        Automatically fetch the user's squad ID from their profile.
+        
+        This method eliminates the need to manually specify squad ID for squad operations.
+        It fetches the user's profile and extracts the squad/group ID from their groups.
+        
+        Returns:
+            Squad ID if found, None otherwise
+        """
+        try:
+            # Get user profile which contains groups information
+            profile = self.get_profile()
+            
+            if not profile:
+                return None
+                
+            # Check if user has groups
+            groups = profile.get('groups', [])
+            if not groups:
+                return None
+            
+            # Extract squad ID from groups (usually the first group is the squad)
+            # Groups can be in different formats, handle multiple cases
+            for group in groups:
+                if isinstance(group, str):
+                    # Simple string ID
+                    return group
+                elif isinstance(group, dict):
+                    # Dictionary with ID field
+                    if 'id' in group:
+                        return group['id']
+                    elif '_id' in group:
+                        return group['_id']
+                    elif 'group_id' in group:
+                        return group['group_id']
+            
+            # If no group found in the expected format, try to extract from the groups string
+            if groups and isinstance(groups[0], str):
+                return groups[0]
+                
+            return None
+            
+        except Exception as e:
+            print(f"🔴 Error fetching squad ID: {e}")
+            return None
+    
+    def get_my_squad_info(self) -> Dict[str, Any]:
+        """
+        Get complete squad information using automatically fetched squad ID.
+        
+        Returns:
+            Dictionary with squad information or error details
+        """
+        try:
+            squad_id = self.get_my_squad_id()
+            if not squad_id:
+                return {
+                    "error": "No squad found for this user",
+                    "message": "User is not in any squad",
+                    "timestamp": time.time()
+                }
+            
+            # Get squad information using the fetched ID
+            squad_info = self.get_clan_settings(squad_id)
+            
+            if squad_info:
+                squad_info['auto_fetched_squad_id'] = squad_id
+                squad_info['fetch_method'] = 'automatic'
+                return squad_info
+            else:
+                return {
+                    "error": "Failed to fetch squad details",
+                    "squad_id": squad_id,
+                    "message": "Squad ID found but could not fetch details",
+                    "timestamp": time.time()
+                }
+                
+        except Exception as e:
+            return {
+                "error": str(e),
+                "message": "Failed to get squad information",
+                "timestamp": time.time()
+            }
+    
+    def update_my_squad_info(self, **kwargs) -> Dict[str, Any]:
+        """
+        Update squad information using automatically fetched squad ID.
+        
+        This is a convenience method that combines get_my_squad_id() and update_clan_settings().
+        Users don't need to specify squad ID - it's automatically fetched from their profile.
+        
+        Args:
+            **kwargs: Squad settings to update (same as update_clan_settings)
+                - name: Squad name
+                - description: Squad description  
+                - rating: Squad rating
+                - min_join_value: Minimum join value
+                - logo: Squad logo ID
+                - logo_clr_prim: Primary logo color
+                - logo_clr_sec: Secondary logo color
+        
+        Returns:
+            Dictionary with update result or error details
+        """
+        try:
+            squad_id = self.get_my_squad_id()
+            if not squad_id:
+                return {
+                    "error": "No squad found for this user",
+                    "message": "Cannot update squad - user is not in any squad",
+                    "timestamp": time.time()
+                }
+            
+            # Update squad using the fetched ID
+            result = self.update_clan_settings(squad_id, **kwargs)
+            
+            if result:
+                result['auto_fetched_squad_id'] = squad_id
+                result['update_method'] = 'automatic'
+                return result
+            else:
+                return {
+                    "error": "Failed to update squad",
+                    "squad_id": squad_id,
+                    "message": "Squad ID found but update failed",
+                    "timestamp": time.time()
+                }
+                
+        except Exception as e:
+            return {
+                "error": str(e),
+                "message": "Failed to update squad information",
+                "timestamp": time.time()
+            }
+    
+    def get_my_squad_members(self) -> Dict[str, Any]:
+        """
+        Get squad members using automatically fetched squad ID.
+        
+        Returns:
+            Dictionary with squad members or error details
+        """
+        try:
+            squad_id = self.get_my_squad_id()
+            if not squad_id:
+                return {
+                    "error": "No squad found for this user",
+                    "message": "Cannot get squad members - user is not in any squad",
+                    "timestamp": time.time()
+                }
+            
+            # Get squad members using the fetched ID
+            members = self.get_clan_members(squad_id)
+            
+            if members:
+                return {
+                    "squad_id": squad_id,
+                    "members": members,
+                    "member_count": len(members) if isinstance(members, list) else 0,
+                    "fetch_method": "automatic",
+                    "timestamp": time.time()
+                }
+            else:
+                return {
+                    "error": "Failed to fetch squad members",
+                    "squad_id": squad_id,
+                    "message": "Squad ID found but could not fetch members",
+                    "timestamp": time.time()
+                }
+                
+        except Exception as e:
+            return {
+                "error": str(e),
+                "message": "Failed to get squad members",
+                "timestamp": time.time()
+            }
+    
     # Events API
     
     def get_events(self, event_type: str = None, status: str = None) -> List[Dict[str, Any]]:

{mc5_api_client-1.0.19 → mc5_api_client-1.0.21/src/mc5_api_client.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mc5_api_client
-Version: 1.0.19
+Version: 1.0.21
 Summary: A comprehensive Python library for interacting with the Modern Combat 5 API
 Home-page: https://pypi.org/project/mc5-api-client/
 Author: Chizoba
@@ -143,10 +143,109 @@ Think of this as your remote control for Modern Combat 5! Here's what you can do
 ### 🎉 MC5 API Client v1.0.18 - Super Easy Interface & Clean API!
 
 ```bash
-pip install mc5_api_client==1.0.18
+pip install mc5_api_client==1.0.20
 ```
 
-### ✅ **Major Features Completed!**
+## 🎯 **Usage Examples**
+
+### **🎮 Basic Usage (MC5Client)**
+```python
+from mc5_api_client import MC5Client
+
+# Initialize the client
+client = MC5Client(
+    client_id="1875:55979:6.0.0a:windows:windows",
+    username="your_credential",
+    password="your_password"
+)
+
+# Authenticate
+client.authenticate()
+
+# Get profile
+profile = client.get_profile()
+print(f"Profile: {profile}")
+
+# Get events
+events = client.get_events()
+print(f"Events: {len(events)} found")
+
+# Server status (NEW!)
+status = client.get_server_status()
+print(f"Server Status: {status['status']}")
+
+# Close connection
+client.close()
+```
+
+### **🎯 MC5ApiClient (Backward Compatible)**
+```python
+from mc5_api_client import MC5ApiClient
+
+# MC5ApiClient is an alias for MC5Client
+client = MC5ApiClient(
+    client_id="1875:55979:6.0.0a:windows:windows",
+    username="your_credential",
+    password="your_password"
+)
+
+# Use the same methods as MC5Client
+client.authenticate()
+status = client.get_server_status()
+info = client.get_server_info()
+```
+
+### **🔧 Quick Functions (Standalone)**
+```python
+from mc5_api_client import quick_get_account_info, quick_get_active_sessions
+
+# Quick functions are standalone, not client methods
+# They require credentials as parameters
+account_info = quick_get_account_info("your_credential", "your_password")
+sessions = quick_get_active_sessions("your_password")
+```
+
+### **🎮 Game Launch & Service Location (NEW!)**
+```python
+from mc5_api_client import MC5Easy, get_all_services, create_federation_session
+
+# Get all MC5 services dynamically
+services = get_all_services()
+print(f"Found {len(services)} services:")
+for service, endpoint in services.items():
+    print(f"  {service}: {endpoint}")
+
+# Create federation session for game launch
+session = create_federation_session(username, password)
+if session.get("success"):
+    print(f"Room ID: {session['room_id']}")
+    print(f"Controller: {session['controller_host']}")
+
+# Or use MC5Easy for complete game management
+with MC5Easy(username, password) as mc5:
+    launch_info = mc5.launch_game_session()
+    print(f"Game ready: {launch_info['launch_command']}")
+```
+
+### **🌐 Global ID & Device Management (NEW!)**
+```python
+from mc5_api_client import get_global_id, generate_device_id
+
+# Get global device ID
+global_id = get_global_id()
+print(f"Global ID: {global_id}")
+
+# Generate unique device ID
+device_id = generate_device_id()
+print(f"Device ID: {device_id}")
+
+# With MC5Easy
+with MC5Easy(username, password) as mc5:
+    device_info = mc5.get_device_info()
+    print(f"Device: {device_info}")
+```
+
+## 📱 **Run Examples:** Completed!
 
 **🎯 Super Easy Interface (NEW in v1.0.18):**
 - ✅ **MC5Easy Module** - One-line functions for everyday tasks
@@ -1348,8 +1447,6 @@ finally:
 **Security Benefits:**
 - ✅ **Additional Layer**: Tokens are encrypted before transmission
 - ✅ **Custom Nonce**: Support for custom nonce values
-- ✅ **Backward Compatible**: Works with existing authentication flow
-- ✅ **Error Handling**: Proper validation and error recovery
 
 ### 🏆 **Checking Leaderboards**
 
@@ -1369,7 +1466,6 @@ if hasattr(client, 'get_leaderboard'):
     # print(f"Top {len(leaderboard.get('players', []))} players")
 else:
     print("❌ get_leaderboard method not found")
-```
 
 ### 🖥️ CLI Commands - Currently Available