apdf-cloud-cli 0.2.0__tar.gz → 0.3.0__tar.gz

{apdf_cloud_cli-0.2.0 → apdf_cloud_cli-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: apdf-cloud-cli
-Version: 0.2.0
+Version: 0.3.0
 Summary: CLI and MCP server tools for Aspose PDF Cloud
 Keywords: aspose,pdf,cli,mcp
 Author: Andriy Andruhovski
@@ -58,7 +58,16 @@ python -m pip install -e ".[dev]"
 
 ## Configuration
 
-Set credentials before running CLI commands or the MCP server:
+Set credentials before running CLI commands or the MCP server. The easiest
+local setup path is:
+
+```powershell
+apdf auth login
+apdf auth status
+apdf auth test
+```
+
+You can also set credentials directly in your shell:
 
 ```powershell
 $env:ASPOSE_CLIENT_ID = "your-client-id"
@@ -82,6 +91,8 @@ also installed for convenience.
 
 ```powershell
 apdf-cloud-cli storage list /
+apdf-cloud-cli auth status
+apdf-cloud-cli auth test
 apdf-cloud-cli storage upload .\sample.pdf /sample.pdf
 apdf-cloud-cli storage download /sample.pdf .\sample.pdf
 apdf-cloud-cli pdf merge /a.pdf /b.pdf merged.pdf

{apdf_cloud_cli-0.2.0 → apdf_cloud_cli-0.3.0}/README.md

@@ -26,7 +26,16 @@ python -m pip install -e ".[dev]"
 
 ## Configuration
 
-Set credentials before running CLI commands or the MCP server:
+Set credentials before running CLI commands or the MCP server. The easiest
+local setup path is:
+
+```powershell
+apdf auth login
+apdf auth status
+apdf auth test
+```
+
+You can also set credentials directly in your shell:
 
 ```powershell
 $env:ASPOSE_CLIENT_ID = "your-client-id"
@@ -50,6 +59,8 @@ also installed for convenience.
 
 ```powershell
 apdf-cloud-cli storage list /
+apdf-cloud-cli auth status
+apdf-cloud-cli auth test
 apdf-cloud-cli storage upload .\sample.pdf /sample.pdf
 apdf-cloud-cli storage download /sample.pdf .\sample.pdf
 apdf-cloud-cli pdf merge /a.pdf /b.pdf merged.pdf

{apdf_cloud_cli-0.2.0 → apdf_cloud_cli-0.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "apdf-cloud-cli"
-version = "0.2.0"
+version = "0.3.0"
 description = "CLI and MCP server tools for Aspose PDF Cloud"
 authors = [
     {name = "Andriy Andruhovski",email = "andruhovski@gmail.com"}

{apdf_cloud_cli-0.2.0 → apdf_cloud_cli-0.3.0}/src/apdf_cloud_cli/__init__.py

@@ -2,4 +2,4 @@
 
 __all__ = ["__version__"]
 
-__version__ = "0.2.0"
+__version__ = "0.3.0"

{apdf_cloud_cli-0.2.0 → apdf_cloud_cli-0.3.0}/src/apdf_cloud_cli/cli.py

@@ -11,14 +11,16 @@ from rich.console import Console
 from rich.table import Table
 
 from . import operations
-from .config import ConfigError
+from .config import ConfigError, get_auth_status, write_auth_env_file
 from .skill_installer import SkillInstallError, install_skill
 
 app = typer.Typer(help="APDF CLI tools.")
+auth_app = typer.Typer(help="Credential setup and validation.")
 storage_app = typer.Typer(help="Cloud storage operations.")
 pdf_app = typer.Typer(help="PDF operations.")
 mcp_app = typer.Typer(help="MCP server commands.")
 skill_app = typer.Typer(help="Install bundled agent skills.")
+app.add_typer(auth_app, name="auth")
 app.add_typer(storage_app, name="storage")
 app.add_typer(pdf_app, name="pdf")
 app.add_typer(mcp_app, name="mcp")
@@ -43,6 +45,147 @@ def _run(action):
         _handle_error(exc)
 
 
+@auth_app.command("status")
+def auth_status(
+    env_file: Annotated[
+        Path | None,
+        typer.Option("--env-file", help="Local .env file to inspect."),
+    ] = Path(".env"),
+    as_json: Annotated[bool, typer.Option("--json", help="Emit JSON output.")] = False,
+) -> None:
+    """Show redacted APDF credential configuration status."""
+
+    status = get_auth_status(env_file)
+    if as_json:
+        _json(status)
+        return
+
+    console.print(
+        "[green]Configured[/green]"
+        if status["configured"]
+        else "[yellow]Missing required credentials[/yellow]"
+    )
+    table = Table(title=f"Auth status: {status['env_file'] or 'environment only'}")
+    table.add_column("Setting")
+    table.add_column("Source")
+    table.add_column("Value")
+
+    settings = status["settings"]
+    if isinstance(settings, dict):
+        for key, details in settings.items():
+            if not isinstance(details, dict):
+                continue
+            table.add_row(
+                key,
+                str(details.get("source") or "missing"),
+                str(details.get("value") or ""),
+            )
+    console.print(table)
+
+
+@auth_app.command("login")
+def auth_login(
+    env_file: Annotated[
+        Path,
+        typer.Option("--env-file", help="Local .env file to write."),
+    ] = Path(".env"),
+    client_id: Annotated[
+        str | None,
+        typer.Option("--client-id", help="Aspose Cloud client ID."),
+    ] = None,
+    client_secret: Annotated[
+        str | None,
+        typer.Option("--client-secret", help="Aspose Cloud client secret."),
+    ] = None,
+    storage_name: Annotated[
+        str | None,
+        typer.Option("--storage", help="Default Aspose storage name."),
+    ] = None,
+    base_url: Annotated[
+        str | None,
+        typer.Option("--base-url", help="Alternate Aspose PDF Cloud base URL."),
+    ] = None,
+    self_host: Annotated[
+        bool,
+        typer.Option("--self-host/--no-self-host", help="Use self-hosted Aspose PDF Cloud."),
+    ] = False,
+    force: Annotated[
+        bool,
+        typer.Option("--force", help="Overwrite existing APDF values in the env file."),
+    ] = False,
+) -> None:
+    """Save APDF credentials to a local .env file."""
+
+    status = get_auth_status(env_file)
+    settings = status.get("settings", {})
+    has_existing_file_values = (
+        isinstance(settings, dict)
+        and any(
+            isinstance(details, dict) and details.get("source") == "env_file"
+            for details in settings.values()
+        )
+    )
+    if has_existing_file_values and not force:
+        typer.confirm(
+            f"{env_file} already contains APDF settings. Overwrite them?",
+            abort=True,
+        )
+
+    prompt_optional = client_id is None or client_secret is None
+    if client_id is None:
+        client_id = typer.prompt("Aspose client ID")
+    if client_secret is None:
+        client_secret = typer.prompt("Aspose client secret", hide_input=True)
+    if prompt_optional and storage_name is None:
+        storage_name = typer.prompt(
+            "Default storage name (optional)",
+            default="",
+            show_default=False,
+        )
+    if prompt_optional and base_url is None:
+        base_url = typer.prompt(
+            "Base URL (optional)",
+            default="",
+            show_default=False,
+        )
+
+    result = _run(
+        lambda: write_auth_env_file(
+            env_file,
+            {
+                "ASPOSE_CLIENT_ID": client_id,
+                "ASPOSE_CLIENT_SECRET": client_secret,
+                "ASPOSE_STORAGE_NAME": storage_name,
+                "ASPOSE_BASE_URL": base_url,
+                "ASPOSE_SELF_HOST": self_host,
+            },
+        )
+    )
+    console.print(f"Saved APDF credentials to [bold]{result}[/bold].")
+
+
+@auth_app.command("test")
+def auth_test(
+    path: Annotated[
+        str,
+        typer.Option("--path", help="Storage folder path to list during validation."),
+    ] = "/",
+    storage: Annotated[str | None, typer.Option("--storage", help="Storage name.")] = None,
+    as_json: Annotated[bool, typer.Option("--json", help="Emit JSON output.")] = False,
+) -> None:
+    """Validate APDF credentials with a harmless storage API call."""
+
+    result = _run(lambda: operations.test_auth(path, storage))
+    if as_json:
+        _json(result)
+        return
+    console.print(
+        "[green]APDF credentials are valid.[/green] "
+        f"Listed [bold]{result['path']}[/bold]"
+        + (f" in storage [bold]{result['storage_name']}[/bold]." if result["storage_name"] else ".")
+    )
+
+
 @storage_app.command("list")
 def list_storage_files(
     path: Annotated[str, typer.Argument(help="Folder path in Aspose storage.")],

apdf_cloud_cli-0.3.0/src/apdf_cloud_cli/config.py

@@ -0,0 +1,178 @@
+"""Configuration helpers for APDF access."""
+
+from __future__ import annotations
+
+import os
+from dataclasses import dataclass
+from pathlib import Path
+
+
+class ConfigError(RuntimeError):
+    """Raised when required configuration is missing or invalid."""
+
+
+APDF_ENV_KEYS = (
+    "ASPOSE_CLIENT_ID",
+    "ASPOSE_CLIENT_SECRET",
+    "ASPOSE_STORAGE_NAME",
+    "ASPOSE_BASE_URL",
+    "ASPOSE_SELF_HOST",
+)
+
+
+@dataclass(frozen=True)
+class AsposeConfig:
+    client_id: str
+    client_secret: str
+    base_url: str | None = None
+    self_host: bool = False
+    storage_name: str | None = None
+
+
+def _truthy(value: str | None) -> bool:
+    return value is not None and value.strip().lower() in {"1", "true", "yes", "on"}
+
+
+def _read_env_file(path: str | Path | None) -> dict[str, str]:
+    if path is None:
+        return {}
+
+    env_path = Path(path)
+    if not env_path.is_file():
+        return {}
+
+    values: dict[str, str] = {}
+    for line in env_path.read_text(encoding="utf-8").splitlines():
+        stripped = line.strip()
+        if not stripped or stripped.startswith("#") or "=" not in stripped:
+            continue
+        key, value = stripped.split("=", 1)
+        key = key.strip()
+        value = value.strip().strip('"').strip("'")
+        if key:
+            values[key] = value
+    return values
+
+
+def _get_setting(name: str, env_file_values: dict[str, str]) -> str:
+    return os.getenv(name, env_file_values.get(name, "")).strip()
+
+
+def _format_env_value(value: str) -> str:
+    escaped = value.replace("\\", "\\\\").replace('"', '\\"')
+    return f'"{escaped}"'
+
+
+def _env_key_from_line(line: str) -> str | None:
+    stripped = line.strip()
+    if not stripped or stripped.startswith("#") or "=" not in stripped:
+        return None
+    key, _ = stripped.split("=", 1)
+    key = key.strip()
+    return key or None
+
+
+def load_config(env_file: str | Path | None = ".env") -> AsposeConfig:
+    """Load Aspose Cloud configuration from environment variables and optional .env."""
+
+    env_file_values = _read_env_file(env_file)
+
+    client_id = _get_setting("ASPOSE_CLIENT_ID", env_file_values)
+    client_secret = _get_setting("ASPOSE_CLIENT_SECRET", env_file_values)
+
+    if not client_id or not client_secret:
+        raise ConfigError(
+            "Missing Aspose credentials. Set ASPOSE_CLIENT_ID and "
+            "ASPOSE_CLIENT_SECRET."
+        )
+
+    base_url = _get_setting("ASPOSE_BASE_URL", env_file_values) or None
+    storage_name = _get_setting("ASPOSE_STORAGE_NAME", env_file_values) or None
+
+    return AsposeConfig(
+        client_id=client_id,
+        client_secret=client_secret,
+        base_url=base_url,
+        self_host=_truthy(_get_setting("ASPOSE_SELF_HOST", env_file_values)),
+        storage_name=storage_name,
+    )
+
+
+def get_auth_status(env_file: str | Path | None = ".env") -> dict[str, object]:
+    """Return redacted APDF credential status from environment and optional .env."""
+
+    env_file_values = _read_env_file(env_file)
+    settings: dict[str, dict[str, str | bool | None]] = {}
+
+    for key in APDF_ENV_KEYS:
+        env_value = os.getenv(key)
+        file_value = env_file_values.get(key)
+        value = (env_value if env_value is not None else file_value) or ""
+        source = "environment" if env_value is not None else "env_file" if file_value else "missing"
+        settings[key] = {
+            "configured": bool(value.strip()),
+            "source": source,
+            "value": redact_secret(value),
+        }
+
+    configured = bool(
+        settings["ASPOSE_CLIENT_ID"]["configured"]
+        and settings["ASPOSE_CLIENT_SECRET"]["configured"]
+    )
+    return {
+        "configured": configured,
+        "env_file": str(env_file) if env_file is not None else None,
+        "settings": settings,
+    }
+
+
+def redact_secret(value: str | None) -> str:
+    """Return a display-safe representation of a secret-like value."""
+
+    if not value:
+        return ""
+    stripped = value.strip()
+    if len(stripped) <= 8:
+        return "<set>"
+    return f"{stripped[:4]}...{stripped[-4:]}"
+
+
+def write_auth_env_file(
+    env_file: str | Path,
+    values: dict[str, str | bool | None],
+) -> Path:
+    """Write APDF auth settings to a .env file while preserving unrelated lines."""
+
+    env_path = Path(env_file)
+    updates: dict[str, str] = {}
+    for key in APDF_ENV_KEYS:
+        value = values.get(key)
+        if isinstance(value, bool):
+            updates[key] = "true" if value else "false"
+        elif value is not None and str(value).strip():
+            updates[key] = str(value).strip()
+
+    if not updates.get("ASPOSE_CLIENT_ID") or not updates.get("ASPOSE_CLIENT_SECRET"):
+        raise ConfigError("ASPOSE_CLIENT_ID and ASPOSE_CLIENT_SECRET are required.")
+
+    lines = env_path.read_text(encoding="utf-8").splitlines() if env_path.exists() else []
+    written_keys: set[str] = set()
+    output: list[str] = []
+
+    for line in lines:
+        key = _env_key_from_line(line)
+        if key in updates:
+            output.append(f"{key}={_format_env_value(updates[key])}")
+            written_keys.add(key)
+        else:
+            output.append(line)
+
+    if output and any(key not in written_keys for key in updates):
+        output.append("")
+    for key in APDF_ENV_KEYS:
+        if key in updates and key not in written_keys:
+            output.append(f"{key}={_format_env_value(updates[key])}")
+
+    env_path.parent.mkdir(parents=True, exist_ok=True)
+    env_path.write_text("\n".join(output) + "\n", encoding="utf-8")
+    return env_path

{apdf_cloud_cli-0.2.0 → apdf_cloud_cli-0.3.0}/src/apdf_cloud_cli/operations.py

@@ -83,6 +83,29 @@ def list_files(
     return {"path": path, "storage_name": effective_storage, "items": to_plain_data(response)}
 
 
+def test_auth(
+    path: str = "/",
+    storage_name: str | None = None,
+    *,
+    api: Any | None = None,
+    config: AsposeConfig | None = None,
+) -> dict[str, Any]:
+    """Validate APDF credentials with a harmless storage listing."""
+
+    result = list_files(path, storage_name, api=api, config=config)
+    items = result.get("items", {})
+    values = items.get("value") or items.get("Value") or items.get("files") or items
+    if isinstance(values, dict):
+        values = values.get("value") or values.get("Value") or []
+    item_count = len(values) if isinstance(values, list) else None
+    return {
+        "ok": True,
+        "path": result["path"],
+        "storage_name": result["storage_name"],
+        "item_count": item_count,
+    }
+
+
 def upload_file(
     local_path: str | Path,
     remote_path: str,

apdf_cloud_cli-0.2.0/src/apdf_cloud_cli/config.py

@@ -1,75 +0,0 @@
-"""Configuration helpers for APDF access."""
-
-from __future__ import annotations
-
-import os
-from dataclasses import dataclass
-from pathlib import Path
-
-
-class ConfigError(RuntimeError):
-    """Raised when required configuration is missing or invalid."""
-
-
-@dataclass(frozen=True)
-class AsposeConfig:
-    client_id: str
-    client_secret: str
-    base_url: str | None = None
-    self_host: bool = False
-    storage_name: str | None = None
-
-
-def _truthy(value: str | None) -> bool:
-    return value is not None and value.strip().lower() in {"1", "true", "yes", "on"}
-
-
-def _read_env_file(path: str | Path | None) -> dict[str, str]:
-    if path is None:
-        return {}
-
-    env_path = Path(path)
-    if not env_path.is_file():
-        return {}
-
-    values: dict[str, str] = {}
-    for line in env_path.read_text(encoding="utf-8").splitlines():
-        stripped = line.strip()
-        if not stripped or stripped.startswith("#") or "=" not in stripped:
-            continue
-        key, value = stripped.split("=", 1)
-        key = key.strip()
-        value = value.strip().strip('"').strip("'")
-        if key:
-            values[key] = value
-    return values
-
-
-def _get_setting(name: str, env_file_values: dict[str, str]) -> str:
-    return os.getenv(name, env_file_values.get(name, "")).strip()
-
-
-def load_config(env_file: str | Path | None = ".env") -> AsposeConfig:
-    """Load Aspose Cloud configuration from environment variables and optional .env."""
-
-    env_file_values = _read_env_file(env_file)
-
-    client_id = _get_setting("ASPOSE_CLIENT_ID", env_file_values)
-    client_secret = _get_setting("ASPOSE_CLIENT_SECRET", env_file_values)
-
-    if not client_id or not client_secret:
-        raise ConfigError(
-            "Missing Aspose credentials. Set ASPOSE_CLIENT_ID and "
-            "ASPOSE_CLIENT_SECRET."
-        )
-
-    base_url = _get_setting("ASPOSE_BASE_URL", env_file_values) or None
-    storage_name = _get_setting("ASPOSE_STORAGE_NAME", env_file_values) or None
-
-    return AsposeConfig(
-        client_id=client_id,
-        client_secret=client_secret,
-        base_url=base_url,
-        self_host=_truthy(_get_setting("ASPOSE_SELF_HOST", env_file_values)),
-        storage_name=storage_name,
-    )