qbraid-cli 0.16.16__tar.gz → 0.16.17__tar.gz

{qbraid_cli-0.16.16/qbraid_cli.egg-info → qbraid_cli-0.16.17}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: qbraid-cli
-Version: 0.16.16
+Version: 0.16.17
 Summary: Command Line Interface for interacting with all parts of the qBraid platform.
 Author-email: qBraid Development Team <contact@qbraid.com>
 License-Expression: LicenseRef-Proprietary
@@ -30,11 +30,11 @@ Requires-Dist: typer>=0.12.1
 Requires-Dist: rich>=10.11.0
 Requires-Dist: click<=8.5.0
 Requires-Dist: questionary>=2.0.0
-Requires-Dist: qbraid-core>=0.6.35
+Requires-Dist: qbraid-core>=0.6.43
 Provides-Extra: compute
-Requires-Dist: qbraid-core[compute]>=0.6.35; extra == "compute"
+Requires-Dist: qbraid-core[compute]>=0.6.43; extra == "compute"
 Provides-Extra: envs
-Requires-Dist: qbraid-core[environments]>=0.6.35; extra == "envs"
+Requires-Dist: qbraid-core[environments]>=0.6.43; extra == "envs"
 Provides-Extra: dev
 Requires-Dist: isort; extra == "dev"
 Requires-Dist: black; extra == "dev"

{qbraid_cli-0.16.16 → qbraid_cli-0.16.17}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "qbraid-cli"
-version = "0.16.16"
+version = "0.16.17"
 description = "Command Line Interface for interacting with all parts of the qBraid platform."
 readme = "README.md"
 authors = [{ name = "qBraid Development Team", email = "contact@qbraid.com" }]
@@ -32,7 +32,7 @@ dependencies = [
     "rich>=10.11.0",
     "click<=8.5.0",
     "questionary>=2.0.0",
-    "qbraid-core>=0.6.35",
+    "qbraid-core>=0.6.43",
 ]
 requires-python = ">= 3.10"
 
@@ -43,8 +43,8 @@ Documentation = "https://docs.qbraid.com/v2/cli/api-reference/qbraid"
 Discord = "https://discord.gg/KugF6Cnncm"
 
 [project.optional-dependencies]
-compute = ["qbraid-core[compute]>=0.6.35"]
-envs = ["qbraid-core[environments]>=0.6.35"]
+compute = ["qbraid-core[compute]>=0.6.43"]
+envs = ["qbraid-core[environments]>=0.6.43"]
 dev = ["isort", "black", "pytest", "pytest-cov", "pytest-asyncio"]
 
 [project.scripts]

qbraid_cli-0.16.17/qbraid_cli/artifacts/__init__.py

@@ -0,0 +1,7 @@
+# Copyright (c) 2026, qBraid Development Team
+# All rights reserved.
+"""Artifact CLI commands."""
+
+from .app import artifacts_app
+
+__all__ = ["artifacts_app"]

qbraid_cli-0.16.17/qbraid_cli/artifacts/app.py

