akta-pro-cli 0.3.0__py3-none-any.whl

akta_pro_cli/runtime.py

@@ -0,0 +1,157 @@
+"""Shared request/render plumbing for the akta.pro CLI.
+
+- `AppContext` holds the resolved global options (set on `ctx.obj` by the root
+  callback).
+- `fetch()` resolves the API key, performs the GET, and maps failures to exit
+  codes (0 ok / 2 bad-input / 3 auth / 4 API / 5 timeout).
+- `emit()` renders a result: a file (`-o`), clean JSON (`--json` or a pipe), or
+  a human-friendly table/Markdown in a TTY. Credits go to stderr.
+"""
+
+from __future__ import annotations
+
+import json
+from collections.abc import Callable
+from dataclasses import dataclass
+from pathlib import Path
+from typing import Any
+
+import httpx
+import typer
+from rich.markdown import Markdown
+
+from akta_pro_cli.client import DEFAULT_BASE_URL, AktaAPIError, AktaClient
+from akta_pro_cli.config import stored_api_key, stored_base_url
+from akta_pro_cli.console import err, out
+
+# Exit codes (common CLI convention).
+EXIT_BAD_INPUT = 2
+EXIT_AUTH = 3
+EXIT_API = 4
+EXIT_TIMEOUT = 5
+
+
+@dataclass
+class AppContext:
+    api_key: str | None
+    base_url: str | None  # from --base-url / AKTA_PRO_API_BASE_URL; None if unset
+    quiet: bool
+    timeout: float = 30.0
+
+
+def resolve_base_url(ctx: AppContext) -> str:
+    """Effective base URL: explicit flag/env → stored (from `akta-pro login`) → default.
+
+    Lets local testing target a dev backend either per-command
+    (`--base-url http://localhost:8000/api/v1` or the AKTA_PRO_API_BASE_URL env) or
+    persistently (`akta-pro login --base-url …`, then every command follows).
+    """
+    return ctx.base_url or stored_base_url() or DEFAULT_BASE_URL
+
+
+def resolve_api_key(ctx: AppContext) -> str:
+    key = ctx.api_key or stored_api_key()
+    if not key:
+        err.print(
+            "[red]No akta.pro API key found.[/]\n"
+            "Provide one with [bold]--api-key[/], the [bold]AKTA_PRO_API_KEY[/] env var, "
+            "or run [bold]akta-pro login[/].\n"
+            "Get a key at https://playground.akta.pro (API Keys)."
+        )
+        raise typer.Exit(code=EXIT_AUTH)
+    return key
+
+
+def probe_is_enterprise(ctx: AppContext) -> bool:
+    """Best-effort Enterprise-tier check via /mcp/account (free, 0 credits).
+
+    Returns False on any failure (no key, network error, endpoint not deployed)
+    so a probe never blocks or crashes the actual command.
+    """
+    key = ctx.api_key or stored_api_key()
+    if not key:
+        return False
+    client = AktaClient(resolve_base_url(ctx), key, timeout=ctx.timeout)
+    try:
+        account = client.get("/mcp/account")
+        return bool(account.get("is_enterprise")) if isinstance(account, dict) else False
+    except Exception:
+        return False
+    finally:
+        client.close()
+
+
+def _exit_code_for_status(status: int) -> int:
+    if status in (400, 422):
+        return EXIT_BAD_INPUT
+    if status in (401, 403):
+        return EXIT_AUTH
+    return EXIT_API
+
+
+def fetch(ctx: AppContext, path: str, params: dict | None = None) -> Any:
+    """Resolve the key, GET `path`, and translate errors into `typer.Exit`."""
+    key = resolve_api_key(ctx)
+    client = AktaClient(resolve_base_url(ctx), key, timeout=ctx.timeout)
+    try:
+        return client.get(path, params=params)
+    except AktaAPIError as exc:
+        err.print(f"[red]Error {exc.status_code}:[/] {exc}")
+        raise typer.Exit(code=_exit_code_for_status(exc.status_code)) from exc
+    except httpx.TimeoutException as exc:
+        err.print("[red]Request timed out.[/]")
+        raise typer.Exit(code=EXIT_TIMEOUT) from exc
+    except httpx.HTTPError as exc:
+        err.print(f"[red]Network error:[/] {exc}")
+        raise typer.Exit(code=EXIT_API) from exc
+    finally:
+        client.close()
+
+
+def _json_text(result: Any) -> str:
+    if isinstance(result, str):
+        return result
+    return json.dumps(result, indent=2, ensure_ascii=False)
+
+
+def emit(
+    ctx: AppContext,
+    result: Any,
+    *,
+    json_out: bool = False,
+    output: Path | None = None,
+    renderer: Callable[[Any], Any] | None = None,
+    markdown: bool = False,
+) -> None:
+    # 1. credits → stderr (for dict/JSON results). `company data` returns a
+    # Markdown string with credits already appended as an in-body footer, so it
+    # deliberately doesn't hit this branch — see commands/company.py.
+    if isinstance(result, dict) and not ctx.quiet:
+        credits = result.get("credits_consumed")
+        if credits is not None:
+            err.print(f"[dim]credits consumed: {credits}[/]")
+
+    # 2. file output → raw machine payload
+    if output is not None:
+        output.write_text(_json_text(result))
+        err.print(f"[green]✓[/] wrote {output}")
+        return
+
+    # 3. --json or a non-TTY pipe → clean, un-styled payload on stdout
+    if json_out or not out.is_terminal:
+        print(_json_text(result))
+        return
+
+    # 4. human/default rendering in a TTY
+    if markdown and isinstance(result, str):
+        out.print(Markdown(result))
+        return
+    if renderer is not None:
+        renderable = renderer(result)
+        if renderable is not None:
+            out.print(renderable)
+            return
+    if isinstance(result, str):
+        out.print(result)
+    else:
+        out.print_json(_json_text(result))

