harbor-check-cli 0.1.0__tar.gz

harbor_check_cli-0.1.0/PKG-INFO

@@ -0,0 +1,76 @@
+Metadata-Version: 2.4
+Name: harbor-check-cli
+Version: 0.1.0
+Summary: CLI for Harbor Check review status and rubric summaries
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: Environment :: Console
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: httpx>=0.27
+
+# Harbor Check CLI
+
+Install with `python -m pip install ./saas/harbor-check-cli`.
+
+Login once; the token is stored with mode 0600 and reused by later commands:
+
+```bash
+harbor-check login --server 101.46.8.169 --username alice --password 'secret'
+harbor-check tasks
+```
+
+An address without a scheme is treated as `http://`; use `--server
+http://101.46.8.169:8000` when Harbor Check is listening on a non-default port.
+
+```bash
+harbor-check --server https://review.example.com tasks
+harbor-check --server https://review.example.com folders
+harbor-check --server https://review.example.com folder-tasks batch-name
+```
+
+The CLI authenticates with the server's `/api/auth/login` endpoint. Configure
+Django with `HARBOR_CHECK_AUTH_REQUIRED=1` and `HARBOR_CHECK_USERS_JSON`.
+Values may be plaintext for local development or `pbkdf2_sha256$rounds$salt$hex`
+hashes for deployment. Authenticated users can see all users' tasks and folders.
+Use `--json` for machine-readable output.
+
+For cloud hosts whose users are real SSH/system accounts, set
+`HARBOR_CHECK_OS_AUTH=1` on the server. The login endpoint then verifies the
+same username/password against the server's SSH daemon (optionally using
+`HARBOR_CHECK_SSH_HOST`). This lets a laptop authenticate without copying the
+password into the application database.
+
+Plain HTTP exposes the login password and review data to anyone able to observe
+the network path. For public access, put Django behind HTTPS, or use an SSH
+tunnel from the laptop:
+
+```bash
+ssh -N -L 8000:127.0.0.1:8000 alice@101.46.8.169
+harbor-check login --server http://127.0.0.1:8000 --username alice
+```
+
+
+## Install and use from `101.46.8.169`
+
+On a laptop with network access to the server:
+
+```bash
+python -m pip install --upgrade harbor-check-cli
+harbor-check login --server http://101.46.8.169:8000 --username YOUR_SERVER_USERNAME
+harbor-check tasks
+harbor-check folders
+harbor-check folder-tasks YOUR_FOLDER_NAME
+```
+
+The token is stored in `~/.config/harbor-check/credentials.json` with 0600
+permissions. Use `--json` for scripts. If the server is exposed only through
+SSH, create a tunnel first:
+
+```bash
+ssh -N -L 8000:127.0.0.1:8000 YOUR_SERVER_USERNAME@101.46.8.169
+harbor-check login --server http://127.0.0.1:8000 --username YOUR_SERVER_USERNAME
+```
+
+The server must enable `HARBOR_CHECK_AUTH_REQUIRED=1` and configure either
+`HARBOR_CHECK_USERS_JSON` or `HARBOR_CHECK_OS_AUTH=1`.

harbor_check_cli-0.1.0/README.md

