mcm-cli 1.6.1__py3-none-any.whl → 1.7.1__py3-none-any.whl

{mcm_cli-1.6.1.dist-info → mcm_cli-1.7.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mcm-cli
-Version: 1.6.1
+Version: 1.7.1
 Summary: A command-line interface for Moloco Commerde Media
 Home-page: https://github.com/moloco-mcm/mcm-cli
 Author: Moloco MCM Team

{mcm_cli-1.6.1.dist-info → mcm_cli-1.7.1.dist-info}/RECORD

@@ -1,13 +1,13 @@
 mcmcli/__init__.py,sha256=-U6lMZ9_99IXAKwnqnYXYr6NcO6TSmG-kxewgvJjU4k,575
-mcmcli/__main__.py,sha256=8Bwhb-VptKSRYlH1LwgGgKZ8pzdc51zSunv9d2cPI0k,1844
+mcmcli/__main__.py,sha256=J1wszWrZ7eii0SNqtJg9S75ElgQPp8ivpswiJBYjE_s,1844
 mcmcli/logging.py,sha256=xjRS5ey1ONx_d34qB1Fetb_SwPysoh2hzNDuNAaYYWQ,1739
 mcmcli/requests.py,sha256=IuySBQ8P_GoGF3f_TRysfgQNOhi2n9M84WK_eRXnoEU,2945
 mcmcli/command/account.py,sha256=FWXmzOLj4rVLVLEv-w0eDVlQVrkONvR1UewZbcTDgE4,24994
-mcmcli/command/admin.py,sha256=2GC0B3oqQsT5N5mHUyezgZvzPkB4-oGtddguOWfdLJs,15980
+mcmcli/command/admin.py,sha256=oMIGRPB2GspKLi27dVmL5U4gjLLD3ZvGQ5JHP-ZLv4E,19068
 mcmcli/command/auth.py,sha256=Ak7ZNEskWPpMoeTJcbYlEpDBgzxn8N33Q2dNf67SsCs,2926
 mcmcli/command/campaign.py,sha256=eHE_i1lRlUuU1GeVMwXkJgBU_zOgU-b9Wo0SYC9TK7M,15444
 mcmcli/command/config.py,sha256=08C5ftAvdvpQ26Z329LqhP8AxTI629LS7Ou6glzrRgw,4396
-mcmcli/command/decision.py,sha256=iLvEDEa2k0LAgoXrOvcdn-HcFRo90E8Dxht_Ls9EGCY,8690
+mcmcli/command/decision.py,sha256=3eCz4360q37vxNZVBUEDEVKGEqatjMA1nKswQh8GXsA,8993
 mcmcli/command/report.py,sha256=N8IMyDZ5QpY11-KkZG-n5_ZzEeh-ME5s2s3wrAKEGjY,5387
 mcmcli/command/wallet.py,sha256=vG2rg7tPwGsV9YB7cpvkiocbqtB1reqXn7dmolFmzD4,11536
 mcmcli/data/account.py,sha256=pe7tPapP6vlUD5D5L5Nh5k2bkWdYOK01Mpt5fBYFnJs,1782
@@ -23,10 +23,10 @@ mcmcli/data/seller.py,sha256=40SA7QekM3a3svDrDYLo_QYJ68VUxDO0KeGejJMp4k4,1004
 mcmcli/data/token.py,sha256=11wtyLHCAZHu0LVbNDPa-yipcL6lenxoYIKEI58VzFs,1744
 mcmcli/data/user_join_request.py,sha256=lXMO2hE_VpRg0JofVrYAVM82S-RLFkPrZk8-drvhoDI,1251
 mcmcli/data/wallet.py,sha256=eMUi8N0vJdg_E10TPhSPoZkZtmIG7gHyqgabQ8C5Lg8,3217
-mcm_cli-1.6.1.dist-info/LICENSE,sha256=RFhQPdSOiMTguUX7JSoIuTxA7HVzCbj_p8WU36HjUQQ,10947
-mcm_cli-1.6.1.dist-info/METADATA,sha256=dgSb4q2UwtTILG4P54BcMsiglP27lmXi_kHUwkNcc2E,3056
-mcm_cli-1.6.1.dist-info/NOTICE,sha256=Ldnl2MjRaXPxcldUdbI2NTybq60XAa2LowRhFrRTuiI,76
-mcm_cli-1.6.1.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-mcm_cli-1.6.1.dist-info/entry_points.txt,sha256=qTHAWZ-ejSiU4t11RYwtAU8ScqhQPDeMVTG9y4wMVLg,60
-mcm_cli-1.6.1.dist-info/top_level.txt,sha256=sh7oqIaqLQlMtKHlxHHgpV2xGMrBMPFWpSp0C6nvJ_Y,7
-mcm_cli-1.6.1.dist-info/RECORD,,
+mcm_cli-1.7.1.dist-info/LICENSE,sha256=RFhQPdSOiMTguUX7JSoIuTxA7HVzCbj_p8WU36HjUQQ,10947
+mcm_cli-1.7.1.dist-info/METADATA,sha256=xcrBBZZZ2ftAJUglEnEyx4G0bA8KV-8HTABosPHb9OI,3056
+mcm_cli-1.7.1.dist-info/NOTICE,sha256=Ldnl2MjRaXPxcldUdbI2NTybq60XAa2LowRhFrRTuiI,76
+mcm_cli-1.7.1.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+mcm_cli-1.7.1.dist-info/entry_points.txt,sha256=qTHAWZ-ejSiU4t11RYwtAU8ScqhQPDeMVTG9y4wMVLg,60
+mcm_cli-1.7.1.dist-info/top_level.txt,sha256=sh7oqIaqLQlMtKHlxHHgpV2xGMrBMPFWpSp0C6nvJ_Y,7
+mcm_cli-1.7.1.dist-info/RECORD,,

mcmcli/__main__.py

@@ -37,7 +37,7 @@ def version():
 	"""
 	Show the tool version
 	"""
-	typer.echo(f"Version: mcm-cli v1.6.1")
+	typer.echo(f"Version: mcm-cli v1.7.1")
 
 app.add_typer(mcmcli.command.account.app, name="account", help="Ad account management")
 app.add_typer(mcmcli.command.admin.app, name="admin", help="Platform administration")

mcmcli/command/admin.py

@@ -27,8 +27,11 @@ import mcmcli.command.account
 import mcmcli.command.auth
 import mcmcli.command.campaign
 import mcmcli.command.config
+import mcmcli.command.decision
 import mcmcli.command.wallet
 import mcmcli.requests
+import random
+import requests
 import sys
 import typer
 
@@ -40,76 +43,104 @@ def _create_admin_command(profile):
     auth = AuthCommand(profile)
     return AdminCommand(profile, auth)
 
-@app.command()
-def list_wallet_balances(
-    profile: str = typer.Option("default", help="profile name of the MCM CLI."),
-):
-    """
-    List the wallet balances of all of the ad accounts
-    """
-    admin = _create_admin_command(profile)
-    if admin is None:
-        return
-    admin.list_wallet_balances()
-
 
 @app.command()
-def list_all_campaigns(
-    profile: str = "default",
+def block_item(
+    item_id: str = typer.Option(help="Item ID"),
+    account_id: str = typer.Option(None, help="The Ad Account ID is applicable only for MSPI catalogs. If this value is provided, only the item associated with the specified seller ID will be removed from ad serving. If it is not provided, the specified item will be removed for all sellers in the MSPI catalog."),
+    to_curl: bool = typer.Option(False, help="Generate the curl command instead of executing it."),
+    profile: str = typer.Option("default", help="Profile name of the MCM CLI."),
 ):
     """
-    List the campaigigns of all of the active ad accounts
+    Item Kill Switch Command.
+    This API immediately blocks an item or an ad account item from appearing in ads by marking it as `blocked`.
     """
+    timestamp = datetime.now(timezone.utc).strftime("%Y-%m-%dT%H:%M:%S.%fZ")
+
+    # print(f"invoked block_item(item_id={item_id}, account_id={account_id}, blocked='Requested at {timestamp}')");
     admin = _create_admin_command(profile)
     if admin is None:
         return
-    error, account_campaigns = admin.list_all_campaigns()
+    
+    curl, error, result = admin.block_item(item_id=item_id, account_id=account_id, to_curl=to_curl)
+    if curl:
+        print(curl)
+        return
     if error:
-        print(error, file=sys.stderr, flush=True)
+        print(f"ERROR: {error.message}", file=sys.stderr, flush=True)
         return
+    
+    print(result.model_dump_json())
+    return
 
-    print("Account ID,Account Title,Campaign ID,Campaign Title,Ad Type,Start,End,Budget Period,Budget Amount,Enabling State,State,Created At,Updated At")
-    for account_campaign in account_campaigns:
-        a, c = account_campaign
-
-        print(f'"{a.id}","{a.title}",', end="", flush=True)
-        print(f'"{c.id}","{c.title}","{c.ad_type}",', end="", flush=True)
-        print(f'"{c.schedule.start}","{c.schedule.end}",', end="", flush=True)
-        print(f'"{c.budget.period}","{int(c.budget.amount.amount_micro) / 1000000}",', end="", flush=True)
-        print(f'"{c.enabling_state}","{c.state}",', end="", flush=True)
-        print(f'"{c.created_at}","{c.updated_at}",', end="", flush=True)
-        # print(f'"{";".join(c.catalog_item_ids)}"')
-        print("", flush=True)
 
 @app.command()
-def list_platform_users(
-    to_curl: bool = typer.Option(False, help="Generate the curl command instead of executing it."),
-    to_json: bool = typer.Option(False, help="Print raw output in json"),
-    profile: str = "default",
+def generate_sample_data(
+    ad_inventory_id: str = typer.Option(help="The ad inventory ID to use when calling the Decision API."),
+    num_iterations: int = typer.Option(100, help="How many times to call the Decision API."),
+    warn: bool = typer.Option(True, help="Shows a warning message before running. Use `--no-warn` if you want to skip the warning."),
+    profile: str = typer.Option("default", help="Profile Name – The MCM CLI configuration profile to use."), 
 ):
     """
-    List the users of the platform
+    Generate sample impressions and clicks. This command invokes the Decision APIs, and posts the impression
+    and click trackers to generate sample data in the platform.
     """
-    admin = _create_admin_command(profile)
-    if admin is None:
-        return
+    if warn:
+        typer.confirm("""⚠️ WARNING: This script is strictly for use on the TEST platform.⚠️
+Running it on any other platform may corrupt data or confuse the ML system.
+It will generate sample impressions and clicks.
+Please proceed only if you are certain.""", abort=True)
 
-    curl, error, users = admin.list_platform_users(to_curl)
-    if to_curl:
-        print(curl)
-        return
-    if error:
-        print(error, file=sys.stderr, flush=True)
-        return
-    if to_json:
-        json_dumps = [x.model_dump_json() for x in users]
-        print(f"[{','.join(json_dumps)}]")
-        return
+    config = mcmcli.command.config.get_config(profile)
+    if (config is None):
+        print(f"ERROR: Failed to load the CLI profile", file=sys.stderr, flush=True)
+        sys.exit()
+
+    platform_id = config['platform_id']
+    if (not platform_id.endswith("_TEST")):
+        print(f"ERROR: The platform {platform_id} is not a TEST platform.", file=sys.stderr, flush=True)
+        sys.exit()
 
-    print('User ID,Created At,Updated At,Status,Email,Name,Roles')
-    for u in users:
-        roles = [f'{x.name} of {x.resource_type} {x.resource_id}' for x in u.roles]
-        print(f'{u.id},{u.created_at},{u.updated_at},{u.status},{u.email},{u.name},{';'.join(roles)}')
+
+    # Initialize DecisionCommand
+    d = mcmcli.command.decision.DecisionCommand(profile)      
+    
+    print(f"Invoking the Decision API {num_iterations} times to generate sample impressions and clicks...", end='', flush=True)
+    thread, stopper = start_dot_printing()
+    
+    for i in range(num_iterations):
+        # Call Decision API to get trackers
+        _, error, decided_items = d.decide_items(ad_inventory_id)
+        if error:
+            print_error(f"Error calling Decision API: {error.message}")
+            continue
+            
+        if not decided_items or not decided_items.decided_items or len(decided_items.decided_items) == 0:
+            print_error("The Decision API returned an empty response.")
+            continue
+            
+        for item in decided_items.decided_items:
+            # Post impression tracker
+            for imp_url in item.imp_trackers:
+                try:
+                    requests.post(imp_url)
+                except requests.RequestException as e:
+                    print(f"[{i}] Failed to post imp tracker: {imp_url} - Error: {e}")
+            
+            # Post to click trackers with 20% probability
+            if random.random() >= 0.8:
+                continue
+            for click_url in item.click_trackers:
+                try:
+                    requests.post(click_url)
+                except requests.RequestException as e:
+                    print(f"[{i}] Failed to post imp tracker: {click_url} - Error: {e}")
+                    
+        print('.', end='', flush=True)
+        
+    stop_dot_printing(thread, stopper)
+    print("\nDone generating sample data!")
+    return
 
 
 @app.command()
@@ -139,6 +170,35 @@ def get_platform_user(
     return
 
 
+@app.command()
+def list_all_campaigns(
+    profile: str = "default",
+):
+    """
+    List the campaigigns of all of the active ad accounts
+    """
+    admin = _create_admin_command(profile)
+    if admin is None:
+        return
+    error, account_campaigns = admin.list_all_campaigns()
+    if error:
+        print(error, file=sys.stderr, flush=True)
+        return
+
+    print("Account ID,Account Title,Campaign ID,Campaign Title,Ad Type,Start,End,Budget Period,Budget Amount,Enabling State,State,Created At,Updated At")
+    for account_campaign in account_campaigns:
+        a, c = account_campaign
+
+        print(f'"{a.id}","{a.title}",', end="", flush=True)
+        print(f'"{c.id}","{c.title}","{c.ad_type}",', end="", flush=True)
+        print(f'"{c.schedule.start}","{c.schedule.end}",', end="", flush=True)
+        print(f'"{c.budget.period}","{int(c.budget.amount.amount_micro) / 1000000}",', end="", flush=True)
+        print(f'"{c.enabling_state}","{c.state}",', end="", flush=True)
+        print(f'"{c.created_at}","{c.updated_at}",', end="", flush=True)
+        # print(f'"{";".join(c.catalog_item_ids)}"')
+        print("", flush=True)
+
+
 @app.command()
 def list_items(
     account_id: str = typer.Option(help="Ad account ID"),
@@ -197,6 +257,7 @@ def list_items(
         else:
             print(f"{account_id},{i.id},{i.is_active},\"{i.title}\",,")
 
+
 @app.command()
 def list_off_campaign_items(
     account_id: str = typer.Option(help="Ad account ID"),
@@ -229,34 +290,48 @@ def list_off_campaign_items(
         if i.id not in campaign_item_obj and i.is_active:
             print(f"{i.id}, {i.title}")
 
+
 @app.command()
-def block_item(
-    item_id: str = typer.Option(help="Item ID"),
-    account_id: str = typer.Option(None, help="The Ad Account ID is applicable only for MSPI catalogs. If this value is provided, only the item associated with the specified seller ID will be removed from ad serving. If it is not provided, the specified item will be removed for all sellers in the MSPI catalog."),
+def list_platform_users(
     to_curl: bool = typer.Option(False, help="Generate the curl command instead of executing it."),
-    profile: str = typer.Option("default", help="Profile name of the MCM CLI."),
+    to_json: bool = typer.Option(False, help="Print raw output in json"),
+    profile: str = "default",
 ):
     """
-    Item Kill Switch Command.
-    This API immediately blocks an item or an ad account item from appearing in ads by marking it as “blocked.”
+    List the users of the platform
     """
-    timestamp = datetime.now(timezone.utc).strftime("%Y-%m-%dT%H:%M:%S.%fZ")
-
-    # print(f"invoked block_item(item_id={item_id}, account_id={account_id}, blocked='Requested at {timestamp}')");
     admin = _create_admin_command(profile)
     if admin is None:
         return
-    
-    curl, error, result = admin.block_item(item_id=item_id, account_id=account_id, to_curl=to_curl)
-    if curl:
+
+    curl, error, users = admin.list_platform_users(to_curl)
+    if to_curl:
         print(curl)
         return
     if error:
-        print(f"ERROR: {error.message}", file=sys.stderr, flush=True)
+        print(error, file=sys.stderr, flush=True)
         return
-    
-    print(result.model_dump_json())
-    return
+    if to_json:
+        json_dumps = [x.model_dump_json() for x in users]
+        print(f"[{','.join(json_dumps)}]")
+        return
+
+    print('User ID,Created At,Updated At,Status,Email,Name,Roles')
+    for u in users:
+        roles = [f'{x.name} of {x.resource_type} {x.resource_id}' for x in u.roles]
+        print(f'{u.id},{u.created_at},{u.updated_at},{u.status},{u.email},{u.name},{';'.join(roles)}')
+
+@app.command()
+def list_wallet_balances(
+    profile: str = typer.Option("default", help="profile name of the MCM CLI."),
+):
+    """
+    List the wallet balances of all of the ad accounts
+    """
+    admin = _create_admin_command(profile)
+    if admin is None:
+        return
+    admin.list_wallet_balances()
 
 
 class AdminCommand:

mcmcli/command/decision.py

@@ -21,6 +21,7 @@ import json
 import mcmcli.command.auth
 import mcmcli.command.config
 import mcmcli.logging
+import random
 import sys
 import typer
 
@@ -139,10 +140,10 @@ class DecisionCommand:
     def decide_items(
         self, 
         inventory_id, 
-        num_items, 
-        items,
-        location_filter, 
-        to_curl,
+        num_items = 5, 
+        items = False,
+        location_filter = None, 
+        to_curl = False,
     ) -> tuple[
         Optional[CurlString],
         Optional[Error],
@@ -156,10 +157,10 @@ class DecisionCommand:
                 "num_items": num_items
             },
             "user": {
-                "user_id": "user-1"
+                "user_id": f"mcmcli-user-{random.randint(100_000, 999_999)}"
             },
             "device": {
-                "persistent_id": "persistent-device-1"
+                "persistent_id": f"mcmcli-device-{random.randint(100_000, 999_999)}"
             },
         }
         if items:
@@ -185,9 +186,9 @@ class DecisionCommand:
     def decide_creative(
         self,
         inventory_id,
-        items,
-        location_filter,
-        to_curl
+        items = False,
+        location_filter = None, 
+        to_curl = False,
     ) -> tuple[
         Optional[CurlString],
         Optional[Error],
@@ -200,10 +201,10 @@ class DecisionCommand:
                 "inventory_id": inventory_id
             },
             "user": {
-                "user_id": "user-1"
+                "user_id": f"mcmcli-user-{random.randint(100_000, 999_999)}"
             },
             "device": {
-                "persistent_id": "persistent-device-1"
+                "persistent_id": f"mcmcli-device-{random.randint(100_000, 999_999)}"
             },
         }
         if items:
@@ -229,9 +230,9 @@ class DecisionCommand:
     def decide_creative_bulk(
         self, 
         inventory_id_list, 
-        items,
-        location_filter, 
-        to_curl
+        items = False,
+        location_filter = None, 
+        to_curl = False,
     ) -> tuple[
         Optional[CurlString],
         Optional[Error], 
@@ -242,10 +243,10 @@ class DecisionCommand:
             "request_id": "request-1",
             "inventories": list(map(lambda x: { "inventory_id": x }, inventory_id_list.split(','))),
             "user": {
-                "user_id": "user-1"
+                "user_id": f"mcmcli-user-{random.randint(100_000, 999_999)}"
             },
             "device": {
-                "persistent_id": "persistent-device-1"
+                "persistent_id": f"mcmcli-device-{random.randint(100_000, 999_999)}"
             },
         }
         if items: