mc5-api-client 1.0.13__tar.gz → 1.0.15__tar.gz

{mc5_api_client-1.0.13 → mc5_api_client-1.0.15}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mc5_api_client
-Version: 1.0.13
+Version: 1.0.15
 Summary: A comprehensive Python library for interacting with the Modern Combat 5 API
 Home-page: https://pypi.org/project/mc5-api-client/
 Author: Chizoba
@@ -188,9 +188,12 @@ result = quick_update_player_score(
 )
 
 if result.get('success'):
-    print("✅ Player score updated successfully!")
-    print(f"New score: {result.get('score')}")
-    print(f"New XP: {result.get('xp')}")
+    print(f"✅ Player score updated successfully!")
+    print(f"New score: {result.get('score_updated')}")
+    if result.get('xp_updated'):
+        print(f"New XP: {result.get('xp_updated')}")
+else:
+    print(f"❌ Error: {result.get('error', 'Unknown error')}")
 ```
 
 ### **� Admin Client Usage:**
@@ -229,130 +232,169 @@ client.close()
 ### **🔧 How It Actually Works:**
 Admin privileges allow you to modify individual player data within a squad, which indirectly affects the squad's overall rating through the sum of member scores, but you cannot directly set the squad's rating value.
 
-## 🎮 **Simple Usage for Non-Developers**
-
-New in v1.0.7! We've added a revolutionary super-simple interface for non-developers:
+## � **Quick Start - What Most Users Want**
 
-### **🚀 Quick Start - Just 3 Lines!**
+### **🚀 Everyday MC5 Tasks (3 Lines)**
 
 ```python
 from mc5_api_client import SimpleMC5Client
 
-# Connect and auto-detect your clan
+# Connect and check your daily tasks
 client = SimpleMC5Client('YOUR_USERNAME', 'YOUR_PASSWORD')
 client.connect()
 
-# Search for any player by dogtag
-player = client.search_player('f55f')
-print(f"Found: {player['kills']:,} kills")
+# Check your profile
+profile = client.client.get_profile()
+print(f"Level: {profile['level']}, Score: {profile['score']:,}")
 ```
 
-### **🎯 Super Simple Examples:**
+### **� Search Players Instantly**
 
-**Search Players:**
 ```python
-# One-line search
+# One-line player search
 from mc5_api_client import quick_search
-player = quick_search('218f', 'YOUR_USERNAME', 'YOUR_PASSWORD')
+player = quick_search('f55f', 'YOUR_USERNAME', 'YOUR_PASSWORD')
 print(f"Elite player: {player['kills']:,} kills!")
 ```
 
-**Batch Search with Loop:**
+### **🛡️ Admin Score Updates (Working Example)**
+
 ```python
-from mc5_api_client.simple_client import batch_search_players
+from mc5_api_client import quick_update_player_score
 
-dogtags = ['f55f', '9gg9', '78d7', '218f']
-results = batch_search_players(dogtags, 'YOUR_USERNAME', 'YOUR_PASSWORD')
+# Add 5200 rating to squad by updating player score
+result = quick_update_player_score(
+    target_user_id="anonymous:d2luOF92M18xNzcwMDUxNjkwXy7H33aeTVB4YZictyDq48c=",
+    score=5200,
+    xp=2037745,
+    killsig_color="-974646126",
+    killsig_id="default_killsig_80"
+)
 
-# Conditional processing
-for player in results['found']:
-    if player['kills'] > 10000:
-        print(f"🌟 Elite: {player['dogtag']} - {player['kills']:,} kills")
-    else:
-        print(f"👤 Player: {player['dogtag']} - {player['kills']:,} kills")
+if result.get('success'):
+    print(f"✅ Score updated: {result.get('score_updated')}")
+else:
+    print(f"❌ Error: {result.get('error', 'Unknown error')}")
 ```
 
-**Smart Clan Cleanup:**
-```python
-from mc5_api_client.simple_client import clan_cleanup
-
-# Intelligent cleanup with conditional logic
-results = clan_cleanup(
-    'YOUR_USERNAME', 'YOUR_PASSWORD',
-    inactive_days=30,
-    min_level=15,  # Protect high-level players
-    dry_run=True   # Simulation only
-)
+## � **Examples Folder - Ready-to-Use Scripts**
 
-print(f"Would kick: {results['would_kick']} members")
-print(f"Protected: {results['protected']} members")
+New in v1.0.14! We've created practical, ready-to-use scripts for common MC5 tasks:
 