@@ -0,0 +1,245 @@
+# Copyright (c) 2026, qBraid Development Team
+# All rights reserved.
+"""CLI surfaces for hosted HTML artifacts; all operations delegate to Core."""
+
+import json
+import re
+from enum import Enum
+from pathlib import Path
+from typing import Callable, Optional, TypeVar
+
+import typer
+from rich.console import Console
+from rich.table import Table
+from rich.text import Text
+
+from qbraid_cli.agents.work import _safe
+from qbraid_cli.handlers import handle_error
+
+artifacts_app = typer.Typer(
+    help="Publish and share standalone HTML.\n\nLists show only your artifacts.", no_args_is_help=True
+)
+
+CORE_MODULE = "qbraid_core.services.artifacts"
+OLD_CORE = "qbraid artifacts requires qbraid-core 0.6.43 or newer; run: pip install -U qbraid-core"
+PUBLIC_NOTE = "Anyone with the link can view this artifact."
+MAX_ERROR = 300
+_ID = re.compile(r"[a-f0-9]{32}")
+_EMAIL = re.compile(r"[^@\s]+@[^@\s]+\.[^@\s]+")
+# An error page (HTML/XML) rather than an API message: show the status instead.
+_MARKUP = re.compile(r"<\s*[!/?a-zA-Z]")
+_Result = TypeVar("_Result")
+
+
+class Access(str, Enum):
+    """Artifact visibility."""
+
+    PRIVATE = "private"
+    SHARED = "shared"
+    PUBLIC = "public"
+
+
+def _client():
+    from qbraid_core.services.artifacts import ArtifactsClient
+
+    return ArtifactsClient()
+
+
+def _plain(value) -> str:
+    """API text made terminal-inert: no controls, escapes, bidi or invisible marks."""
+    return _safe(value if isinstance(value, str) else str(value)).plain
+
+
+def _error_text(err: Exception) -> str:
+    if isinstance(err, ModuleNotFoundError) and (err.name or "").startswith(CORE_MODULE):
+        return OLD_CORE
+    if isinstance(err, UnicodeDecodeError):
+        return "The file is not valid UTF-8; save it as UTF-8 and try again"
+    text = str(err)
+    if _MARKUP.search(text):
+        status = getattr(err, "status_code", None)
+        text = "Artifact request failed" + (f" (HTTP {status})" if status else "")
+        return text + "; the API returned a non-JSON error page"
+    text = _plain(text)
+    return text if len(text) <= MAX_ERROR else text[: MAX_ERROR - 1] + "…"
+
+
+def _run(operation: Callable[..., _Result]) -> _Result:
+    """Run one operation with a client that is always closed; failures exit 1."""
+    client = None
+    try:
+        client = _client()
+        return operation(client)
+    except Exception as err:  # pylint: disable=broad-exception-caught
+        handle_error(message=_error_text(err), include_traceback=False)
+        raise  # unreachable: handle_error exits
+    finally:
+        if client is not None:
+            client.close()
+
+
+def _fail(message: str) -> None:
+    handle_error(message=message, include_traceback=False)
+
+
+def _check_id(slug: str) -> str:
+    if not _ID.fullmatch(slug):
+        raise typer.BadParameter("use the 32-character ID shown by 'qbraid artifacts list'")
+    return slug
+
+
+def _check_file(path: Optional[Path]) -> None:
+    """Say precisely why a file is refused before any request; Core re-checks."""
+    if path is None:
+        return
+    if path.is_symlink():
+        _fail("Symbolic links are not supported; pass the HTML file itself")
+    if path.suffix.lower() not in (".html", ".htm"):
+        _fail("Provide one .html or .htm file")
+
+
+def _check_email(email: str) -> str:
+    if not _EMAIL.fullmatch(email):
+        raise typer.BadParameter("Provide a valid email address")
+    return email
+
+
+def _dump(model) -> str:
+    # ASCII-escaped JSON: raw data for scripts, inert in a terminal.
+    return json.dumps(model.model_dump(mode="json", by_alias=True))
+
+
+def _emit(artifact, as_json: bool):
+    if as_json:
+        print(_dump(artifact))
+        return
+    print(f"{_plain(artifact.title)} ({_plain(artifact.visibility)})\n{_plain(artifact.url)}")
+    if artifact.visibility == "public":
+        print(PUBLIC_NOTE)
+
+
+ID_ARG = typer.Argument(
+    ..., metavar="ID", callback=_check_id, help="Artifact ID from 'qbraid artifacts list'."
+)
+EMAIL_OPT = typer.Option(..., "--email", callback=_check_email)
+
+
+@artifacts_app.command("publish")
+def publish(
+    file: Path = typer.Argument(..., exists=True, dir_okay=False),
+    title: Optional[str] = typer.Option(None, "--title"),
+    visibility: Access = typer.Option(Access.PRIVATE, "--visibility"),
+    as_json: bool = typer.Option(False, "--json"),
+    new: bool = typer.Option(False, "--new", help="Publish a copy even if this file is already published."),
+):
+    """Publish one standalone HTML file.
+
+    Publishing is immediate; there is no review queue. Publishing the same file
+    with the same title and access returns the existing artifact.
+    """
+    _check_file(file)
+    artifact = _run(
+        lambda client: client.publish(file, title=title, visibility=visibility.value, duplicate=new)
+    )
+    if artifact.created is False and not as_json:
+        print("Already published")
+    _emit(artifact, as_json)
+
+
+@artifacts_app.command("list")
+def list_artifacts(
+    page: int = typer.Option(1, min=1),
+    limit: int = typer.Option(50, min=1, max=100),
+    as_json: bool = typer.Option(False, "--json"),
+):
+    """List your published HTML artifacts.
+
+    This never lists a public or global catalog.
+    """
+    result = _run(lambda client: client.list_artifacts(page=page, limit=limit))
+    if as_json:
+        print(_dump(result))
+        return
+    # IDs never wrap or truncate so they can be copied; long titles and links fold.
+    table = Table()
+    table.add_column("ID", no_wrap=True, min_width=32)
+    table.add_column("Title", overflow="fold")
+    table.add_column("Access", no_wrap=True)
+    table.add_column("Link", overflow="fold")
+    for item in result.data:
+        table.add_row(*(Text(_plain(v)) for v in (item.slug, item.title, item.visibility, item.url)))
+    Console().print(table)
+    print(f"Page {page}; {result.pagination.total} artifacts total")
+
+
+@artifacts_app.command("get")
+def get(slug: str = ID_ARG, as_json: bool = typer.Option(False, "--json")):
+    """Show one artifact you can view."""
+    _emit(_run(lambda client: client.get_artifact(slug)), as_json)
+
+
+@artifacts_app.command("update")
+def update(
+    slug: str = ID_ARG,
+    file: Optional[Path] = typer.Option(None, "--file", exists=True, dir_okay=False),
+    title: Optional[str] = typer.Option(None, "--title"),
+    visibility: Optional[Access] = typer.Option(None, "--visibility"),
+    as_json: bool = typer.Option(False, "--json"),
+):
+    """Update HTML, title, or access.
+
+    The share link is preserved.
+    """
+    _check_file(file)
+    artifact = _run(
+        lambda client: client.update(
+            slug, path=file, title=title, visibility=visibility.value if visibility else None
+        )
+    )
+    _emit(artifact, as_json)
+
+
+@artifacts_app.command("share")
+def share(slug: str = ID_ARG, email: str = EMAIL_OPT, as_json: bool = typer.Option(False, "--json")):
+    """Grant a qBraid user viewing access.
+
+    The recipient must sign in. Send them the link after granting access.
+    """
+    _emit(_run(lambda client: client.share(slug, email)), as_json)
+
+
+@artifacts_app.command("revoke")
+def revoke(slug: str = ID_ARG, email: str = EMAIL_OPT, as_json: bool = typer.Option(False, "--json")):
+    """Remove a collaborator viewing grant.
+
+    Public artifacts remain accessible via their link.
+    """
+    _emit(_run(lambda client: client.revoke(slug, email)), as_json)
+
+
+@artifacts_app.command("unpublish")
+def unpublish(slug: str = ID_ARG, as_json: bool = typer.Option(False, "--json")):
+    """Make an artifact owner-only.
+
+    Disables both public and shared viewing.
+    """
+    _emit(_run(lambda client: client.update(slug, visibility="private")), as_json)
+
+
+@artifacts_app.command("delete")
+def delete(
+    slug: str = ID_ARG,
+    yes: bool = typer.Option(False, "--yes"),
+    as_json: bool = typer.Option(False, "--json"),
+):
+    """Delete an artifact and its HTML.
+
+    Use --yes in non-interactive scripts; --json requires --yes.
+    """
+    if as_json and not yes:
+        print(json.dumps({"deleted": False, "slug": slug, "error": "--json requires --yes"}))
+        raise typer.Exit(code=1)
+    if not yes:
+        typer.confirm("Delete this artifact and its HTML?", abort=True, err=True)
+    _run(lambda client: client.delete(slug))
+    print(json.dumps({"deleted": True, "slug": slug}) if as_json else "Artifact deleted")

