mc5-api-client 1.0.14__py3-none-any.whl → 1.0.15__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -15,7 +15,7 @@ messaging, and more.
15
15
 
16
16
  from typing import Optional, Dict, Any
17
17
 
18
- __version__ = "1.0.14"
18
+ __version__ = "1.0.15"
19
19
  __author__ = "Chizoba"
20
20
  __email__ = "chizoba2026@hotmail.com"
21
21
  __license__ = "MIT"
mc5_api_client/cli.py CHANGED
@@ -447,7 +447,7 @@ class MC5CLI:
447
447
 
448
448
  def _print_version(self):
449
449
  """Print version information."""
450
- self._print("MC5 API Client v1.0.14", "cyan")
450
+ self._print("MC5 API Client v1.0.15", "cyan")
451
451
  self._print("The ultimate Modern Combat 5 API library", "green")
452
452
  self._print("Author: Chizoba", "blue")
453
453
  self._print("Email: chizoba2026@hotmail.com", "blue")
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: mc5_api_client
3
- Version: 1.0.14
3
+ Version: 1.0.15
4
4
  Summary: A comprehensive Python library for interacting with the Modern Combat 5 API
5
5
  Home-page: https://pypi.org/project/mc5-api-client/
6
6
  Author: Chizoba
@@ -232,130 +232,169 @@ client.close()
232
232
  ### **🔧 How It Actually Works:**
233
233
  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.
234
234
 
235
- ## 🎮 **Simple Usage for Non-Developers**
235
+ ## **Quick Start - What Most Users Want**
236
236
 
237
- New in v1.0.7! We've added a revolutionary super-simple interface for non-developers:
238
-
239
- ### **🚀 Quick Start - Just 3 Lines!**
237
+ ### **🚀 Everyday MC5 Tasks (3 Lines)**
240
238
 
241
239
  ```python
242
240
  from mc5_api_client import SimpleMC5Client
243
241
 
244
- # Connect and auto-detect your clan
242
+ # Connect and check your daily tasks
245
243
  client = SimpleMC5Client('YOUR_USERNAME', 'YOUR_PASSWORD')
246
244
  client.connect()
247
245
 
248
- # Search for any player by dogtag
249
- player = client.search_player('f55f')
250
- print(f"Found: {player['kills']:,} kills")
246
+ # Check your profile
247
+ profile = client.client.get_profile()
248
+ print(f"Level: {profile['level']}, Score: {profile['score']:,}")
251
249
  ```
252
250
 
253
- ### **🎯 Super Simple Examples:**
251
+ ### **� Search Players Instantly**
254
252
 
255
- **Search Players:**
256
253
  ```python
257
- # One-line search
254
+ # One-line player search
258
255
  from mc5_api_client import quick_search
259
- player = quick_search('218f', 'YOUR_USERNAME', 'YOUR_PASSWORD')
256
+ player = quick_search('f55f', 'YOUR_USERNAME', 'YOUR_PASSWORD')
260
257
  print(f"Elite player: {player['kills']:,} kills!")
261
258
  ```
262
259
 
263
- **Batch Search with Loop:**
260
+ ### **🛡️ Admin Score Updates (Working Example)**
261
+
264
262
  ```python
265
- from mc5_api_client.simple_client import batch_search_players
263
+ from mc5_api_client import quick_update_player_score
266
264
 
267
- dogtags = ['f55f', '9gg9', '78d7', '218f']
268
- results = batch_search_players(dogtags, 'YOUR_USERNAME', 'YOUR_PASSWORD')
265
+ # Add 5200 rating to squad by updating player score
266
+ result = quick_update_player_score(
267
+ target_user_id="anonymous:d2luOF92M18xNzcwMDUxNjkwXy7H33aeTVB4YZictyDq48c=",
268
+ score=5200,
269
+ xp=2037745,
270
+ killsig_color="-974646126",
271
+ killsig_id="default_killsig_80"
272
+ )
269
273
 
270
- # Conditional processing
271
- for player in results['found']:
272
- if player['kills'] > 10000:
273
- print(f"🌟 Elite: {player['dogtag']} - {player['kills']:,} kills")
274
- else:
275
- print(f"👤 Player: {player['dogtag']} - {player['kills']:,} kills")
274
+ if result.get('success'):
275
+ print(f"✅ Score updated: {result.get('score_updated')}")
276
+ else:
277
+ print(f" Error: {result.get('error', 'Unknown error')}")
276
278
  ```
