scrapebadger-cli 0.25.0__tar.gz → 0.26.0__tar.gz

{scrapebadger_cli-0.25.0 → scrapebadger_cli-0.26.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: scrapebadger-cli
-Version: 0.25.0
+Version: 0.26.0
 Summary: ScrapeBadger CLI — Twitter, Vinted, Google, and Web Scraping from the command line
 Author: ScrapeBadger Team
 License: MIT

{scrapebadger_cli-0.25.0 → scrapebadger_cli-0.26.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "scrapebadger-cli"
-version = "0.25.0"
+version = "0.26.0"
 description = "ScrapeBadger CLI — Twitter, Vinted, Google, and Web Scraping from the command line"
 requires-python = ">=3.10"
 license = {text = "MIT"}

scrapebadger_cli-0.26.0/src/scrapebadger_cli/commands/copilot.py

@@ -0,0 +1,87 @@
+"""Microsoft Copilot answer-engine commands."""
+
+import typer
+
+from scrapebadger_cli.client import api_get
+from scrapebadger_cli.output import render
+
+app = typer.Typer(no_args_is_help=True)
+
+FMT = typer.Option("json", "--output", "-o", help="Output format: json, csv, table, markdown")
+FIELDS = typer.Option(None, "--fields", "-f", help="Comma-separated fields to include")
+COUNTRY = typer.Option(
+    None,
+    "--country",
+    "-c",
+    help="ISO-3166 alpha-2 country to ask from; also sets the market unless --market. "
+    "Best-effort: another country may answer (the response `country` says which) unless "
+    "--strict-country is set",
+)
+MARKET = typer.Option(
+    None, "--market", "-m", help="Bing market, e.g. ja-JP or en-GB (default: the country's)"
+)
+STRICT = typer.Option(
+    False,
+    "--strict-country",
+    help="Answer only from an exit in --country; fails with 503 country_unavailable "
+    "(not billed) when none answers in time",
+)
+
+
+def _locale(country: str | None, market: str | None, strict_country: bool) -> dict:
+    params: dict = {"country": country, "market": market}
+    return {**params, "strict_country": True} if strict_country else params
+
+
+@app.command()
+def ask(
+    prompt: str = typer.Argument(..., help="Prompt to send to Copilot (max 2000 chars)"),
+    country: str | None = COUNTRY,
+    market: str | None = MARKET,
+    strict_country: bool = STRICT,
+    fmt: str = FMT,
+    fields: str | None = FIELDS,
+) -> None:
+    """Ask Microsoft Copilot (Copilot Search in Bing) and get the answer with its sources."""
+    data = api_get(
+        "/v1/copilot/ask", {"prompt": prompt, **_locale(country, market, strict_country)}
+    )
+    render(data, fmt, fields)
+
+
+@app.command(name="brand")
+def brand_visibility(
+    prompt: str = typer.Argument(..., help="Buyer-intent prompt, e.g. 'best CRM for startups'"),
+    brand: str = typer.Option(..., "--brand", "-b", help="Brand name to look for"),
+    domain: str | None = typer.Option(None, "--domain", "-d", help="Brand domain, for citations"),
+    aliases: str | None = typer.Option(
+        None, "--aliases", help="Comma-separated alternative brand spellings"
+    ),
+    competitors: str | None = typer.Option(
+        None, "--competitors", help="Comma-separated competitor names"
+    ),
+    country: str | None = COUNTRY,
+    market: str | None = MARKET,
+    strict_country: bool = STRICT,
+    fmt: str = FMT,
+    fields: str | None = FIELDS,
+) -> None:
+    """Score how a brand appears in a real Copilot answer (AEO/GEO)."""
+    data = api_get(
+        "/v1/copilot/brand-visibility",
+        {
+            "prompt": prompt,
+            "brand": brand,
+            "domain": domain,
+            "aliases": aliases,
+            "competitors": competitors,
+            **_locale(country, market, strict_country),
+        },
+    )
+    render(data, fmt, fields)
+
+
+@app.command()
+def markets(fmt: str = FMT, fields: str | None = FIELDS) -> None:
+    """List the Bing markets Copilot can be asked in."""
+    render(api_get("/v1/copilot/markets"), fmt, fields)

{scrapebadger_cli-0.25.0 → scrapebadger_cli-0.26.0}/src/scrapebadger_cli/main.py

@@ -17,6 +17,7 @@ from scrapebadger_cli.commands import (
     bing,
     booking,
     chatgpt,
+    copilot,
     depop,
     duckduckgo,
     ebay,
@@ -115,6 +116,7 @@ app.add_typer(apartments.app, name="apartments", help="Apartments.com rental com
 app.add_typer(linkedin.app, name="linkedin", help="LinkedIn public data commands")
 app.add_typer(chatgpt.app, name="chatgpt", help="ChatGPT LLM scraping commands")
 app.add_typer(perplexity.app, name="perplexity", help="Perplexity AI answer-engine commands")
+app.add_typer(copilot.app, name="copilot", help="Microsoft Copilot answer-engine commands")
 app.add_typer(gemini.app, name="gemini", help="Google Gemini LLM commands")
 app.add_typer(
     facebook.app,

scrapebadger_cli-0.26.0/tests/test_copilot_commands.py

@@ -0,0 +1,42 @@
+from unittest.mock import Mock
+
+import pytest
+
+CliRunner = pytest.importorskip("typer.testing").CliRunner
+copilot = pytest.importorskip(
+    "scrapebadger_cli.commands.copilot", reason="CLI is tested with its own installed package"
+)
+
+
+def _invoke(monkeypatch, args):
+    call = Mock(return_value={})
+    monkeypatch.setattr(copilot, "api_get", call)
+    monkeypatch.setattr(copilot, "render", Mock())
+    result = CliRunner().invoke(copilot.app, args)
+    assert result.exit_code == 0, result.output
+    return call.call_args.args
+
+
+def test_ask_leaves_locale_to_the_api_by_default(monkeypatch):
+    path, params = _invoke(monkeypatch, ["ask", "q"])
+    assert path == "/v1/copilot/ask"
+    assert params["country"] is None and params["market"] is None
+    assert "strict_country" not in params
+
+
+def test_ask_country_market_and_strict(monkeypatch):
+    _, params = _invoke(
+        monkeypatch, ["ask", "q", "-c", "JP", "--market", "ja-JP", "--strict-country"]
+    )
+    assert params == {"prompt": "q", "country": "JP", "market": "ja-JP", "strict_country": True}
+
+
+def test_brand(monkeypatch):
+    path, params = _invoke(monkeypatch, ["brand", "q", "--brand", "freee", "-c", "JP"])
+    assert path == "/v1/copilot/brand-visibility"
+    assert params["brand"] == "freee" and params["country"] == "JP"
+
+
+def test_markets(monkeypatch):
+    path, *_ = _invoke(monkeypatch, ["markets"])
+    assert path == "/v1/copilot/markets"

{scrapebadger_cli-0.25.0 → scrapebadger_cli-0.26.0}/uv.lock

@@ -228,7 +228,7 @@ wheels = [
 
 [[package]]
 name = "scrapebadger-cli"
-version = "0.25.0"
+version = "0.26.0"
 source = { editable = "." }
 dependencies = [
     { name = "httpx" },