@@ -0,0 +1,65 @@
+# Harbor Check CLI
+
+Install with `python -m pip install ./saas/harbor-check-cli`.
+
+Login once; the token is stored with mode 0600 and reused by later commands:
+
+```bash
+harbor-check login --server 101.46.8.169 --username alice --password 'secret'
+harbor-check tasks
+```
+
+An address without a scheme is treated as `http://`; use `--server
+http://101.46.8.169:8000` when Harbor Check is listening on a non-default port.
+
+```bash
+harbor-check --server https://review.example.com tasks
+harbor-check --server https://review.example.com folders
+harbor-check --server https://review.example.com folder-tasks batch-name
+```
+
+The CLI authenticates with the server's `/api/auth/login` endpoint. Configure
+Django with `HARBOR_CHECK_AUTH_REQUIRED=1` and `HARBOR_CHECK_USERS_JSON`.
+Values may be plaintext for local development or `pbkdf2_sha256$rounds$salt$hex`
+hashes for deployment. Authenticated users can see all users' tasks and folders.
+Use `--json` for machine-readable output.
+
+For cloud hosts whose users are real SSH/system accounts, set
+`HARBOR_CHECK_OS_AUTH=1` on the server. The login endpoint then verifies the
+same username/password against the server's SSH daemon (optionally using
+`HARBOR_CHECK_SSH_HOST`). This lets a laptop authenticate without copying the
+password into the application database.
+
+Plain HTTP exposes the login password and review data to anyone able to observe
+the network path. For public access, put Django behind HTTPS, or use an SSH
+tunnel from the laptop:
+
+```bash
+ssh -N -L 8000:127.0.0.1:8000 alice@101.46.8.169
+harbor-check login --server http://127.0.0.1:8000 --username alice
+```
+
+
+## Install and use from `101.46.8.169`
+
+On a laptop with network access to the server:
+
+```bash
+python -m pip install --upgrade harbor-check-cli
+harbor-check login --server http://101.46.8.169:8000 --username YOUR_SERVER_USERNAME
+harbor-check tasks
+harbor-check folders
+harbor-check folder-tasks YOUR_FOLDER_NAME
+```
+
+The token is stored in `~/.config/harbor-check/credentials.json` with 0600
+permissions. Use `--json` for scripts. If the server is exposed only through
+SSH, create a tunnel first:
+
+```bash
+ssh -N -L 8000:127.0.0.1:8000 YOUR_SERVER_USERNAME@101.46.8.169
+harbor-check login --server http://127.0.0.1:8000 --username YOUR_SERVER_USERNAME
+```
+
+The server must enable `HARBOR_CHECK_AUTH_REQUIRED=1` and configure either
+`HARBOR_CHECK_USERS_JSON` or `HARBOR_CHECK_OS_AUTH=1`.

harbor_check_cli-0.1.0/harbor_check_cli/__init__.py

@@ -0,0 +1,5 @@
+"""Client library and command line interface for Harbor Check."""
+
+from .client import HarborCheckClient
+
+__all__ = ["HarborCheckClient"]

harbor_check_cli-0.1.0/harbor_check_cli/__main__.py