-if results['would_kick'] > 0:
-    print("⚠️ Consider removing inactive members")
+### **🎮 Everyday MC5 Tasks**
+
+File: `examples/everyday_mc5.py`
+- ✅ Check daily tasks and rewards
+- ✅ Search players by dogtag
+- ✅ Manage clan members
+- ✅ Send messages to friends
+- ✅ Check profile stats
+- ✅ Interactive and user-friendly
+
+**Usage:**
+```bash
+python examples/everyday_mc5.py
 ```
 
-**Real-time Monitoring:**
-```python
-from mc5_api_client.simple_client import monitor_clan_activity
+### **🛡️ Admin Tools**
 
-# Monitor clan activity every 60 seconds for 10 checks
-monitor_clan_activity(
-    'YOUR_USERNAME', 'YOUR_PASSWORD',
-    check_interval=60,
-    max_checks=10
-)
+File: `examples/admin_tools.py`
+- ✅ Update player scores (add rating)
+- ✅ Manage squad members
+- ✅ Kick members with confirmation
+- ✅ Handle clan requests
+- ✅ Safe admin operations
+
+**Usage:**
+```bash
+python examples/admin_tools.py
 ```
 
-**Clan Management:**
-```python
-with SimpleMC5Client('YOUR_USERNAME', 'YOUR_PASSWORD') as client:
-    client.connect()  # Auto-detects your clan!
-    
-    # Get all clan members
-    members = client.get_clan_members()
-    print(f"Your clan has {len(members)} members")
-    
-    # Kick by dogtag (no clan ID needed!)
-    client.kick_member('9gg9', 'Inactive for 30 days')
-    
-    # Update clan settings
-    client.update_clan_settings(name="Elite Squad 2026")
+### **⚡ Quick Reference**
+
+File: `examples/quick_reference.py`
+- ✅ Copy-paste ready examples
+- ✅ All common operations
+- ✅ Error handling patterns
+- ✅ Batch operations
+- ✅ One-liner functions
+
+**Usage:**
+```bash
+python examples/quick_reference.py
 ```
 
-**Send Messages:**
-```python
-with SimpleMC5Client('YOUR_USERNAME', 'YOUR_PASSWORD') as client:
-    client.connect()
-    
-    # Send message to any player by dogtag
-    client.send_message('f55f', 'Want to play together?')
+### **📧 Message Management**
+
+File: `examples/message_management.py`
+- ✅ Get inbox messages
+- ✅ Delete single/multiple messages
+- ✅ Clear entire inbox
+- ✅ Send private messages
+- ✅ Squad wall communication
+
+**Usage:**
+```bash
+python examples/message_management.py
 ```
 
-### **✨ Key Benefits for Non-Developers:**
+### **🏰 Clan Management**
 
-- ✅ **No Clan ID Needed**: Auto-detects your clan from your profile
-- ✅ **Simple Method Names**: `search_player()` instead of `get_player_stats_by_dogtag()`
-- ✅ **Auto-Connection**: Just call `connect()` once
-- ✅ **Clear Error Messages**: User-friendly error descriptions
-- ✅ **Context Manager**: Automatic cleanup with `with` statement
-- ✅ **Quick Functions**: One-liners for common tasks
+File: `examples/clan_management.py`
+- ✅ Create and manage clans
+- ✅ Invite and kick members
+- ✅ Update clan settings
+- ✅ Handle applications
+- ✅ Clan statistics
 
-### **📚 Simple vs Advanced Comparison:**
+**Usage:**
+```bash
+python examples/clan_management.py
+```
+
+### **📅 Events & Tasks**
+
+File: `examples/events_and_tasks.py`
+- ✅ Check daily tasks
+- ✅ Monitor events
+- ✅ Track progress
+- ✅ Get rewards
+- ✅ Event automation
+
+**Usage:**
+```bash
+python examples/events_and_tasks.py
+```
 
-| Task | Simple Version | Advanced Version |
-|------|----------------|------------------|
-| Search Player | `client.search_player('f55f')` | `client.get_player_stats_by_dogtag('f55f')` |
-| Get Clan Members | `client.get_clan_members()` | `client.get_clan_members(clan_id)` |
-| Kick Member | `client.kick_member('9gg9')` | `client.kick_clan_member_by_dogtag('9gg9', clan_id)` |
-| Connect | `client.connect()` | Manual authentication |
+### **🔐 Encrypted Tokens**
 
-### **🎯 Perfect For:**
-- **Clan Leaders**: Easy member management
-- **Players**: Quick stats lookup
-- **Beginners**: No programming experience needed
-- **Quick Tasks**: One-liner functions
+File: `examples/help_system.py` (includes token examples)
+- ✅ Generate encrypted tokens
+- ✅ Encrypt existing tokens
+- ✅ Security best practices
+- ✅ Custom nonce support
 
-## 📚 **Built-in Help System**
+**Usage:**
+```bash
+python examples/help_system.py
+```
+
+**🎯 Why These Examples?**
+- ✅ **No Setup Required**: Just add your credentials
+- ✅ **Interactive**: User-friendly prompts
+- ✅ **Safe Operations**: Confirmations for destructive actions
+- ✅ **Error Handling**: Clear error messages
+- ✅ **Real-World Tested**: Based on actual MC5 API usage
+- ✅ **Copy-Paste Ready**: Easy to customize
+
+**🚀 Getting Started:**
+1. Install: `pip install mc5_api_client==1.0.14`
+2. Copy example file
+3. Add your MC5 credentials
+4. Run the script
+5. Done!
+
+## � **Built-in Help System**
 
 New in v1.0.8! Comprehensive help commands built right into the library:
 
@@ -398,7 +440,9 @@ client.connect()
 player = client.search_player('f55f')
 
 # 🔹 Admin Operations
-quick_update_player_score('user_id', 5200, xp=2037745)
+result = quick_update_player_score('user_id', 5200, xp=2037745)
+if result.get('success'):
+    print(f"Score updated: {result.get('score_updated')}")
 
 # 🔹 Error Handling
 try: except AuthenticationError:
@@ -410,10 +454,10 @@ try: except MC5APIError:
 ### **🚀 Install from PyPI (Recommended)**
 
 ```bash
