officecli-sdk 0.1.0__tar.gz → 0.1.2__tar.gz

{officecli_sdk-0.1.0/officecli_sdk.egg-info → officecli_sdk-0.1.2}/PKG-INFO

@@ -1,8 +1,10 @@
 Metadata-Version: 2.4
 Name: officecli-sdk
-Version: 0.1.0
+Version: 0.1.2
 Summary: Thin Python SDK for the officecli resident pipe — forwards officecli commands to a running resident, no per-command process spawn.
 License-Expression: Apache-2.0
+Project-URL: Homepage, https://officecli.ai
+Project-URL: Repository, https://github.com/iOfficeAI/OfficeCLI
 Keywords: officecli,office,docx,xlsx,pptx,ooxml
 Classifier: Programming Language :: Python :: 3
 Classifier: Operating System :: MacOS
@@ -13,7 +15,7 @@ Description-Content-Type: text/markdown
 
 # officecli — Python SDK
 
-A **thin** Python SDK for the [officecli](../../) **resident pipe**. It does one
+A **thin** Python SDK for the [officecli](https://officecli.ai) **resident pipe**. It does one
 thing: forward an officecli command to a running resident over its named pipe and
 hand back the response — no per-command process spawn, so a loop of edits is
 ~hundreds of times faster than shelling out to the CLI per command.
@@ -30,8 +32,20 @@ the day they ship without an SDK update.
 
 `pip install officecli-sdk` installs **only this SDK** (the Python library). It
 shells out to the `officecli` binary, which must be installed separately and on
-your `PATH` (Homebrew, etc.). If `officecli --version` works in your shell, you're
-set.
+your `PATH`. If `officecli --version` works in your shell you're set; otherwise
+the SDK raises a clear error pointing here (never a cryptic `FileNotFoundError`).
+
+Install the CLI once:
+
+```bash
+python -m officecli install      # runs officecli's official installer
+# …or directly:
+curl -fsSL https://raw.githubusercontent.com/iOfficeAI/OfficeCLI/main/install.sh | bash
+```
+
+`officecli.install()` does the same from Python. Installation is always
+**explicit** — the SDK never auto-downloads the binary behind your back. (Not on
+Windows: grab it from [GitHub Releases](https://github.com/iOfficeAI/OfficeCLI/releases).)
 
 ## Install
 

officecli_sdk-0.1.0/PKG-INFO → officecli_sdk-0.1.2/README.md

@@ -1,19 +1,6 @@
-Metadata-Version: 2.4
-Name: officecli-sdk
-Version: 0.1.0
-Summary: Thin Python SDK for the officecli resident pipe — forwards officecli commands to a running resident, no per-command process spawn.
-License-Expression: Apache-2.0
-Keywords: officecli,office,docx,xlsx,pptx,ooxml
-Classifier: Programming Language :: Python :: 3
-Classifier: Operating System :: MacOS
-Classifier: Operating System :: POSIX :: Linux
-Classifier: Operating System :: Microsoft :: Windows
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-
 # officecli — Python SDK
 
-A **thin** Python SDK for the [officecli](../../) **resident pipe**. It does one
+A **thin** Python SDK for the [officecli](https://officecli.ai) **resident pipe**. It does one
 thing: forward an officecli command to a running resident over its named pipe and
 hand back the response — no per-command process spawn, so a loop of edits is
 ~hundreds of times faster than shelling out to the CLI per command.
@@ -30,8 +17,20 @@ the day they ship without an SDK update.
 
 `pip install officecli-sdk` installs **only this SDK** (the Python library). It
 shells out to the `officecli` binary, which must be installed separately and on
-your `PATH` (Homebrew, etc.). If `officecli --version` works in your shell, you're
-set.
+your `PATH`. If `officecli --version` works in your shell you're set; otherwise
+the SDK raises a clear error pointing here (never a cryptic `FileNotFoundError`).
+
+Install the CLI once:
+
+```bash
+python -m officecli install      # runs officecli's official installer
+# …or directly:
+curl -fsSL https://raw.githubusercontent.com/iOfficeAI/OfficeCLI/main/install.sh | bash
+```
+
+`officecli.install()` does the same from Python. Installation is always
+**explicit** — the SDK never auto-downloads the binary behind your back. (Not on
+Windows: grab it from [GitHub Releases](https://github.com/iOfficeAI/OfficeCLI/releases).)
 
 ## Install
 

{officecli_sdk-0.1.0 → officecli_sdk-0.1.2}/officecli.py

@@ -62,6 +62,17 @@ _IS_WIN = sys.platform.startswith("win")
 _IS_MAC = sys.platform == "darwin"
 _builtin_open = open   # preserved; this module defines its own open() below
 
+# officecli's official installer (README one-liner). install() shells out to it;
+# the missing-CLI error points users at it / at install().
+_INSTALL_URL = "https://raw.githubusercontent.com/iOfficeAI/OfficeCLI/main/install.sh"
+_MISSING_CLI = (
+    "officecli CLI not found: {bin!r} is not on PATH. This SDK only forwards "
+    "commands to the officecli binary, which must be installed separately. Install it:\n"
+    "    python -m officecli install            # runs the official installer\n"
+    "    # or: curl -fsSL " + _INSTALL_URL + " | bash\n"
+    "Already installed elsewhere? pass binary=\"/path/to/officecli\"."
+)
+
 
 class OfficeCliError(Exception):
     """Raised on transport/process failure (could not reach the resident).
@@ -218,6 +229,15 @@ def _serves(ping_path, full_path, timeout=1.0):
     return a == full_path or ((_IS_MAC or _IS_WIN) and a.lower() == full_path.lower())
 
 
+def _run_cli(binary, argv):
+    """Run `binary <argv...>` (capturing output). A missing binary surfaces as a
+    clear OfficeCliError with install guidance, not a raw FileNotFoundError."""
+    try:
+        return subprocess.run([binary, *argv], capture_output=True, text=True)
+    except FileNotFoundError:
+        raise OfficeCliError(127, _MISSING_CLI.format(bin=binary)) from None
+
+
 # ---------------------------------------------------------------- the shell
 class Document:
     def __init__(self, path, binary="officecli", timeout=30.0):
@@ -240,7 +260,7 @@ class Document:
             return
         # Otherwise spawn `officecli open` (one process). It's idempotent and uses
         # the same TryConnect to start a fresh resident or replace a stale socket.
-        r = subprocess.run([self.bin, "open", self.path], capture_output=True, text=True)
+        r = _run_cli(self.bin, ["open", self.path])
         if r.returncode != 0:
             raise OfficeCliError(r.returncode, r.stderr or r.stdout)
 
@@ -370,7 +390,7 @@ def create(path, *args, binary="officecli", timeout=30.0):
         another owner's active session.
       • file exists without --force → file_exists (pass "--force" to overwrite)."""
     full = os.path.abspath(path)
-    r = subprocess.run([binary, "create", full, *args], capture_output=True, text=True)
+    r = _run_cli(binary, ["create", full, *args])
     if r.returncode != 0:
         raise OfficeCliError(r.returncode, r.stderr or r.stdout)
     # create auto-started a resident for the new file; bind a handle to it
@@ -402,6 +422,41 @@ def open(path, binary="officecli", timeout=30.0):
     return Document(path, binary=binary, timeout=timeout)
 
 
+def install():
+    """Install the officecli CLI binary via its OFFICIAL installer — explicit by
+    design (this SDK never auto-downloads a binary behind your back). Reuses
+    officecli's own install.sh (platform detection + checksum + ~/.local/bin),
+    rather than reimplementing download logic that would drift from upstream.
+
+    Equivalent to `python -m officecli install`, or the README one-liner
+    `curl -fsSL <install.sh> | bash`. Returns None on success; raises
+    OfficeCliError on failure. Not supported on Windows (install.sh needs bash) —
+    download from GitHub Releases and put officecli on PATH instead."""
+    if _IS_WIN:
+        raise OfficeCliError(1,
+            "Automatic install isn't supported on Windows (install.sh needs bash). "
+            "Download officecli from https://github.com/iOfficeAI/OfficeCLI/releases "
+            "and put it on PATH.")
+    print(f"Installing officecli via {_INSTALL_URL} ...", file=sys.stderr)
+    # Reuse the official installer verbatim; do NOT capture, so its progress and
+    # checksum output stream to the user (this is an explicit, interactive action).
+    r = subprocess.run(["bash", "-c", f"curl -fsSL {_INSTALL_URL} | bash"])
+    if r.returncode != 0:
+        raise OfficeCliError(r.returncode,
+            f"officecli install failed (exit {r.returncode}). Run manually:\n"
+            f"    curl -fsSL {_INSTALL_URL} | bash")
+    return None
+
+
 # Advertised surface = the command shell + its error. pipe_paths stays importable
 # (officecli.pipe_paths) as a debug helper but isn't part of the command API.
-__all__ = ["open", "create", "Document", "OfficeCliError"]
+__all__ = ["open", "create", "install", "Document", "OfficeCliError"]
+
+
+if __name__ == "__main__":
+    # `python -m officecli install` — bootstrap the CLI binary.
+    if len(sys.argv) >= 2 and sys.argv[1] == "install":
+        install()
+    else:
+        print("usage: python -m officecli install", file=sys.stderr)
+        sys.exit(2)

officecli_sdk-0.1.0/README.md → officecli_sdk-0.1.2/officecli_sdk.egg-info/PKG-INFO

@@ -1,6 +1,21 @@
+Metadata-Version: 2.4
+Name: officecli-sdk
+Version: 0.1.2
+Summary: Thin Python SDK for the officecli resident pipe — forwards officecli commands to a running resident, no per-command process spawn.
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://officecli.ai
+Project-URL: Repository, https://github.com/iOfficeAI/OfficeCLI
+Keywords: officecli,office,docx,xlsx,pptx,ooxml
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: Microsoft :: Windows
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+
 # officecli — Python SDK
 
-A **thin** Python SDK for the [officecli](../../) **resident pipe**. It does one
+A **thin** Python SDK for the [officecli](https://officecli.ai) **resident pipe**. It does one
 thing: forward an officecli command to a running resident over its named pipe and
 hand back the response — no per-command process spawn, so a loop of edits is
 ~hundreds of times faster than shelling out to the CLI per command.
@@ -17,8 +32,20 @@ the day they ship without an SDK update.
 
 `pip install officecli-sdk` installs **only this SDK** (the Python library). It
 shells out to the `officecli` binary, which must be installed separately and on
-your `PATH` (Homebrew, etc.). If `officecli --version` works in your shell, you're
-set.
+your `PATH`. If `officecli --version` works in your shell you're set; otherwise
+the SDK raises a clear error pointing here (never a cryptic `FileNotFoundError`).
+
+Install the CLI once:
+
+```bash
+python -m officecli install      # runs officecli's official installer
+# …or directly:
+curl -fsSL https://raw.githubusercontent.com/iOfficeAI/OfficeCLI/main/install.sh | bash
+```
+
+`officecli.install()` does the same from Python. Installation is always
+**explicit** — the SDK never auto-downloads the binary behind your back. (Not on
+Windows: grab it from [GitHub Releases](https://github.com/iOfficeAI/OfficeCLI/releases).)
 
 ## Install
 

{officecli_sdk-0.1.0 → officecli_sdk-0.1.2}/pyproject.toml

@@ -7,7 +7,7 @@ build-backend = "setuptools.build_meta"
 # (`import officecli`), like `pip install pillow` → `import PIL`. PyPI rejects
 # the bare name "officecli" as too similar to the unrelated "office-cli" project.
 name = "officecli-sdk"
-version = "0.1.0"
+version = "0.1.2"
 description = "Thin Python SDK for the officecli resident pipe — forwards officecli commands to a running resident, no per-command process spawn."
 readme = "README.md"
 requires-python = ">=3.8"
@@ -20,13 +20,13 @@ classifiers = [
     "Operating System :: POSIX :: Linux",
     "Operating System :: Microsoft :: Windows",
 ]
-# TODO(maintainer): fill in before publishing —
-#   authors = [{ name = "...", email = "..." }]
-#   [project.urls]
-#   Homepage   = "..."
-#   Repository = "..."
+# TODO(maintainer): optionally add authors = [{ name = "...", email = "..." }] above.
 
-# IMPORTANT: this package is only the client. It shells out to the `officecli`
+[project.urls]
+Homepage = "https://officecli.ai"
+Repository = "https://github.com/iOfficeAI/OfficeCLI"
+
+# IMPORTANT: this package is only the SDK. It shells out to the `officecli`
 # CLI binary, which must be installed separately and on PATH (Homebrew, etc.).
 # pip cannot install that binary for you — see README.