mc5-api-client 1.0.2__tar.gz → 1.0.3__tar.gz

{mc5_api_client-1.0.2 → mc5_api_client-1.0.3}/CHANGELOG.md

@@ -19,8 +19,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - Messaging system
   - Events and tasks
   - Leaderboard access
-  - Game configuration
-  - Alias and dogtag utilities
+  - Game objects
+  - Asset metadata
+  - Alias lookup
 - Automatic token refresh functionality
 - Comprehensive error handling with custom exceptions
 - Type hints throughout the codebase

{mc5_api_client-1.0.2 → mc5_api_client-1.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mc5_api_client
-Version: 1.0.2
+Version: 1.0.3
 Summary: A comprehensive Python library for interacting with the Modern Combat 5 API
 Home-page: https://pypi.org/project/mc5-api-client/
 Author: Chizoba
@@ -122,13 +122,6 @@ pip install .
 
 ### 🔧 Build Status
 
-✅ **Compilation Successful** - No critical errors  
-⚠️ **Warnings Fixed** - Configuration warnings resolved  
-✅ **All Examples Included** - 7 comprehensive example scripts  
-✅ **CLI Entry Points** - `mc5` command available  
-✅ **Dependencies Managed** - All requirements included  
-
-## �� Let's Get Started!
 
 ### Step 1: Install the Library
 
@@ -138,24 +131,31 @@ Just run this in your terminal (Command Prompt/PowerShell):
 pip install mc5_api_client
 ```
 
-That's it! 🎉 You're ready to go!
+### Step 2: Verify Installation
+
+```bash
+# Check the CLI
+mc5 --help
+mc5 version
+
+# Test in Python
+python -c "import mc5_api_client; print('✅ MC5 API Client ready!')"
+```
 
-### Step 2: Your First Program
+### Step 3: Your First Program
 
-Let's write a simple Python script to connect to MC5:
+Copy and paste this simple example to get started:
 
 ```python
+# Save this as my_mc5_script.py
 from mc5_api_client import MC5Client
 
-# Create a client and login
-client = MC5Client(
-    username="YOUR_USERNAME_HERE",
-    password="YOUR_PASSWORD_HERE"
-)
+# Replace with your actual credentials
+username = "YOUR_USERNAME_HERE"
+password = "YOUR_PASSWORD_HERE"
 
-# Check your profile
-profile = client.get_profile()
-print(f"Hey {profile['name']}! You're level {profile['level']}")
+# Create client and login
+client = MC5Client(username=username, password=password)
 
 # See what's happening in the game
 events = client.get_events()
@@ -941,6 +941,7 @@ The library comes with comprehensive examples to get you started:
 - `examples/squad_wall_management.py` - Squad wall communication examples
 - `examples/private_messaging.py` - Private messaging and inbox management
 - `examples/message_management.py` - Advanced message management and bulk deletion
+- `examples/advanced_features.py` - Events, account management, alias system, game config
 
 ### 🚀 Advanced Examples
 - Squad management bot with automated updates
@@ -988,6 +989,45 @@ The library comes with comprehensive examples to get you started:
 - ✅ Bulk stat updates
 - ✅ Real-time activity monitoring
 
+### � Events API (10+ Methods)
+- ✅ Get all active and upcoming events
+- ✅ Filter events by type and status
+- ✅ Get detailed event information with tasks and milestones
+- ✅ Parse event templates and extract rewards
+- ✅ Get daily tasks with progress tracking
+- ✅ Get squad events and tournament information
+- ✅ Calculate event rewards based on current points
+- ✅ Track event progress and next milestones
+- ✅ Extract task conditions and reward types
+- ✅ Support for multiple event categories
+
+### 👤 Account Management (5+ Methods)
+- ✅ Import account data from other platforms
+- ✅ Link accounts across different platforms
+- ✅ Get detailed account information
+- ✅ Unlink platform accounts
+- ✅ Migrate account data between platforms
+- ✅ Support for cross-platform data transfer
+- ✅ Account verification and validation
+
+### 🏷️ Alias/Dogtags System (4+ Methods)
+- ✅ Convert dogtags to alias format
+- ✅ Convert aliases back to dogtags
+- ✅ Get player information using alias/dogtag
+- ✅ Search for players by alias
+- ✅ Support for hexadecimal player IDs
+- ✅ Automatic format detection
+- ✅ Mathematical conversion algorithms
+
+### ⚙️ Game Configuration (4+ Methods)
+- ✅ Get asset hash metadata
+- ✅ Get game object catalog
+- ✅ Get service URLs for current region
+- ✅ Get comprehensive game configuration
+- ✅ Support for multiple config types
+- ✅ Asset metadata tracking
+- ✅ Service URL management
+- ✅ Game object categorization
 ### 💬 Complete Communication System (6+ Methods)
 - ✅ Send private messages with rich formatting
 - ✅ Include kill signatures and colors
@@ -1099,18 +1139,20 @@ Stuck on something? No worries!
 
 ## 🔗 Useful Links
 
-This is the **most comprehensive Modern Combat 5 API library** ever created! With **70+ methods** across **10 major categories**, you can:
+This is the **most comprehensive Modern Combat 5 API library** ever created! With **95+ methods** across **14 major categories**, you can:
 
 - 🏰 **Manage entire clans** from creation to disbandment
 - 👥 **Control squad members** with real-time stat updates
 - 💬 **Complete communication system** - Private messages, squad wall, alerts
+- 📅 **Advanced events system** - Daily tasks, squad events, milestones
+- 👤 **Account management** - Import, link, migrate across platforms
+- 🏷️ **Alias/dogtags system** - Player ID conversion and search
+- ⚙️ **Game configuration** - Assets, catalogs, service URLs
 - 🎯 **Customize everything** with kill signatures and rich formatting
 - 📊 **Track performance** with detailed analytics
 - 🎮 **Automate gameplay** with custom bots and scripts
 - 🏆 **Create leaderboards** and ranking systems
 - 🔄 **Schedule tasks** and monitor activity
-- 📱 **Manage messages** with inbox and reply systems
-
 
 **Perfect for:**
 - 🏆 Squad leaders who want to automate management
@@ -1121,6 +1163,8 @@ This is the **most comprehensive Modern Combat 5 API library** ever created! Wit
 - 🏅 Competitive players seeking advantages
 - 💬 Community managers handling communications
 - 📧 Support teams providing assistance
+- 📅 Event coordinators managing tournaments
+- 🏷️ Player search and identification systems
 
 **Ready to dominate Modern Combat 5?** 🚀
 

{mc5_api_client-1.0.2 → mc5_api_client-1.0.3}/README.md

@@ -63,13 +63,6 @@ pip install .
 
 ### 🔧 Build Status
 
-✅ **Compilation Successful** - No critical errors  
-⚠️ **Warnings Fixed** - Configuration warnings resolved  
-✅ **All Examples Included** - 7 comprehensive example scripts  
-✅ **CLI Entry Points** - `mc5` command available  
-✅ **Dependencies Managed** - All requirements included  
-
-## �� Let's Get Started!
 
 ### Step 1: Install the Library
 
@@ -79,24 +72,31 @@ Just run this in your terminal (Command Prompt/PowerShell):
 pip install mc5_api_client
 ```
 
-That's it! 🎉 You're ready to go!
+### Step 2: Verify Installation
+
+```bash
+# Check the CLI
+mc5 --help
+mc5 version
+
+# Test in Python
+python -c "import mc5_api_client; print('✅ MC5 API Client ready!')"
+```
 
-### Step 2: Your First Program
+### Step 3: Your First Program
 
-Let's write a simple Python script to connect to MC5:
+Copy and paste this simple example to get started:
 
 ```python
+# Save this as my_mc5_script.py
 from mc5_api_client import MC5Client
 
-# Create a client and login
-client = MC5Client(
-    username="YOUR_USERNAME_HERE",
-    password="YOUR_PASSWORD_HERE"
-)
+# Replace with your actual credentials
+username = "YOUR_USERNAME_HERE"
+password = "YOUR_PASSWORD_HERE"
 
-# Check your profile
-profile = client.get_profile()
-print(f"Hey {profile['name']}! You're level {profile['level']}")
+# Create client and login
+client = MC5Client(username=username, password=password)
 
 # See what's happening in the game
 events = client.get_events()
@@ -882,6 +882,7 @@ The library comes with comprehensive examples to get you started:
 - `examples/squad_wall_management.py` - Squad wall communication examples
 - `examples/private_messaging.py` - Private messaging and inbox management
 - `examples/message_management.py` - Advanced message management and bulk deletion
+- `examples/advanced_features.py` - Events, account management, alias system, game config
 
 ### 🚀 Advanced Examples
 - Squad management bot with automated updates
@@ -929,6 +930,45 @@ The library comes with comprehensive examples to get you started:
 - ✅ Bulk stat updates
 - ✅ Real-time activity monitoring
 
+### � Events API (10+ Methods)
+- ✅ Get all active and upcoming events
+- ✅ Filter events by type and status
+- ✅ Get detailed event information with tasks and milestones
+- ✅ Parse event templates and extract rewards
+- ✅ Get daily tasks with progress tracking
+- ✅ Get squad events and tournament information
+- ✅ Calculate event rewards based on current points
+- ✅ Track event progress and next milestones
+- ✅ Extract task conditions and reward types
+- ✅ Support for multiple event categories
+
+### 👤 Account Management (5+ Methods)
+- ✅ Import account data from other platforms
+- ✅ Link accounts across different platforms
+- ✅ Get detailed account information
+- ✅ Unlink platform accounts
+- ✅ Migrate account data between platforms
+- ✅ Support for cross-platform data transfer
+- ✅ Account verification and validation
+
+### 🏷️ Alias/Dogtags System (4+ Methods)
+- ✅ Convert dogtags to alias format
+- ✅ Convert aliases back to dogtags
+- ✅ Get player information using alias/dogtag
+- ✅ Search for players by alias
+- ✅ Support for hexadecimal player IDs
+- ✅ Automatic format detection
+- ✅ Mathematical conversion algorithms
+
+### ⚙️ Game Configuration (4+ Methods)
+- ✅ Get asset hash metadata
+- ✅ Get game object catalog
+- ✅ Get service URLs for current region
+- ✅ Get comprehensive game configuration
+- ✅ Support for multiple config types
+- ✅ Asset metadata tracking
+- ✅ Service URL management
+- ✅ Game object categorization
 ### 💬 Complete Communication System (6+ Methods)
 - ✅ Send private messages with rich formatting
 - ✅ Include kill signatures and colors
@@ -1040,18 +1080,20 @@ Stuck on something? No worries!
 
 ## 🔗 Useful Links
 
-This is the **most comprehensive Modern Combat 5 API library** ever created! With **70+ methods** across **10 major categories**, you can:
+This is the **most comprehensive Modern Combat 5 API library** ever created! With **95+ methods** across **14 major categories**, you can:
 
 - 🏰 **Manage entire clans** from creation to disbandment
 - 👥 **Control squad members** with real-time stat updates
 - 💬 **Complete communication system** - Private messages, squad wall, alerts
+- 📅 **Advanced events system** - Daily tasks, squad events, milestones
+- 👤 **Account management** - Import, link, migrate across platforms
+- 🏷️ **Alias/dogtags system** - Player ID conversion and search
+- ⚙️ **Game configuration** - Assets, catalogs, service URLs
 - 🎯 **Customize everything** with kill signatures and rich formatting
 - 📊 **Track performance** with detailed analytics
 - 🎮 **Automate gameplay** with custom bots and scripts
 - 🏆 **Create leaderboards** and ranking systems
 - 🔄 **Schedule tasks** and monitor activity
-- 📱 **Manage messages** with inbox and reply systems
-
 
 **Perfect for:**
 - 🏆 Squad leaders who want to automate management
@@ -1062,6 +1104,8 @@ This is the **most comprehensive Modern Combat 5 API library** ever created! Wit
 - 🏅 Competitive players seeking advantages
 - 💬 Community managers handling communications
 - 📧 Support teams providing assistance
+- 📅 Event coordinators managing tournaments
+- 🏷️ Player search and identification systems
 
 **Ready to dominate Modern Combat 5?** 🚀
 

mc5_api_client-1.0.3/examples/advanced_features.py

@@ -0,0 +1,269 @@
+#!/usr/bin/env python3
+# ────────────[ CHIZOBA ]────────────────────────────
+# | Email    : chizoba2026@hotmail.com
+# | File     : advanced_features.py
+# | License  : MIT License © 2026 Chizoba
+# | Brief    : Advanced MC5 API features demonstration
+# ────────────────★─────────────────────────────────
+
+"""
+Advanced MC5 API Features Demonstration
+This script showcases the new advanced features:
+- Events API (daily tasks, squad events, milestones)
+- Account Management (import, link, migrate)
+- Alias/Dogtags System (player ID conversion)
+- Game Configuration (assets, catalogs, URLs)
+"""
+
+import time
+from datetime import datetime
+from mc5_api_client import MC5Client
+from mc5_api_client.exceptions import MC5APIError
+
+def main():
+    """Main demonstration of advanced MC5 API features."""
+    
+    print("🚀 MC5 API Advanced Features Demonstration")
+    print("=" * 60)
+    
+    # Initialize client with your credentials
+    try:
+        client = MC5Client(
+            username="YOUR_USERNAME_HERE",
+            password="YOUR_PASSWORD_HERE"
+        )
+        print("✅ Successfully connected to MC5 API!")
+        
+    except Exception as e:
+        print(f"❌ Failed to connect: {e}")
+        return
+    
+    # 1. Events API Demonstration
+    print("\n📅 Events API Demonstration")
+    print("-" * 40)
+    
+    try:
+        # Get all events
+        events = client.get_events()
+        print(f"📊 Found {len(events)} active events")
+        
+        # Get daily tasks
+        daily_tasks = client.get_daily_tasks()
+        if daily_tasks:
+            print(f"🎯 Daily Tasks Event: {daily_tasks.get('name', 'Unknown')}")
+            print(f"📝 Tasks: {len(daily_tasks.get('tasks', []))}")
+            print(f"🏆 Milestones: {len(daily_tasks.get('milestones', []))}")
+            
+            # Show first few tasks
+            for i, task in enumerate(daily_tasks.get('tasks', [])[:3], 1):
+                print(f"   {i}. {task.get('condition_type', 'unknown')} - {task.get('points', 0)} points")
+        
+        # Get squad events
+        squad_events = client.get_squad_events()
+        print(f"👥 Squad Events: {len(squad_events)}")
+        
+        for event in squad_events[:2]:  # Show first 2 squad events
+            print(f"   🎮 {event.get('name', 'Unknown')}")
+            print(f"   📅 Status: {event.get('status', 'unknown')}")
+            if event.get('tournament_info'):
+                print(f"   🏆 Tournament: {event.get('tournament_info', {}).get('type', 'unknown')}")
+        
+        # Calculate rewards for an event
+        if daily_tasks:
+            rewards = client.calculate_event_rewards(daily_tasks.get('name', ''), 50)
+            print(f"💰 Rewards at 50 points: {len(rewards.get('available_milestones', []))} milestones")
+            
+    except Exception as e:
+        print(f"❌ Events API error: {e}")
+    
+    # 2. Account Management Demonstration
+    print("\n👤 Account Management Demonstration")
+    print("-" * 40)
+    
+    try:
+        # Get account info
+        account_info = client.get_account_info()
+        print(f"📊 Account Name: {account_info.get('name', 'Unknown')}")
+        print(f"🎮 Level: {account_info.get('level', 'Unknown')}")
+        print(f"💰 Credits: {account_info.get('credits', 'Unknown')}")
+        
+        # Demonstrate account linking (placeholder)
+        print("🔗 Account Linking:")
+        print("   ✅ Link account functionality available")
+        print("   ✅ Account migration functionality available")
+        print("   ✅ Account unlink functionality available")
+        
+        # Note: Actual linking would require real credentials and secrets
+        print("   ⚠️  Actual linking requires valid platform credentials")
+        
+    except Exception as e:
+        print(f"❌ Account management error: {e}")
+    
+    # 3. Alias/Dogtags System Demonstration
+    print("\n🏷️ Alias/Dogtags System Demonstration")
+    print("-" * 40)
+    
+    try:
+        # Demonstrate dogtag to alias conversion
+        test_dogtags = ["f55f", "ff11", "g6765", "1234", "abcd"]
+        
+        print("🔄 Dogtag to Alias Conversion:")
+        for dogtag in test_dogtags:
+            alias = client.convert_dogtag_to_alias(dogtag)
+            print(f"   {dogtag} → {alias}")
+        
+        print("\n🔄 Alias to Dogtag Conversion:")
+        for dogtag in test_dogtags:
+            alias = client.convert_dogtag_to_alias(dogtag)
+            back_to_dogtag = client.convert_alias_to_dogtag(alias)
+            print(f"   {alias} → {back_to_dogtag}")
+        
+        # Test alias lookup (with a common alias)
+        test_alias = "d33d"  # Common test alias
+        print(f"\n🔍 Looking up alias: {test_alias}")
+        
+        try:
+            alias_info = client.get_alias_info(test_alias)
+            print(f"   📊 Type: {alias_info.get('type', 'Unknown')}")
+            print(f"   🆔 Account: {alias_info.get('account', 'Unknown')}")
+            print(f"   👤 Credential: {alias_info.get('credential', 'Unknown')[:20]}...")
+        except Exception as e:
+            print(f"   ⚠️  Alias lookup failed: {e}")
+        
+    except Exception as e:
+        print(f"❌ Alias system error: {e}")
+    
+    # 4. Game Configuration Demonstration
+    print("\n⚙️ Game Configuration Demonstration")
+    print("-" * 40)
+    
+    try:
+        # Get service URLs
+        service_urls = client.get_service_urls()
+        print("🌐 Service URLs:")
+        for service, url in service_urls.items():
+            print(f"   {service}: {url}")
+        
+        # Get basic game config
+        basic_config = client.get_game_config("basic")
+        print(f"\n📊 Basic Config:")
+        print(f"   🆔 Client ID: {basic_config.get('client_id', 'Unknown')}")
+        print(f"   🌐 Services: {len(basic_config.get('service_urls', {}))}")
+        
+        # Get asset metadata (example)
+        asset_path = "videos_HD_UPD18_pvx"
+        print(f"\n📹 Asset Metadata for: {asset_path}")
+        
+        try:
+            asset_metadata = client.get_asset_metadata(asset_path)
+            print(f"   🔑 Hash: {asset_metadata.get('hash', 'Unknown')}")
+        except Exception as e:
+            print(f"   ⚠️  Asset metadata not available: {e}")
+        
+        # Get game object catalog
+        print(f"\n📦 Game Object Catalog:")
+        try:
+            game_objects = client.get_game_object_catalog()
+            print(f"   📊 Total Objects: {len(game_objects)}")
+            
+            # Show first few object types
+            object_types = set()
+            for obj in game_objects[:10]:  # First 10 objects
+                object_types.add(obj.get('category', 'unknown'))
+            
+            print(f"   🏷️  Object Types: {', '.join(list(object_types)[:5])}")
+            
+        except Exception as e:
+            print(f"   ⚠️  Game object catalog not available: {e}")
+        
+    except Exception as e:
+        print(f"❌ Game configuration error: {e}")
+    
+    # 5. Advanced Usage Examples
+    print("\n🎯 Advanced Usage Examples")
+    print("-" * 40)
+    
+    try:
+        # Example 1: Event Progress Tracker
+        print("📈 Event Progress Tracker:")
+        if daily_tasks:
+            current_points = 75  # Simulated current points
+            rewards = client.calculate_event_rewards(daily_tasks.get('name', ''), current_points)
+            
+            print(f"   📊 Current Points: {current_points}")
+            print(f"   🏆 Available Milestones: {len(rewards.get('available_milestones', []))}")
+            
+            next_milestone = rewards.get('next_milestone', {})
+            if next_milestone:
+                needed = next_milestone.get('condition', 0) - current_points
+                print(f"   🎯 Next Milestone: {needed} points needed")
+        
+        # Example 2: Player Search System
+        print("\n🔍 Player Search System:")
+        test_aliases = ["d33d", "e44e", "f55f"]  # Test aliases
+        
+        for alias in test_aliases:
+            try:
+                player_info = client.search_player_by_alias(alias)
+                if player_info.get('account'):
+                    print(f"   ✅ Found player: {player_info.get('account', 'Unknown')}")
+                else:
+                    print(f"   ❌ Player not found: {alias}")
+            except:
+                print(f"   ⚠️  Could not search: {alias}")
+        
+        # Example 3: Configuration Monitor
+        print("\n🔧 Configuration Monitor:")
+        config = client.get_game_config("all")
+        print(f"   🌐 Active Services: {len(config.get('service_urls', {}))}")
+        print(f"   📦 Game Objects: {'Available' if config.get('game_objects') else 'Not Available'}")
+        print(f"   📹 Asset Metadata: {config.get('asset_metadata', 'Not Available')}")
+        
+    except Exception as e:
+        print(f"❌ Advanced usage error: {e}")
+    
+    # 6. Performance Tips
+    print("\n💡 Performance Tips")
+    print("-" * 40)
+    print("🚀 Use context managers for automatic cleanup:")
+    print("   with MC5Client(username, password) as client:")
+    print("       # Your code here")
+    print("       # Automatically closes connection")
+    print()
+    print("📊 Cache event data to avoid repeated API calls:")
+    print("   events = client.get_events()  # Call once")
+    print("   # Use cached events_data for operations")
+    print()
+    print("🔄 Use batch operations where possible:")
+    print("   # Process multiple aliases in one loop")
+    print("   # Calculate rewards for multiple events")
+    print()
+    print("⚡ Handle errors gracefully:")
+    print("   try:")
+    print("       result = client.get_events()")
+    print("   except MC5APIError as e:")
+    print("       print(f\"API Error: {e}\")")
+    print("       # Fallback handling")
+    
+    # Clean up
+    print("\n🧹 Cleaning up...")
+    try:
+        client.close()
+        print("✅ Connection closed successfully!")
+        
+    except Exception as e:
+        print(f"⚠️  Error during cleanup: {e}")
+    
+    print("\n🎉 Advanced Features Demonstration Complete!")
+    print("\n📚 What You Learned:")
+    print("   📅 Events API - Daily tasks, squad events, milestones")
+    print("   👤 Account Management - Import, link, migrate accounts")
+    print("   🏷️ Alias System - Convert dogtags, search players")
+    print("   ⚙️ Game Config - Assets, catalogs, service URLs")
+    print("   🎯 Advanced Usage - Progress tracking, search, monitoring")
+    print("   💡 Performance Tips - Best practices for efficient usage")
+    
+    print("\n🎮 Ready to build advanced MC5 applications!")
+
+if __name__ == "__main__":
+    main()

{mc5_api_client-1.0.2 → mc5_api_client-1.0.3}/pyproject.toml

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

{mc5_api_client-1.0.2 → mc5_api_client-1.0.3}/setup.py

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