akta_pro_cli/update.py

@@ -0,0 +1,79 @@
+"""Update checking for the CLI.
+
+Discovers the latest released version from PyPI (the `akta-pro-cli` project's
+JSON API). Results are cached in the config dir so `akta-pro --version` can show
+a hint without hitting the network on every call.
+"""
+
+from __future__ import annotations
+
+import json
+import time
+import urllib.request
+from pathlib import Path
+
+from akta_pro_cli.config import config_dir
+
+PACKAGE = "akta-pro-cli"
+PYPI_URL = f"https://pypi.org/pypi/{PACKAGE}/json"
+PROJECT_URL = f"https://pypi.org/project/{PACKAGE}/"
+_CACHE_TTL = 24 * 3600  # re-check at most once a day for the --version hint
+
+
+def _cache_path() -> Path:
+    return config_dir() / "update-check.json"
+
+
+def parse_version(v: str) -> tuple[int, ...]:
+    """Lenient version tuple: '1.2.3' -> (1, 2, 3); non-numeric parts -> 0."""
+    parts: list[int] = []
+    for chunk in v.split("."):
+        digits = ""
+        for ch in chunk:
+            if ch.isdigit():
+                digits += ch
+            else:
+                break
+        parts.append(int(digits) if digits else 0)
+    return tuple(parts)
+
+
+def is_newer(latest: str, current: str) -> bool:
+    return parse_version(latest) > parse_version(current)
+
+
+def latest_version(timeout: float = 5.0) -> str | None:
+    """Latest version of the package on PyPI, or None on any failure."""
+    try:
+        with urllib.request.urlopen(PYPI_URL, timeout=timeout) as resp:  # noqa: S310 (https only)
+            data = json.load(resp)
+        version = data.get("info", {}).get("version")
+        return version or None
+    except (OSError, ValueError):
+        return None
+
+
+def cached_latest(*, timeout: float = 2.0, ttl: int = _CACHE_TTL, force: bool = False) -> str | None:
+    """Latest version string, using a time-boxed cache. Best-effort; None on failure.
+
+    With `force`, always re-checks (used by `akta-pro update`). Otherwise reads
+    the cache and only re-checks once `ttl` has elapsed (used by the `--version`
+    hint, so it stays fast and offline most of the time).
+    """
+    path = _cache_path()
+    now = int(time.time())
+    if not force:
+        try:
+            data = json.loads(path.read_text())
+            if now - int(data.get("checked_at", 0)) < ttl:
+                return data.get("latest")
+        except (OSError, ValueError):
+            pass
+    latest = latest_version(timeout=timeout)
+    if latest is not None:
+        try:
+            path.parent.mkdir(parents=True, exist_ok=True)
+            path.write_text(json.dumps({"checked_at": now, "latest": latest}))
+        except OSError:
+            pass
+    return latest