277
279
 
278
- **Smart Clan Cleanup:**
279
- ```python
280
- from mc5_api_client.simple_client import clan_cleanup
281
-
282
- # Intelligent cleanup with conditional logic
283
- results = clan_cleanup(
284
- 'YOUR_USERNAME', 'YOUR_PASSWORD',
285
- inactive_days=30,
286
- min_level=15, # Protect high-level players
287
- dry_run=True # Simulation only
288
- )
280
+ ## � **Examples Folder - Ready-to-Use Scripts**
289
281
 
290
- print(f"Would kick: {results['would_kick']} members")
291
- print(f"Protected: {results['protected']} members")
282
+ New in v1.0.14! We've created practical, ready-to-use scripts for common MC5 tasks:
292
283
 
293
- if results['would_kick'] > 0:
294
- print("⚠️ Consider removing inactive members")
284
+ ### **🎮 Everyday MC5 Tasks**
285
+
286
+ File: `examples/everyday_mc5.py`
287
+ - ✅ Check daily tasks and rewards
288
+ - ✅ Search players by dogtag
289
+ - ✅ Manage clan members
290
+ - ✅ Send messages to friends
291
+ - ✅ Check profile stats
292
+ - ✅ Interactive and user-friendly
293
+
294
+ **Usage:**
295
+ ```bash
296
+ python examples/everyday_mc5.py
295
297
  ```
296
298
 
297
- **Real-time Monitoring:**
298
- ```python
299
- from mc5_api_client.simple_client import monitor_clan_activity
299
+ ### **🛡️ Admin Tools**
300
300
 
301
- # Monitor clan activity every 60 seconds for 10 checks
302
- monitor_clan_activity(
303
- 'YOUR_USERNAME', 'YOUR_PASSWORD',
304
- check_interval=60,
305
- max_checks=10
306
- )
301
+ File: `examples/admin_tools.py`
302
+ - ✅ Update player scores (add rating)
303
+ - ✅ Manage squad members
304
+ - ✅ Kick members with confirmation
305
+ - ✅ Handle clan requests
306
+ - ✅ Safe admin operations
307
+
308
+ **Usage:**
309
+ ```bash
310
+ python examples/admin_tools.py
307
311
  ```
308
312
 
309
- **Clan Management:**
310
- ```python
311
- with SimpleMC5Client('YOUR_USERNAME', 'YOUR_PASSWORD') as client:
312
- client.connect() # Auto-detects your clan!
313
-
314
- # Get all clan members
315
- members = client.get_clan_members()
316
- print(f"Your clan has {len(members)} members")
317
-
318
- # Kick by dogtag (no clan ID needed!)
319
- client.kick_member('9gg9', 'Inactive for 30 days')
320
-
321
- # Update clan settings
322
- client.update_clan_settings(name="Elite Squad 2026")
313
+ ### **⚡ Quick Reference**
314
+
315
+ File: `examples/quick_reference.py`
316
+ - ✅ Copy-paste ready examples
317
+ - ✅ All common operations
318
+ - Error handling patterns
319
+ - Batch operations
320
+ - One-liner functions
321
+
322
+ **Usage:**
323
+ ```bash
324
+ python examples/quick_reference.py
323
325
  ```
324
326
 
325
- **Send Messages:**
326
- ```python
327
- with SimpleMC5Client('YOUR_USERNAME', 'YOUR_PASSWORD') as client:
328
- client.connect()
329
-
330
- # Send message to any player by dogtag
331
- client.send_message('f55f', 'Want to play together?')
327
+ ### **📧 Message Management**
328
+
329
+ File: `examples/message_management.py`
330
+ - ✅ Get inbox messages
331
+ - ✅ Delete single/multiple messages
332
+ - Clear entire inbox
333
+ - Send private messages
334
+ - ✅ Squad wall communication
335
+
336
+ **Usage:**
337
+ ```bash
338
+ python examples/message_management.py
332
339
  ```