@@ -0,0 +1,40 @@
+import argparse, getpass, json, os, sys, asyncio
+from pathlib import Path
+import httpx
+CONFIG=Path(os.getenv('XDG_CONFIG_HOME', Path.home()/'.config'))/'harbor-check'/'credentials.json'
+
+class Client:
+    def __init__(self, base):
+        if '://' not in base: base='http://'+base
+        self.base=base.rstrip('/'); self.token=None
+    def login(self,u,p):
+        r=httpx.post(self.base+'/api/auth/login',json={'username':u,'password':p},timeout=20); r.raise_for_status(); self.token=r.json()['token']
+    def get(self,path):
+        r=httpx.get(self.base+path,headers={'Authorization':'Bearer '+self.token},timeout=30); r.raise_for_status(); return r.json()
+
+def main():
+    ap=argparse.ArgumentParser(prog='harbor-check'); ap.add_argument('--server',default=os.getenv('HARBOR_CHECK_SERVER','http://127.0.0.1:8000')); ap.add_argument('--local',action='store_true',help='read the server workspace directly (only when running on the review server)'); ap.add_argument('--username'); ap.add_argument('--password'); ap.add_argument('--json',action='store_true'); sub=ap.add_subparsers(dest='cmd',required=True); login=sub.add_parser('login'); login.add_argument('--server',dest='login_server'); login.add_argument('--username',dest='login_username'); login.add_argument('--password',dest='login_password'); sub.add_parser('tasks'); sub.add_parser('folders'); f=sub.add_parser('folder-tasks'); f.add_argument('folder')
+    a=ap.parse_args()
+    try:
+        if a.cmd=='login':
+            server=a.login_server or a.server; u=a.login_username or input('Username: '); p=a.login_password or getpass.getpass('Password: '); c=Client(server); c.login(u,p); CONFIG.parent.mkdir(parents=True,exist_ok=True); CONFIG.write_text(json.dumps({'server':server,'username':u,'token':c.token})); CONFIG.chmod(0o600); print(f'Logged in to {server} as {u}'); return 0
+        if a.local:
+            repo=Path(os.getenv('HARBOR_CHECK_REPO',Path.cwd())); sys.path.insert(0,str(repo/'saas/harbor-check')); from app import all_tasks; data=asyncio.run(all_tasks())
+        else:
+            saved=json.loads(CONFIG.read_text()) if CONFIG.exists() else {}; c=Client(saved.get('server') or a.server); c.token=saved.get('token');
+            if not c.token:
+                u=a.username or input('Username: '); p=a.password or getpass.getpass('Password: '); c.login(u,p)
+            data=c.get('/api/tasks')
+    except Exception as e: print(f'harbor-check: {e}',file=sys.stderr); return 2
+    if a.cmd=='folder-tasks': data=[x for x in data if x['dirname']==a.folder]
+    if a.json: print(json.dumps(data,indent=2)); return 0
+    if a.cmd=='tasks':
+        print('USER/FOLDER/TASK | STATE | RUNTIME | LAST ACTIVE | FAILS BY CATEGORY')
+        for g in data:
+            for t in g.get('tasks',[]): print(f"{g['username']}/{g['dirname']}/{t['task']} | {t.get('state','-')} | {t.get('elapsed_seconds','-')}s | {t.get('last_activity_at','-')} | {json.dumps((t.get('result') or {}).get('failed_by_category',{}),sort_keys=True)}")
+    else:
+        print('USER/FOLDER | TASKS | FAILS BY CATEGORY | FAIL RATE')
+        for g in data:
+            rep=g.get('report') or {}; groups=rep.get('groups') or {}; total=sum(v.get('total',0) for v in groups.values()); fails=sum(v.get('fail',0) for v in groups.values()); cats={k:v.get('fail',0) for k,v in groups.items()}; print(f"{g['username']}/{g['dirname']} | {len(g.get('tasks',[]))} | {json.dumps(cats,sort_keys=True)} | {fails}/{total} ({(fails/total*100 if total else 0):.1f}%)")
+    return 0
+if __name__=='__main__': raise SystemExit(main())

harbor_check_cli-0.1.0/harbor_check_cli/client.py

@@ -0,0 +1,26 @@
+from __future__ import annotations
+
+import httpx
+
+
+class HarborCheckClient:
+    """Small authenticated client for embedding Harbor Check in Python tools."""
+
+    def __init__(self, server: str, token: str | None = None):
+        if "://" not in server:
+            server = "http://" + server
+        self.server = server.rstrip("/")
+        self.token = token
+
+    def login(self, username: str, password: str) -> dict:
+        response = httpx.post(f"{self.server}/api/auth/login", json={"username": username, "password": password}, timeout=20)
+        response.raise_for_status()
+        payload = response.json()
+        self.token = payload["token"]
+        return payload
+
+    def tasks(self) -> list[dict]:
+        headers = {"Authorization": f"Bearer {self.token}"} if self.token else {}
+        response = httpx.get(f"{self.server}/api/tasks", headers=headers, timeout=30)
+        response.raise_for_status()
+        return response.json()

harbor_check_cli-0.1.0/harbor_check_cli.egg-info/PKG-INFO

