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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mc5_api_client
-Version: 1.0.21
+Version: 1.0.23
 Summary: A comprehensive Python library for interacting with the Modern Combat 5 API
 Home-page: https://pypi.org/project/mc5-api-client/
 Author: Chizoba
@@ -81,22 +81,27 @@ Dynamic: requires-python
 [![Python Version](https://img.shields.io/badge/python-3.8+-blue.svg)](https://python.org)
 [![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
 [![Author](https://img.shields.io/badge/author-Chizoba-orange.svg)](mailto:chizoba2026@hotmail.com)
-[![PyPI Version](https://img.shields.io/badge/pypi-1.0.18-blue.svg)](https://pypi.org/project/mc5-api-client/)
+[![PyPI Version](https://img.shields.io/badge/pypi-1.0.21-blue.svg)](https://pypi.org/project/mc5-api-client/)
 [![Production Ready](https://img.shields.io/badge/production-ready-brightgreen.svg)](https://pypi.org/project/mc5-api-client/)
 
 Hey there! 👋 Welcome to the **Modern Combat 5 API Client** - Comprehensive Python library for interacting with Modern Combat 5 game servers
 
-## ✨ **New in v1.0.18: Super Easy Interface & Complete Game Management!**
-
-- 🎯 **NEW: MC5Easy** - Super simple one-line functions for everyday tasks
-- 🚀 **NEW: One-Liner Functions** - `check_my_daily_tasks()`, `get_my_mc5_profile()`, `find_mc5_player()`
-- 📝 **NEW: Context Manager** - Auto-connect and auto-cleanup with `with MC5Easy()`
-- 🔧 **NEW: Environment Variables** - Secure credential management with `MC5_USERNAME` and `MC5_PASSWORD`
-- 🌐 **NEW: Service Location** - Dynamic MC5 service endpoint discovery
-- 🎮 **NEW: Federation Sessions** - Complete game launch preparation
-- 🌍 **NEW: Global ID Management** - Device tracking and identification
-- 🔗 **NEW: Connection Monitoring** - Service health and status tracking
-- 🏠 **NEW: Room Discovery** - Find available game rooms
+## ✨ **New in v1.0.21: Revolutionary Automatic Squad Management!**
+
+- 🎮 **REVOLUTIONARY: Automatic Squad Management** - No more manual squad IDs! Automatically detect and manage your squad from your profile
+- 🚀 **Zero Configuration Squad Operations** - `get_my_squad_info()`, `update_my_squad_info()`, `get_my_squad_members()` - all work without squad IDs
+- 🔄 **Squad Switching Support** - Automatically adapts when you change squads
+- 🛡️ **Intelligent Error Handling** - Graceful handling for users without squads
+- 📱 **Perfect for Mobile/Web Apps** - Standalone functions work without client instances
+- 🎯 **MC5Easy** - Super simple one-line functions for everyday tasks
+- 🚀 **One-Liner Functions** - `check_my_daily_tasks()`, `get_my_mc5_profile()`, `find_mc5_player()`
+- 📝 **Context Manager** - Auto-connect and auto-cleanup with `with MC5Easy()`
+- 🔧 **Environment Variables** - Secure credential management with `MC5_USERNAME` and `MC5_PASSWORD`
+- 🌐 **Service Location** - Dynamic MC5 service endpoint discovery
+- 🎮 **Federation Sessions** - Complete game launch preparation
+- 🌍 **Global ID Management** - Device tracking and identification
+- 🔗 **Connection Monitoring** - Service health and status tracking
+- 🏠 **Room Discovery** - Find available game rooms
 - 🏰 **PC Storage Admin** - Complete squad management with storage scopes
 - 🔧 **StorageAdminMixin** - Core storage functionality for advanced operations
 - 👤 **System Account Access** - 5 working system accounts discovered
@@ -140,12 +145,84 @@ Think of this as your remote control for Modern Combat 5! Here's what you can do
 
 ## 🚀 Installation
 
-### 🎉 MC5 API Client v1.0.18 - Super Easy Interface & Clean API!
+### 🎉 MC5 API Client v1.0.21 - Revolutionary Automatic Squad Management!
 
 ```bash
-pip install mc5_api_client==1.0.20
+pip install mc5_api_client==1.0.21
 ```
 
+## 🎮 **🚀 REVOLUTIONARY FEATURE: Automatic Squad Management**
+
+### **🎯 The Problem We Solved:**
+Previously, users had to manually specify squad IDs for squad operations:
+```python
+# ❌ OLD METHOD - Complex and error-prone
+squad_id = "d1e7437c-0156-11f1-ad07-b8ca3a709038"  # Hard to remember!
+squad_info = client.get_clan_settings(squad_id)     # Manual ID required
+```
+
+### **✅ Our Solution - Automatic Detection:**
+```python
+# ✅ NEW METHOD - Simple and automatic
+squad_info = client.get_my_squad_info()  # Auto-fetched from profile!
+```
+
+### **🎮 Key Benefits:**
+- 🎯 **No Squad ID Memorization** - Automatically detected from your profile
+- 🔄 **Squad Switching Support** - Works when you change squads
+- 🛡️ **Intelligent Error Handling** - Graceful handling for users without squads
+- 📱 **Perfect for Mobile/Web Apps** - Standalone functions work without client instances
+- 🚀 **Zero Configuration** - Just call the methods, no setup required
+
+### **🔧 Available Methods:**
+
+#### **Client Methods:**
+```python
+from mc5_api_client import MC5Client
+
+client = MC5Client(username, password)
+
+# Get squad ID automatically
+squad_id = client.get_my_squad_id()
+
+# Get complete squad information
+squad_info = client.get_my_squad_info()
+
+# Get squad members
+members = client.get_my_squad_members()
+
+# Update squad (no squad ID needed!)
+client.update_my_squad_info(
+    name="Elite Squad",
+    description="Best squad in MC5!",
+    rating=2000
+)
+```
+
+#### **Standalone Functions:**
+```python
+from mc5_api_client import get_my_squad_info, update_my_squad_info
+
+# Work without creating a client!
+squad_info = get_my_squad_info(
+    username="your_credential",
+    password="your_password"
+)
+
+# Update squad without client
+result = update_my_squad_info(
+    username="your_credential",
+    password="your_password",
+    name="New Squad Name"
+)
+```
+
+### **🔄 Real-World Impact:**
+- **10x easier** squad management
+- **Zero configuration** required
+- **Automatic adaptation** to squad changes
+- **Perfect for** modern applications
+
 ## 🎯 **Usage Examples**
 
 ### **🎮 Basic Usage (MC5Client)**
@@ -245,6 +322,203 @@ with MC5Easy(username, password) as mc5:
     print(f"Device: {device_info}")
 ```
 
+### **🎮 Automatic Squad Management (REVOLUTIONARY!)**
+```python
+from mc5_api_client import MC5Client, get_my_squad_info, update_my_squad_info
+
+# Initialize client
+client = MC5Client(username, password)
+
+# 🚀 NO MORE SQUAD ID NEEDED! Automatically detected from your profile!
+
+# Get your squad information automatically
+squad_info = client.get_my_squad_info()
+print(f"Squad Name: {squad_info['name']}")
+print(f"Squad Rating: {squad_info['rating']}")
+print(f"Description: {squad_info['description']}")
+
+# Get squad members automatically
+members = client.get_my_squad_members()
+print(f"Member Count: {members['member_count']}")
+for member in members['members'][:3]:
+    print(f"  - {member['name']}")
+
+# Update squad automatically (no squad ID required!)
+client.update_my_squad_info(
+    name="Elite Squad",
+    description="Best squad in MC5!",
+    rating=2000,
+    min_join_value=1000
+)
+
+# 🔄 Works even when you switch squads!
+# The methods automatically detect your current squad
+```
+
+### **🚀 Standalone Squad Management (No Client Required!)**
+```python
+from mc5_api_client import get_my_squad_id, get_my_squad_info, update_my_squad_info
+
+# Get squad ID without creating client
+squad_id = get_my_squad_id(
+    username="your_credential",
+    password="your_password"
+)
+print(f"Your Squad ID: {squad_id}")
+
+# Get squad info without creating client
+squad_info = get_my_squad_info(
+    username="your_credential",
+    password="your_password"
+)
+print(f"Squad: {squad_info['name']}")
+
+# Update squad without creating client
+result = update_my_squad_info(
+    username="your_credential",
+    password="your_password",
+    name="New Squad Name",
+    description="Updated description"
+)
+print(f"Update Result: {result}")
+```
+
+### **🔄 Traditional vs Automatic Squad Management**
+```python
+# ❌ OLD METHOD - Manual squad ID required
+squad_id = "d1e7437c-0156-11f1-ad07-b8ca3a709038"  # Hard to remember!
+squad_info = client.get_clan_settings(squad_id)     # Manual ID required
+members = client.get_clan_members(squad_id)          # Manual ID required
+client.update_clan_settings(squad_id, name="New")    # Manual ID required
+
+# ✅ NEW METHOD - Automatic detection
+squad_info = client.get_my_squad_info()           # Auto-fetched!
+members = client.get_my_squad_members()           # Auto-fetched!
+client.update_my_squad_info(name="New")           # Auto-fetched!
+
+# Benefits:
+# 🎯 No squad ID memorization
+# 🔄 Works when switching squads
+# 🛡️ Error handling for users without squads
+# 🚀 Simpler API for everyday use
+```
+
+### **🎨 Complete Squad Customization (NEW!)**
+```python
+from mc5_api_client import MC5Client
+
+client = MC5Client(username, password)
+
+# 🚀 SUPER SIMPLE - One-line customizations!
+client.quick_set_name("My Awesome Squad")           # Change name
+client.quick_set_level(5)                              # Set to Level 5
+client.quick_set_colors("red", "white")               # Red/White colors
+client.quick_set_member_limit(50)                     # Set member limit
+client.quick_set_currency(10000)                       # Set currency
+
+# 🎯 QUICK SETUPS - Professional results in one line!
+client.quick_setup_professional_squad("Elite Squad", level=8)  # Professional squad
+client.quick_setup_gaming_squad("Gaming Legends", "fire")       # Gaming squad with theme
+
+# 🎨 THEMES - Beautiful colors instantly
+client.customize_squad_theme('fire')                    # Fire theme
+client.customize_squad_theme('ice')                     # Ice theme
+client.customize_squad_theme('dark')                    # Dark theme
+client.customize_squad_theme('nature')                  # Nature theme
+
+# ⭐ LEVEL SYSTEM - Automatic XP calculation
+client.set_squad_level(10, "Max Level Squad")          # Level 10 (max)
+# Level 1: 1000 XP, Level 5: 5000 XP, Level 10: 10000 XP
+
+# 🔧 COMPLETE CUSTOMIZATION - Full control with validation
+client.customize_squad_complete(
+    name="452e55e84897+",
+    rating=3573,
+    score=5200,
+    member_limit=300,
+    _logo_clr_prim=client.get_color_value("red"),
+    _xp=client.calculate_xp_for_level(9),
+    currency="10000"
+)
+```
+
+### **📊 Squad Parameters You Can Customize:**
+```python
+# 📝 Basic Information
+name: "Your Squad Name"
+description: "Your squad description"
+rating: 5000
+score: 5200
+
+# 👥 Member Settings
+member_limit: 300                    # 1-300 members
+membership: "owner_approved"          # or "open"
+_min_join_value: 1000               # Minimum score to join
+
+# 🎨 Visual Customization
+_logo: "1"                           # Logo ID
+_logo_clr_prim: "16711680"           # Primary color (RGB decimal)
+_logo_clr_sec: "16777215"            # Secondary color (RGB decimal)
+# Colors: black=0, white=16777215, red=16711680, blue=255, green=65280
+
+# ⭐ Level & Progress
+_xp: "5000"                          # Level 5 (1000-10000, Level 1-10)
+# Level 1: 1000, Level 2: 2000, ..., Level 10: 10000
+
+# 💰 Economy
+currency: "10000"
+_killsig_id: "default_killsig_01"
+
+# 🏃 Activity Settings
+active_clan_label: "true"
+active_clan_threshold: "50"
+```
+
+### **🚀 Quick Functions - EASIEST WAY TO CUSTOMIZE!**
+```python
+# 📝 BASIC QUICK FUNCTIONS
+client.quick_set_name("My Squad")              # Change name
+client.quick_set_rating(5000)                    # Set rating
+client.quick_set_member_limit(50)               # Set member limit
+client.quick_set_currency(10000)                  # Set currency
+
+# � COLOR QUICK FUNCTIONS
+client.quick_set_colors("red")                    # Red theme
+client.quick_set_colors("blue", "white")           # Blue/White theme
+client.quick_set_colors("black", "gold")           # Black/Gold theme
+
+# ⭐ LEVEL QUICK FUNCTIONS
+client.quick_set_level(5)                         # Set to Level 5
+client.quick_set_level(10, "Max Level")           # Set to Level 10
+
+# 🏆 PROFESSIONAL QUICK SETUPS
+client.quick_setup_professional_squad("Elite Squad", level=8)  # Professional setup
+client.quick_setup_gaming_squad("Gaming Squad", "fire")       # Gaming setup
+
+# 🔄 RESET QUICK FUNCTION
+client.quick_reset_to_defaults()                    # Reset to defaults
+```
+
+### **�🎮 Quick Customization Examples:**
+```python
+# 🚀 One-line level upgrades
+client.quick_set_level(10)                    # Max level squad
+client.quick_set_level(5, "Level 5 Warriors")  # Custom name
+
+# 🎨 One-line theme applications
+client.customize_squad_theme('fire')            # Fire theme
+client.customize_squad_theme('ice', 'Ice Squad') # Custom name
+
+# 🔧 Complete professional setup
+client.customize_squad_complete(
+    name="Elite Squad",
+    rating=8000,
+    _xp=client.calculate_xp_for_level(8),
+    _logo_clr_prim=client.get_color_value('purple'),
+    member_limit=100
+)
+```
+
 ## 📱 **Run Examples:** Completed!
 
 **🎯 Super Easy Interface (NEW in v1.0.18):**
@@ -329,8 +603,17 @@ python examples/service_location_example.py
 # Game launch and federation sessions:
 python examples/game_launch_example.py
 
-# Device ID management:
-python examples/device_id_example.py
+# Automatic squad management:
+python examples/automatic_squad_management.py
+
+# Complete squad customization:
+python examples/complete_squad_customization.py
+
+# Quick squad customization:
+python examples/squad_customization_quick.py
+
+# Squad quick start (super simple):
+python examples/squad_quick_start.py
 
 # Authentication examples:
 python examples/authentication_example.py