colabapi 0.1.0__tar.gz → 0.1.1__tar.gz

{colabapi-0.1.0 → colabapi-0.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: colabapi
-Version: 0.1.0
+Version: 0.1.1
 Summary: Run and keep a Google Colab runtime alive, then reach its terminal from your own server or laptop. A CLI for headless, persistent Colab sessions.
 Author: lil-limbo
 License: MIT
@@ -82,6 +82,20 @@ colabapi never handles your Google password
 pipx install colabapi
 ```
 
+### As root (VPS, container, `sudo -i`)
+
+Install system-wide so the command lands in `/usr/local/bin`, which is already on
+root's `PATH`:
+
+```bash
+pipx install --global colabapi
+```
+
+> **Why:** a plain `pipx install` as root puts the script in `/root/.local/bin`, which
+> most distros do **not** add to root's `PATH`. The install succeeds but you get
+> `colabapi: command not found`. `--global` avoids that. (The one-line install script
+> below detects root and does this for you.)
+
 ### With pip
 
 ```bash

{colabapi-0.1.0 → colabapi-0.1.1}/README.md

@@ -51,6 +51,20 @@ colabapi never handles your Google password
 pipx install colabapi
 ```
 
+### As root (VPS, container, `sudo -i`)
+
+Install system-wide so the command lands in `/usr/local/bin`, which is already on
+root's `PATH`:
+
+```bash
+pipx install --global colabapi
+```
+
+> **Why:** a plain `pipx install` as root puts the script in `/root/.local/bin`, which
+> most distros do **not** add to root's `PATH`. The install succeeds but you get
+> `colabapi: command not found`. `--global` avoids that. (The one-line install script
+> below detects root and does this for you.)
+
 ### With pip
 
 ```bash

{colabapi-0.1.0 → colabapi-0.1.1}/colabapi/__init__.py

@@ -4,4 +4,4 @@ The tool never handles your Google password. You sign in to Colab in your own
 browser; colabapi connects to the running runtime over a secure tunnel.
 """
 
-__version__ = "0.1.0"
+__version__ = "0.1.1"

{colabapi-0.1.0 → colabapi-0.1.1}/colabapi/cli.py

@@ -9,6 +9,8 @@ layer on top.
 
 from __future__ import annotations
 
+import os
+import shutil
 import sys
 import time
 
@@ -36,6 +38,30 @@ def _require_colab() -> None:
         raise SystemExit(1)
 
 
+def _check_on_path() -> None:
+    """Warn when `colabapi` is installed somewhere that is not on PATH.
+
+    A plain `pipx install` / `pip install --user` as root drops the script into
+    /root/.local/bin, which most distros do not put on root's PATH. The install
+    then succeeds but `colabapi` reports "command not found", so we say exactly
+    where it landed and how to fix it. Only reachable when the user invoked us by
+    absolute path (otherwise, by definition, we are already on PATH).
+    """
+    here = os.path.dirname(os.path.abspath(sys.argv[0] or ""))
+    if not here or shutil.which("colabapi"):
+        console.print("colabapi on PATH: [green]yes[/]")
+        return
+    console.print(f"colabapi on PATH: [yellow]no[/] (installed at {here})")
+    fix = f'export PATH="{here}:$PATH"'
+    console.print(Panel.fit(
+        f"`colabapi` is not on your PATH, so the bare command will not work.\n\n"
+        f"Add it for this shell:\n  {fix}\n\n"
+        f"Make it permanent:\n  echo '{fix}' >> ~/.bashrc\n\n"
+        f"Or reinstall system-wide (recommended as root):\n"
+        f"  pipx install --global --force colabapi",
+        title="Not on PATH", border_style="yellow"))
+
+
 def _session_label(s: Session) -> str:
     line = timing.session_line(s.started_at, s.max_lifetime_hours) if s.started_at else ""
     return f"{s.name}  [{s.runtime}]  {line}".rstrip()
@@ -380,6 +406,7 @@ def daemon(name: str | None, foreground: bool) -> None:
 @cli.command()
 def doctor() -> None:
     """Check the environment and the official `colab` CLI interface."""
+    _check_on_path()
     ok = colab.available()
     console.print(f"official colab CLI: {'[green]found[/] at ' + colab.path() if ok else '[red]not found[/]'}")
     if not ok:

{colabapi-0.1.0 → colabapi-0.1.1}/colabapi.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: colabapi
-Version: 0.1.0
+Version: 0.1.1
 Summary: Run and keep a Google Colab runtime alive, then reach its terminal from your own server or laptop. A CLI for headless, persistent Colab sessions.
 Author: lil-limbo
 License: MIT
@@ -82,6 +82,20 @@ colabapi never handles your Google password
 pipx install colabapi
 ```
 
+### As root (VPS, container, `sudo -i`)
+
+Install system-wide so the command lands in `/usr/local/bin`, which is already on
+root's `PATH`:
+
+```bash
+pipx install --global colabapi
+```
+
+> **Why:** a plain `pipx install` as root puts the script in `/root/.local/bin`, which
+> most distros do **not** add to root's `PATH`. The install succeeds but you get
+> `colabapi: command not found`. `--global` avoids that. (The one-line install script
+> below detects root and does this for you.)
+
 ### With pip
 
 ```bash

{colabapi-0.1.0 → colabapi-0.1.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "colabapi"
-version = "0.1.0"
+version = "0.1.1"
 description = "Run and keep a Google Colab runtime alive, then reach its terminal from your own server or laptop. A CLI for headless, persistent Colab sessions."
 readme = "README.md"
 requires-python = ">=3.9"