@@ -0,0 +1,76 @@
+Metadata-Version: 2.4
+Name: harbor-check-cli
+Version: 0.1.0
+Summary: CLI for Harbor Check review status and rubric summaries
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: Environment :: Console
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: httpx>=0.27
+
+# Harbor Check CLI
+
+Install with `python -m pip install ./saas/harbor-check-cli`.
+
+Login once; the token is stored with mode 0600 and reused by later commands:
+
+```bash
+harbor-check login --server 101.46.8.169 --username alice --password 'secret'
+harbor-check tasks
+```
+
+An address without a scheme is treated as `http://`; use `--server
+http://101.46.8.169:8000` when Harbor Check is listening on a non-default port.
+
+```bash
+harbor-check --server https://review.example.com tasks
+harbor-check --server https://review.example.com folders
+harbor-check --server https://review.example.com folder-tasks batch-name
+```
+
+The CLI authenticates with the server's `/api/auth/login` endpoint. Configure
+Django with `HARBOR_CHECK_AUTH_REQUIRED=1` and `HARBOR_CHECK_USERS_JSON`.
+Values may be plaintext for local development or `pbkdf2_sha256$rounds$salt$hex`
+hashes for deployment. Authenticated users can see all users' tasks and folders.
+Use `--json` for machine-readable output.
+
+For cloud hosts whose users are real SSH/system accounts, set
+`HARBOR_CHECK_OS_AUTH=1` on the server. The login endpoint then verifies the
+same username/password against the server's SSH daemon (optionally using
+`HARBOR_CHECK_SSH_HOST`). This lets a laptop authenticate without copying the
+password into the application database.
+
+Plain HTTP exposes the login password and review data to anyone able to observe
+the network path. For public access, put Django behind HTTPS, or use an SSH
+tunnel from the laptop:
+
+```bash
+ssh -N -L 8000:127.0.0.1:8000 alice@101.46.8.169
+harbor-check login --server http://127.0.0.1:8000 --username alice
+```
+
+
+## Install and use from `101.46.8.169`
+
+On a laptop with network access to the server:
+
+```bash
+python -m pip install --upgrade harbor-check-cli
+harbor-check login --server http://101.46.8.169:8000 --username YOUR_SERVER_USERNAME
+harbor-check tasks
+harbor-check folders
+harbor-check folder-tasks YOUR_FOLDER_NAME
+```
+
+The token is stored in `~/.config/harbor-check/credentials.json` with 0600
+permissions. Use `--json` for scripts. If the server is exposed only through
+SSH, create a tunnel first:
+
+```bash
+ssh -N -L 8000:127.0.0.1:8000 YOUR_SERVER_USERNAME@101.46.8.169
+harbor-check login --server http://127.0.0.1:8000 --username YOUR_SERVER_USERNAME
+```
+
+The server must enable `HARBOR_CHECK_AUTH_REQUIRED=1` and configure either
+`HARBOR_CHECK_USERS_JSON` or `HARBOR_CHECK_OS_AUTH=1`.

harbor_check_cli-0.1.0/harbor_check_cli.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+README.md
+pyproject.toml
+harbor_check_cli/__init__.py
+harbor_check_cli/__main__.py
+harbor_check_cli/client.py
+harbor_check_cli.egg-info/PKG-INFO
+harbor_check_cli.egg-info/SOURCES.txt
+harbor_check_cli.egg-info/dependency_links.txt
+harbor_check_cli.egg-info/entry_points.txt
+harbor_check_cli.egg-info/requires.txt
+harbor_check_cli.egg-info/top_level.txt

harbor_check_cli-0.1.0/harbor_check_cli.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

harbor_check_cli-0.1.0/harbor_check_cli.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+harbor-check = harbor_check_cli.__main__:main

harbor_check_cli-0.1.0/harbor_check_cli.egg-info/requires.txt

@@ -0,0 +1 @@
+httpx>=0.27

harbor_check_cli-0.1.0/harbor_check_cli.egg-info/top_level.txt

@@ -0,0 +1 @@
+harbor_check_cli

harbor_check_cli-0.1.0/pyproject.toml

@@ -0,0 +1,14 @@
+[build-system]
+requires = ["setuptools>=68"]
+build-backend = "setuptools.build_meta"
+[project]
+name = "harbor-check-cli"
+version = "0.1.0"
+description = "CLI for Harbor Check review status and rubric summaries"
+requires-python = ">=3.10"
+readme = "README.md"
+license = {text = "MIT"}
+classifiers = ["Programming Language :: Python :: 3", "Environment :: Console"]
+dependencies = ["httpx>=0.27"]
+[project.scripts]
+harbor-check = "harbor_check_cli.__main__:main"

harbor_check_cli-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+