333
340
 
334
- ### **✨ Key Benefits for Non-Developers:**
341
+ ### **🏰 Clan Management**
335
342
 
336
- - ✅ **No Clan ID Needed**: Auto-detects your clan from your profile
337
- - ✅ **Simple Method Names**: `search_player()` instead of `get_player_stats_by_dogtag()`
338
- - ✅ **Auto-Connection**: Just call `connect()` once
339
- - ✅ **Clear Error Messages**: User-friendly error descriptions
340
- - ✅ **Context Manager**: Automatic cleanup with `with` statement
341
- - ✅ **Quick Functions**: One-liners for common tasks
343
+ File: `examples/clan_management.py`
344
+ - ✅ Create and manage clans
345
+ - ✅ Invite and kick members
346
+ - ✅ Update clan settings
347
+ - ✅ Handle applications
348
+ - ✅ Clan statistics
342
349
 
343
- ### **📚 Simple vs Advanced Comparison:**
350
+ **Usage:**
351
+ ```bash
352
+ python examples/clan_management.py
353
+ ```
354
+
355
+ ### **📅 Events & Tasks**
356
+
357
+ File: `examples/events_and_tasks.py`
358
+ - ✅ Check daily tasks
359
+ - ✅ Monitor events
360
+ - ✅ Track progress
361
+ - ✅ Get rewards
362
+ - ✅ Event automation
363
+
364
+ **Usage:**
365
+ ```bash
366
+ python examples/events_and_tasks.py
367
+ ```
368
+
369
+ ### **🔐 Encrypted Tokens**
370
+
371
+ File: `examples/help_system.py` (includes token examples)
372
+ - ✅ Generate encrypted tokens
373
+ - ✅ Encrypt existing tokens
374
+ - ✅ Security best practices
375
+ - ✅ Custom nonce support
376
+
377
+ **Usage:**
378
+ ```bash
379
+ python examples/help_system.py
380
+ ```
344
381
 
345
- | Task | Simple Version | Advanced Version |
346
- |------|----------------|------------------|
347
- | Search Player | `client.search_player('f55f')` | `client.get_player_stats_by_dogtag('f55f')` |
348
- | Get Clan Members | `client.get_clan_members()` | `client.get_clan_members(clan_id)` |
349
- | Kick Member | `client.kick_member('9gg9')` | `client.kick_clan_member_by_dogtag('9gg9', clan_id)` |
350
- | Connect | `client.connect()` | Manual authentication |
382
+ **🎯 Why These Examples?**
383
+ - ✅ **No Setup Required**: Just add your credentials
384
+ - **Interactive**: User-friendly prompts
385
+ - **Safe Operations**: Confirmations for destructive actions
386
+ - **Error Handling**: Clear error messages
387
+ - **Real-World Tested**: Based on actual MC5 API usage
388
+ - ✅ **Copy-Paste Ready**: Easy to customize
351
389
 
352
- ### **🎯 Perfect For:**
353
- - **Clan Leaders**: Easy member management
354
- - **Players**: Quick stats lookup
355
- - **Beginners**: No programming experience needed
356
- - **Quick Tasks**: One-liner functions
390
+ **🚀 Getting Started:**
391
+ 1. Install: `pip install mc5_api_client==1.0.14`
392
+ 2. Copy example file
393
+ 3. Add your MC5 credentials
394
+ 4. Run the script
395
+ 5. Done!
357
396
 
358
- ## 📚 **Built-in Help System**
397
+ ## **Built-in Help System**
359
398
 
360
399
  New in v1.0.8! Comprehensive help commands built right into the library:
361
400
 
@@ -418,7 +457,7 @@ try: except MC5APIError:
418
457
  pip install mc5_api_client==1.0.14