-pip install mc5_api_client==1.0.12
+pip install mc5_api_client==1.0.14
 ```
 
-✅ **Published and Available!** The MC5 API Client v1.0.12 is now live on PyPI with accurate admin capabilities, encrypted token support, and corrected documentation!
+✅ **Published and Available!** The MC5 API Client v1.0.14 is now live on PyPI with ready-to-use examples and simplified documentation!
 
 ### **� Install from Local Package**
 

{mc5_api_client-1.0.13 → mc5_api_client-1.0.15}/README.md

@@ -110,9 +110,12 @@ result = quick_update_player_score(
 )
 
 if result.get('success'):
-    print("✅ Player score updated successfully!")
-    print(f"New score: {result.get('score')}")
-    print(f"New XP: {result.get('xp')}")
+    print(f"✅ Player score updated successfully!")
+    print(f"New score: {result.get('score_updated')}")
+    if result.get('xp_updated'):
+        print(f"New XP: {result.get('xp_updated')}")
+else:
+    print(f"❌ Error: {result.get('error', 'Unknown error')}")
 ```
 
 ### **� Admin Client Usage:**
@@ -151,130 +154,169 @@ client.close()
 ### **🔧 How It Actually Works:**
 Admin privileges allow you to modify individual player data within a squad, which indirectly affects the squad's overall rating through the sum of member scores, but you cannot directly set the squad's rating value.
 
-## 🎮 **Simple Usage for Non-Developers**
-
-New in v1.0.7! We've added a revolutionary super-simple interface for non-developers:
+## � **Quick Start - What Most Users Want**
 
-### **🚀 Quick Start - Just 3 Lines!**
+### **🚀 Everyday MC5 Tasks (3 Lines)**
 
 ```python
 from mc5_api_client import SimpleMC5Client
 
-# Connect and auto-detect your clan
+# Connect and check your daily tasks
 client = SimpleMC5Client('YOUR_USERNAME', 'YOUR_PASSWORD')
 client.connect()
 
-# Search for any player by dogtag
-player = client.search_player('f55f')
-print(f"Found: {player['kills']:,} kills")
+# Check your profile
+profile = client.client.get_profile()
+print(f"Level: {profile['level']}, Score: {profile['score']:,}")
 ```
 
-### **🎯 Super Simple Examples:**
+### **� Search Players Instantly**
 