{qbraid_cli-0.16.16 → qbraid_cli-0.16.17}/qbraid_cli/main.py

@@ -13,6 +13,7 @@ from qbraid_cli.account import account_app
 from qbraid_cli.admin import admin_app
 from qbraid_cli.agents import agents_app
 from qbraid_cli.ai.app import ai_app
+from qbraid_cli.artifacts import artifacts_app
 from qbraid_cli.comms import comms_app
 from qbraid_cli.compute import compute_app
 from qbraid_cli.configure import configure_app
@@ -55,6 +56,7 @@ app.add_typer(devices_app, name="devices")
 app.add_typer(jobs_app, name="jobs")
 app.add_typer(projects_app, name="projects")
 app.add_typer(skills_app, name="skills")
+app.add_typer(artifacts_app, name="artifacts")
 app.add_typer(troubleshoot_app, name="troubleshoot")
 
 if ENVS_COMMANDS is True:

{qbraid_cli-0.16.16 → qbraid_cli-0.16.17/qbraid_cli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: qbraid-cli
-Version: 0.16.16
+Version: 0.16.17
 Summary: Command Line Interface for interacting with all parts of the qBraid platform.
 Author-email: qBraid Development Team <contact@qbraid.com>
 License-Expression: LicenseRef-Proprietary
@@ -30,11 +30,11 @@ Requires-Dist: typer>=0.12.1
 Requires-Dist: rich>=10.11.0
 Requires-Dist: click<=8.5.0
 Requires-Dist: questionary>=2.0.0
-Requires-Dist: qbraid-core>=0.6.35
+Requires-Dist: qbraid-core>=0.6.43
 Provides-Extra: compute
-Requires-Dist: qbraid-core[compute]>=0.6.35; extra == "compute"
+Requires-Dist: qbraid-core[compute]>=0.6.43; extra == "compute"
 Provides-Extra: envs
-Requires-Dist: qbraid-core[environments]>=0.6.35; extra == "envs"
+Requires-Dist: qbraid-core[environments]>=0.6.43; extra == "envs"
 Provides-Extra: dev
 Requires-Dist: isort; extra == "dev"
 Requires-Dist: black; extra == "dev"

{qbraid_cli-0.16.16 → qbraid_cli-0.16.17}/qbraid_cli.egg-info/SOURCES.txt

@@ -30,6 +30,8 @@ qbraid_cli/agents/work.py
 qbraid_cli/ai/__init__.py
 qbraid_cli/ai/app.py
 qbraid_cli/ai/token.py
+qbraid_cli/artifacts/__init__.py
+qbraid_cli/artifacts/app.py
 qbraid_cli/comms/__init__.py
 qbraid_cli/comms/app.py
 qbraid_cli/compute/__init__.py

{qbraid_cli-0.16.16 → qbraid_cli-0.16.17}/qbraid_cli.egg-info/requires.txt

@@ -2,10 +2,10 @@ typer>=0.12.1
 rich>=10.11.0
 click<=8.5.0
 questionary>=2.0.0
-qbraid-core>=0.6.35
+qbraid-core>=0.6.43
 
 [compute]
-qbraid-core[compute]>=0.6.35
+qbraid-core[compute]>=0.6.43
 
 [dev]
 isort
@@ -15,4 +15,4 @@ pytest-cov
 pytest-asyncio
 
 [envs]
-qbraid-core[environments]>=0.6.35
+qbraid-core[environments]>=0.6.43