419
458
  ```
420
459
 
421
- ✅ **Published and Available!** The MC5 API Client v1.0.14 is now live on PyPI with corrected documentation and working examples!
460
+ ✅ **Published and Available!** The MC5 API Client v1.0.14 is now live on PyPI with ready-to-use examples and simplified documentation!
422
461
 
423
462
  ### **� Install from Local Package**
424
463
 
@@ -1,15 +1,15 @@
1
- mc5_api_client/__init__.py,sha256=Bizlq_XQ4w9JUOXNCm-ozxPWzi8OAbcW4tkzPkjJAms,3296
1
+ mc5_api_client/__init__.py,sha256=Y8JWDAVjx-RMveEDkvoZVNiHwjNnEt80JEVmzqUUMaM,3296
2
2
  mc5_api_client/admin_client.py,sha256=527aavolxVhY2M5ceFxVbbE5YTczU9Z86Fdt1UzdRZM,15220
3
3
  mc5_api_client/auth.py,sha256=z8vmyQIHUdAzk0pUyKCesT8gTv4jboLIFGBxAu1v_-8,13396
4
- mc5_api_client/cli.py,sha256=Kb44ZTM-wAPehmWCY9owXzHQ3B3Mcz8_v4-UUDO9yXM,17255
4
+ mc5_api_client/cli.py,sha256=zgAfBANZo06oDjNyzhWiI5S5hKinDCDcnged6g2RApQ,17255
5
5
  mc5_api_client/client.py,sha256=1UYaX8UVl_edf-uRh-H_ja5BUWz1ytw52BdOKLuZq0I,80571
6
6
  mc5_api_client/exceptions.py,sha256=o7od4GrEIlgq6xSNUjZdh74xoDTytF3PLcMq5ewRiJw,2683
7
7
  mc5_api_client/help.py,sha256=sqf3R6VHQuSYLvAMzh8nXAgCX5URsvXydvw8P0ATabg,7246
8
8
  mc5_api_client/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
9
9
  mc5_api_client/simple_client.py,sha256=1sVytpSU-TMyDBOe1y_3Y6KjIc8tsZGWdI1eHIUmhmc,23747
10
- mc5_api_client-1.0.14.dist-info/licenses/LICENSE,sha256=M0UBQ4B3pB9XcV54_jhVP681xyauF8GB6YK_rKmuXzk,1064
11
- mc5_api_client-1.0.14.dist-info/METADATA,sha256=t_Jm0N8fZd3TPVWeaAG2MDKvyeVtMhJl0uvaSNuNmtI,55436
12
- mc5_api_client-1.0.14.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
13
- mc5_api_client-1.0.14.dist-info/entry_points.txt,sha256=2kruOpleFYK3Jl1MoQwGyqCd-Pj4kQWngXmIjnXx_gE,48
14
- mc5_api_client-1.0.14.dist-info/top_level.txt,sha256=eYJe4ue9j1ig_jFY5Z05mDqpizUEV7TYpk5lBXVd4kA,15
15
- mc5_api_client-1.0.14.dist-info/RECORD,,
10
+ mc5_api_client-1.0.15.dist-info/licenses/LICENSE,sha256=M0UBQ4B3pB9XcV54_jhVP681xyauF8GB6YK_rKmuXzk,1064
11
+ mc5_api_client-1.0.15.dist-info/METADATA,sha256=BqJrMgqyGn1_BPV8uxXoULsD7kSpLm1_yR4tYl2gm9E,55416
12
+ mc5_api_client-1.0.15.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
13
+ mc5_api_client-1.0.15.dist-info/entry_points.txt,sha256=2kruOpleFYK3Jl1MoQwGyqCd-Pj4kQWngXmIjnXx_gE,48
14
+ mc5_api_client-1.0.15.dist-info/top_level.txt,sha256=eYJe4ue9j1ig_jFY5Z05mDqpizUEV7TYpk5lBXVd4kA,15
15
+ mc5_api_client-1.0.15.dist-info/RECORD,,