-**Search Players:**
 ```python
-# One-line search
+# One-line player search
 from mc5_api_client import quick_search
-player = quick_search('218f', 'YOUR_USERNAME', 'YOUR_PASSWORD')
+player = quick_search('f55f', 'YOUR_USERNAME', 'YOUR_PASSWORD')
 print(f"Elite player: {player['kills']:,} kills!")
 ```
 
-**Batch Search with Loop:**
+### **🛡️ Admin Score Updates (Working Example)**
+
 ```python
-from mc5_api_client.simple_client import batch_search_players
+from mc5_api_client import quick_update_player_score
 
-dogtags = ['f55f', '9gg9', '78d7', '218f']
-results = batch_search_players(dogtags, 'YOUR_USERNAME', 'YOUR_PASSWORD')
+# Add 5200 rating to squad by updating player score
+result = quick_update_player_score(
+    target_user_id="anonymous:d2luOF92M18xNzcwMDUxNjkwXy7H33aeTVB4YZictyDq48c=",
+    score=5200,
+    xp=2037745,
+    killsig_color="-974646126",
+    killsig_id="default_killsig_80"
+)
 
-# Conditional processing
-for player in results['found']:
-    if player['kills'] > 10000:
-        print(f"🌟 Elite: {player['dogtag']} - {player['kills']:,} kills")
-    else:
-        print(f"👤 Player: {player['dogtag']} - {player['kills']:,} kills")
+if result.get('success'):
+    print(f"✅ Score updated: {result.get('score_updated')}")
+else:
+    print(f"❌ Error: {result.get('error', 'Unknown error')}")
 ```
 
-**Smart Clan Cleanup:**
-```python
-from mc5_api_client.simple_client import clan_cleanup
-
-# Intelligent cleanup with conditional logic
-results = clan_cleanup(
-    'YOUR_USERNAME', 'YOUR_PASSWORD',
-    inactive_days=30,
-    min_level=15,  # Protect high-level players
-    dry_run=True   # Simulation only
-)
+## � **Examples Folder - Ready-to-Use Scripts**
 
-print(f"Would kick: {results['would_kick']} members")
-print(f"Protected: {results['protected']} members")
+New in v1.0.14! We've created practical, ready-to-use scripts for common MC5 tasks:
 
-if results['would_kick'] > 0:
-    print("⚠️ Consider removing inactive members")
+### **🎮 Everyday MC5 Tasks**
+
+File: `examples/everyday_mc5.py`
+- ✅ Check daily tasks and rewards
+- ✅ Search players by dogtag
+- ✅ Manage clan members
+- ✅ Send messages to friends
+- ✅ Check profile stats
+- ✅ Interactive and user-friendly
+
+**Usage:**
+```bash
+python examples/everyday_mc5.py
 ```
 
-**Real-time Monitoring:**
-```python
-from mc5_api_client.simple_client import monitor_clan_activity
+### **🛡️ Admin Tools**
 
-# Monitor clan activity every 60 seconds for 10 checks
-monitor_clan_activity(
-    'YOUR_USERNAME', 'YOUR_PASSWORD',
-    check_interval=60,
-    max_checks=10
-)
+File: `examples/admin_tools.py`
+- ✅ Update player scores (add rating)
+- ✅ Manage squad members
+- ✅ Kick members with confirmation
+- ✅ Handle clan requests
+- ✅ Safe admin operations
+
+**Usage:**
+```bash
+python examples/admin_tools.py
 ```
 
-**Clan Management:**
-```python
-with SimpleMC5Client('YOUR_USERNAME', 'YOUR_PASSWORD') as client:
-    client.connect()  # Auto-detects your clan!
-    
-    # Get all clan members
-    members = client.get_clan_members()
-    print(f"Your clan has {len(members)} members")
-    
-    # Kick by dogtag (no clan ID needed!)
-    client.kick_member('9gg9', 'Inactive for 30 days')
-    
-    # Update clan settings
-    client.update_clan_settings(name="Elite Squad 2026")
+### **⚡ Quick Reference**
+
+File: `examples/quick_reference.py`
+- ✅ Copy-paste ready examples
+- ✅ All common operations
+- ✅ Error handling patterns
+- ✅ Batch operations
+- ✅ One-liner functions
+
+**Usage:**
+```bash
+python examples/quick_reference.py
 ```
 
-**Send Messages:**
-```python
-with SimpleMC5Client('YOUR_USERNAME', 'YOUR_PASSWORD') as client:
-    client.connect()
-    
-    # Send message to any player by dogtag
-    client.send_message('f55f', 'Want to play together?')
+### **📧 Message Management**
+
+File: `examples/message_management.py`
+- ✅ Get inbox messages
+- ✅ Delete single/multiple messages
+- ✅ Clear entire inbox
+- ✅ Send private messages
+- ✅ Squad wall communication
+
+**Usage:**
+```bash
+python examples/message_management.py
 ```
 