akta_pro_cli-0.3.0.dist-info/METADATA

@@ -0,0 +1,134 @@
+Metadata-Version: 2.4
+Name: akta-pro-cli
+Version: 0.3.0
+Summary: Command-line client for the akta.pro API (api.akta.pro)
+Author-email: Wokelo <support@wokelo.ai>
+Maintainer-email: Wokelo <support@wokelo.ai>
+License: MIT
+Project-URL: Homepage, https://akta.pro/
+Project-URL: Repository, https://github.com/Wokelo-AI/akta-pro-cli
+Keywords: akta-pro,akta.pro,cli,company-intelligence,market-intelligence
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx>=0.27
+Requires-Dist: typer>=0.12
+Requires-Dist: rich>=13
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: respx>=0.22; extra == "dev"
+Requires-Dist: ruff>=0.6; extra == "dev"
+Dynamic: license-file
+
+# akta.pro CLI (`akta-pro`)
+
+A command-line client for the akta.pro REST API (`https://api.akta.pro/api/v1`) — a
+sibling of the akta.pro MCP server. Both are thin clients over the same endpoints;
+the CLI is the presentation layer for humans and shell scripts. It ships as its
+own self-contained distribution (`akta-pro-cli`) with no MCP-server code.
+
+Source: [`src/akta_pro_cli/`](src/akta_pro_cli). API reference: <https://docs.akta.pro>.
+
+## Install
+
+Published on [PyPI](https://pypi.org/project/akta-pro-cli/). Install with `pipx`
+(recommended for CLIs — isolated env) or `pip`:
+
+```bash
+pipx install akta-pro-cli
+# or
+pip install akta-pro-cli
+```
+
+Then run `akta-pro --help`. Full prerequisites, auth, update, and troubleshooting
+steps are in **[INSTALL.md](INSTALL.md)**.
+
+The `akta-pro` command depends only on `httpx`, `typer`, `rich`.
+
+## Authentication
+
+v1 authenticates with an akta.pro API key (`wk_...`), minted at
+<https://playground.akta.pro> (sign up → **API Keys**). Three ways to supply it,
+in precedence order:
+
+```bash
+akta-pro --api-key wk_...  company search Canva     # 1. explicit flag
+export AKTA_PRO_API_KEY=wk_...                       # 2. environment variable
+akta-pro login                                       # 3. stored (prompts, or --api-key)
+```
+
+`akta-pro login` validates the key against a free endpoint and stores it at
+`~/.config/akta-pro/credentials.json` (mode 0600; `%APPDATA%\akta-pro` on Windows).
+
+```bash
+akta-pro login --api-key wk_...   # store without the prompt
+akta-pro whoami                   # show the active key (masked), its source, and validate
+akta-pro logout                   # remove the stored key
+```
+
+## Commands
+
+| Command | Endpoint | Cost | Notes |
+|---|---|---|---|
+| `akta-pro account` | `/mcp/account` | free | your tier + credit balance |
+| `akta-pro company search <query>` | `/company/search` | free | run first; returns `uuid` |
+| `akta-pro company data <company> -s ...` | `/company/enrichment` (JSON; `--markdown` → `/company/enrichment/markdown`) | per section | requires ≥1 `--section` |
+| `akta-pro company concise <company>` | `/company/enrichment/concise` | 8 | slimmed JSON |
+| `akta-pro industry search <query>` | `/industry/search` | free | codes feed `news signals --industry` |
+| `akta-pro news signals [filters]` | `/news` | 0.1 + 0.01/article | anchor with `--company/--industry/--query/--title` (all optional); rich filters (`--country`, `--entity-*`, `--naics/--sic/--iptc/--iab`, `--blacklist`); compact list with `id`s |
+| `akta-pro news detail <id>...` | `/news/by-id/` | 0.1 + 0.01/article | full bodies for ids from `signals` (max 10) |
+| `akta-pro news types` | none (embedded) | free | tag codes for `--type-code`; offline, no key |
+| `akta-pro headcount <company>` | `/company/headcount-trends` | 2.5 | Subscription/Enterprise |
+| `akta-pro traffic <company>` | `/company/website-traffic` | 1.5 | Subscription/Enterprise |
+| `akta-pro jobs <company>` | `/company/jobs` | 3 | Subscription/Enterprise |
+| `akta-pro posts <company>` | `/company/posts` | 1.5 | Subscription/Enterprise |
+| `akta-pro reviews employees <company>` | `/company/employee-reviews` | 1.5/50 | Subscription/Enterprise; `-n/--limit` max 100 |
+| `akta-pro reviews products <company>` | `/company/product-reviews` | 1.5/50 | catalog first, then `--product-id`; `-n/--limit` max 50 per product |
+
+`company data` sections (each billed separately): `firmographic`,
+`business_model`, `company_assessment`, `trust_signal`, `company_hierarchy`,
+`digital_presence`, `financial_estimate`, `location`, `management_profile`,
+`product_offering`, `strategic_signal`, `customer_profile`, `industry`,
+`technology`, plus enterprise-only `funding_detail` (3) and `mna_and_investment`
+(5). There is no "all" — choose explicitly. The two enterprise sections are
+auto-skipped (not an error) for non-enterprise callers, with a note.
+
+Run `akta-pro <command> --help` for every flag.
+
+### Examples
+
+```bash
+akta-pro account                                                  # check tier + credits
+akta-pro company search "Canva"
+akta-pro company data canva.com -s firmographic -s technology     # rendered Markdown
+akta-pro company data canva.com -s firmographic --raw             # raw Markdown (pipe/save)
+akta-pro industry search "warehouse automation"
+akta-pro news types                                               # find type codes
+akta-pro news signals --company canva.com -t SD01 -n 20           # product-launch news
+akta-pro news signals --query "crude oil prices" --json | jq '.data[].id'
+akta-pro news detail 12345 12346                                  # full bodies for those ids
+akta-pro headcount canva.com
+akta-pro reviews products canva.com                               # list catalog + ids
+akta-pro reviews products canva.com --product-id p_123 -n 50
+```
+
+## Output & exit codes
+
+- **Default (TTY):** a Rich table for list results (search, industry, news),
+  rendered Markdown for `company data`, and pretty-printed JSON for nested
+  objects.
+- **`--json`:** clean, unstyled JSON on **stdout** (valid for `| jq`). Applied
+  automatically when stdout is piped/redirected. For `company data`, `--json`
+  (alias `--raw`) emits the raw Markdown.
+- **`-o/--output FILE`:** writes the raw JSON/text payload to a file.
+- **`credits_consumed`** is printed to **stderr** (silence with `-q/--quiet`),
+  so it never pollutes piped JSON.
+
+Exit codes: `0` success · `2` bad input · `3` auth (no/invalid key or `403`) ·
+`4` other API/network error · `5` timeout.

akta_pro_cli-0.3.0.dist-info/RECORD

@@ -0,0 +1,25 @@
+akta_pro_cli/__init__.py,sha256=OBwPyxDbre_e_wmciRr8zh-db_RMJaZQyQPE9CvcNlw,316
+akta_pro_cli/__main__.py,sha256=kdcuSOTtdYhOAR0QKJkY9SFgtIkyB3YSmOvvVK94nJU,638
+akta_pro_cli/app.py,sha256=fq-P1B_V0vvE5v2GNilK-CMYn7eCYV1VuD3IeItzSBw,3163
+akta_pro_cli/client.py,sha256=KWU-dGOFiz54qVmphw4LoeH-qnZM4mfsyC0ZaS2HEI0,3844
+akta_pro_cli/config.py,sha256=SvYArUye0WcNlUUiR0Y4cHhBrRuDt_Ug820VosffCkA,1842
+akta_pro_cli/console.py,sha256=oxySq6_6gNPy-fbvjnt8rIRhAqAUA1nDEI4R6XugJZ4,264
+akta_pro_cli/news_tags.py,sha256=oZnXIuzo5f6FlA_IZCVTpsL4FyG3V89lrTBUBKNc34g,4185
+akta_pro_cli/options.py,sha256=shGc6xLtyObsm6rEgCacQgcFIh6ymZb3sBggmFNHUD4,708
+akta_pro_cli/runtime.py,sha256=29kmlXySXJJBkZFzyZ00VtsONnAmlhY3Vbm7O7ptOC8,5189
+akta_pro_cli/update.py,sha256=3IXcp_KOqPyoK3vFDj4PbAKaWNXFeIrxSDVNSptOUMo,2591
+akta_pro_cli/commands/__init__.py,sha256=Yaj-wId8zogUPsjQNPJsJGMSpMiUAQilmvF3WjcZV98,36
+akta_pro_cli/commands/account.py,sha256=kSE8JG37Llo_zsByHkNimw6OOTBRNQTQTeJ-OltQ9YU,1228
+akta_pro_cli/commands/alternative.py,sha256=Hawd6pbGCLVO1BO49Fv2GFS5WaONp1Bi9FpWkvoSBJc,3914
+akta_pro_cli/commands/auth.py,sha256=_2Rbmf18g1_PMLKtTXnL6kfilh99Iz1nSfc9KpIvtic,4494
+akta_pro_cli/commands/company.py,sha256=g5meZgDJqp16PrOh8C1Fws1-w6enVGn2IF-FdJTbf-M,7211
+akta_pro_cli/commands/config.py,sha256=nar232l1JluTeHBiUcFbyrKRK7iYscl9oaUHySSOnDw,1920
+akta_pro_cli/commands/industry.py,sha256=PGpmVTuWvDHhWvDqU2HUXzjIZyZX8PnF3t7WnOrz7y8,1496
+akta_pro_cli/commands/news.py,sha256=5ofnfYMh6FLDNdEFKx13K09TK-c0b2gxeZK6IU2FgKM,11239
+akta_pro_cli/commands/update.py,sha256=-gk0mx4tdEWRTKxX1VLjmSQ_MvHDQ3wfpoREgvnTyew,2176
+akta_pro_cli-0.3.0.dist-info/licenses/LICENSE,sha256=72c9hARoXXgaVZ_fbzjUM5hASq0kXSZsOOXsBVW2I6o,1066
+akta_pro_cli-0.3.0.dist-info/METADATA,sha256=jPxZPMbudzb-xOfb3Gt1CeErviYM__QaGYGMwLfZ6s4,6549
+akta_pro_cli-0.3.0.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
+akta_pro_cli-0.3.0.dist-info/entry_points.txt,sha256=svX39q3yjlmN5mYeSAxPO8QQN6twJqE-fGTh7u_StYM,56
+akta_pro_cli-0.3.0.dist-info/top_level.txt,sha256=BKafPuBjQsh-tYCvmE1GOrbE5FEO8D7M3TV9XevubWU,13
+akta_pro_cli-0.3.0.dist-info/RECORD,,

akta_pro_cli-0.3.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (83.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

akta_pro_cli-0.3.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+akta-pro = akta_pro_cli.__main__:main

akta_pro_cli-0.3.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Wokelo AI
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

akta_pro_cli-0.3.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+akta_pro_cli