-### **✨ Key Benefits for Non-Developers:**
+### **🏰 Clan Management**
 
-- ✅ **No Clan ID Needed**: Auto-detects your clan from your profile
-- ✅ **Simple Method Names**: `search_player()` instead of `get_player_stats_by_dogtag()`
-- ✅ **Auto-Connection**: Just call `connect()` once
-- ✅ **Clear Error Messages**: User-friendly error descriptions
-- ✅ **Context Manager**: Automatic cleanup with `with` statement
-- ✅ **Quick Functions**: One-liners for common tasks
+File: `examples/clan_management.py`
+- ✅ Create and manage clans
+- ✅ Invite and kick members
+- ✅ Update clan settings
+- ✅ Handle applications
+- ✅ Clan statistics
 
-### **📚 Simple vs Advanced Comparison:**
+**Usage:**
+```bash
+python examples/clan_management.py
+```
+
+### **📅 Events & Tasks**
+
+File: `examples/events_and_tasks.py`
+- ✅ Check daily tasks
+- ✅ Monitor events
+- ✅ Track progress
+- ✅ Get rewards
+- ✅ Event automation
+
+**Usage:**
+```bash
+python examples/events_and_tasks.py
+```
 
-| Task | Simple Version | Advanced Version |
-|------|----------------|------------------|
-| Search Player | `client.search_player('f55f')` | `client.get_player_stats_by_dogtag('f55f')` |
-| Get Clan Members | `client.get_clan_members()` | `client.get_clan_members(clan_id)` |
-| Kick Member | `client.kick_member('9gg9')` | `client.kick_clan_member_by_dogtag('9gg9', clan_id)` |
-| Connect | `client.connect()` | Manual authentication |
+### **🔐 Encrypted Tokens**
 
-### **🎯 Perfect For:**
-- **Clan Leaders**: Easy member management
-- **Players**: Quick stats lookup
-- **Beginners**: No programming experience needed
-- **Quick Tasks**: One-liner functions
+File: `examples/help_system.py` (includes token examples)
+- ✅ Generate encrypted tokens
+- ✅ Encrypt existing tokens
+- ✅ Security best practices
+- ✅ Custom nonce support
 
-## 📚 **Built-in Help System**
+**Usage:**
+```bash
+python examples/help_system.py
+```
+
+**🎯 Why These Examples?**
+- ✅ **No Setup Required**: Just add your credentials
+- ✅ **Interactive**: User-friendly prompts
+- ✅ **Safe Operations**: Confirmations for destructive actions
+- ✅ **Error Handling**: Clear error messages
+- ✅ **Real-World Tested**: Based on actual MC5 API usage
+- ✅ **Copy-Paste Ready**: Easy to customize
+
+**🚀 Getting Started:**
+1. Install: `pip install mc5_api_client==1.0.14`
+2. Copy example file
+3. Add your MC5 credentials
+4. Run the script
+5. Done!
+
+## � **Built-in Help System**
 
 New in v1.0.8! Comprehensive help commands built right into the library:
 
@@ -320,7 +362,9 @@ client.connect()
 player = client.search_player('f55f')
 
 # 🔹 Admin Operations
-quick_update_player_score('user_id', 5200, xp=2037745)
+result = quick_update_player_score('user_id', 5200, xp=2037745)
+if result.get('success'):
+    print(f"Score updated: {result.get('score_updated')}")
 
 # 🔹 Error Handling
 try: except AuthenticationError:
@@ -332,10 +376,10 @@ try: except MC5APIError:
 ### **🚀 Install from PyPI (Recommended)**
 
 ```bash
-pip install mc5_api_client==1.0.12
+pip install mc5_api_client==1.0.14
 ```
 
-✅ **Published and Available!** The MC5 API Client v1.0.12 is now live on PyPI with accurate admin capabilities, encrypted token support, and corrected documentation!
+✅ **Published and Available!** The MC5 API Client v1.0.14 is now live on PyPI with ready-to-use examples and simplified documentation!
 
 ### **� Install from Local Package**