remoteRF-server 0.1.58__tar.gz → 0.1.59__tar.gz

{remoterf_server-0.1.58 → remoterf_server-0.1.59}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: remoteRF-server
-Version: 0.1.58
+Version: 0.1.59
 Description-Content-Type: text/markdown
 Requires-Dist: grpcio
 Requires-Dist: protobuf
@@ -281,10 +281,66 @@ Note that all device and server config parameters need a 'restart' to take affec
 
 ## Server Runtime Configuration
 
-After running 'serverrf --serve', you will have another set of configurations, including managing users and accounts, creating user groups, making registration codes, etc. Below will be a overview of said commands.
+After running `serverrf --serve`, you’ll enter the **RemoteRF Server Shell**. This interactive shell is used for runtime administration: managing users, devices, reservations, user groups, and enrollment codes.
 
+> Tip: Legacy commands (e.g. `show a`, `rm db`) may still work if enabled, but the commands below are the canonical interface.
 
+---
+
+#### Server
+
+* `help` / `?` — Show help
+* `clear` — Clear the screen
+* `status` — Show server status (uptime / bind info)
+* `quit` / `exit` — Exit the server shell
+
+---
+
+#### Users
+
+* `users list` — List all accounts
+* `users manage` — Manage a specific user (permissions / deletion / reservations) *(interactive)*
+* `users purge` — Remove **all** users
+
+---
+
+#### Devices
+
+* `devices list` — List all devices
+
+---
+
+#### Reservations
+
+* `reservations list` — List all reservations
+* `reservations purge` — Remove **all** reservations
 
+---
+
+#### Groups
+
+* `groups list` — List user groups
+* `groups create` — Create a user group *(interactive)*
+* `groups edit` — Edit a user group *(interactive)*
+* `groups delete` — Delete a user group *(interactive)*
+
+---
+
+#### Enrollment Codes
+
+* `codes list` — List enrollment codes
+* `codes create` — Create enrollment codes *(interactive)*
+* `codes delete` — Delete an enrollment code *(interactive)*
+
+---
+
+#### Database
+
+* `db reset` — Remove all database entries
+
+---
+
+## 
 todo:
 <!-- Adding plutos via the CLI -->
 <!-- Testing functionality (disregarding Host pipeline) -->
@@ -295,6 +351,8 @@ Ability to remotely manage groups and codes as admin.
 
 HostRF integration -> Host directory, device routing, dynamic reservation pulling, with activity/status (online, offline, etc.) 
 
+Cleanup code comments.
+
 Update Ian with installation demo (try myself first on the NUC once!) for both server and host.
 
 

{remoterf_server-0.1.58 → remoterf_server-0.1.59}/README.md

@@ -270,10 +270,66 @@ Note that all device and server config parameters need a 'restart' to take affec
 
 ## Server Runtime Configuration
 
-After running 'serverrf --serve', you will have another set of configurations, including managing users and accounts, creating user groups, making registration codes, etc. Below will be a overview of said commands.
+After running `serverrf --serve`, you’ll enter the **RemoteRF Server Shell**. This interactive shell is used for runtime administration: managing users, devices, reservations, user groups, and enrollment codes.
 
+> Tip: Legacy commands (e.g. `show a`, `rm db`) may still work if enabled, but the commands below are the canonical interface.
 
+---
+
+#### Server
+
+* `help` / `?` — Show help
+* `clear` — Clear the screen
+* `status` — Show server status (uptime / bind info)
+* `quit` / `exit` — Exit the server shell
+
+---
+
+#### Users
+
+* `users list` — List all accounts
+* `users manage` — Manage a specific user (permissions / deletion / reservations) *(interactive)*
+* `users purge` — Remove **all** users
+
+---
+
+#### Devices
+
+* `devices list` — List all devices
+
+---
+
+#### Reservations
+
+* `reservations list` — List all reservations
+* `reservations purge` — Remove **all** reservations
 
+---
+
+#### Groups
+
+* `groups list` — List user groups
+* `groups create` — Create a user group *(interactive)*
+* `groups edit` — Edit a user group *(interactive)*
+* `groups delete` — Delete a user group *(interactive)*
+
+---
+
+#### Enrollment Codes
+
+* `codes list` — List enrollment codes
+* `codes create` — Create enrollment codes *(interactive)*
+* `codes delete` — Delete an enrollment code *(interactive)*
+
+---
+
+#### Database
+
+* `db reset` — Remove all database entries
+
+---
+
+## 
 todo:
 <!-- Adding plutos via the CLI -->
 <!-- Testing functionality (disregarding Host pipeline) -->
@@ -284,6 +340,8 @@ Ability to remotely manage groups and codes as admin.
 
 HostRF integration -> Host directory, device routing, dynamic reservation pulling, with activity/status (online, offline, etc.) 
 
+Cleanup code comments.
+
 Update Ian with installation demo (try myself first on the NUC once!) for both server and host.
 
 

{remoterf_server-0.1.58 → remoterf_server-0.1.59}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "remoteRF-server"
-version = "0.1.58"
+version = "0.1.59"
 dependencies = [
   "grpcio",
   "protobuf",

{remoterf_server-0.1.58 → remoterf_server-0.1.59}/src/remoteRF_server/server/grpc_server.py

@@ -28,7 +28,7 @@ from .rpc_manager import rpc_manager
 from .acc_perms import perms
 from ..common.utils import *
 from .device_manager import get_all_devices, get_all_devices_str
-from .user_group_cli import make_user_group_local, edit_user_group_local, list_user_groups_local, remove_user_group_local, make_enrollment_codes_local, remove_enrollment_code_local, list_enrollment_codes_local
+from .user_group_cli import make_user_group_local, edit_user_group_local, list_user_groups_local, remove_user_group_local, make_enrollment_codes_local, remove_enrollment_code_local, list_enrollment_codes_local, export_user_groups_csv_local, export_enrollment_codes_csv_local
 from .user_group_handler import user_group_handler, start_usergroup_cleanup_loop
 
 from pathlib import Path
@@ -479,12 +479,14 @@ def help() -> None:
     printf("  groups create            ", Sty.MAGENTA, "- Create a user group (interactive)", Sty.DEFAULT)
     printf("  groups edit              ", Sty.MAGENTA, "- Edit a user group (interactive)", Sty.DEFAULT)
     printf("  groups delete            ", Sty.MAGENTA, "- Delete a user group (interactive)", Sty.DEFAULT)
+    printf("'groups csv'    ", Sty.MAGENTA, " - Export ALL user groups as CSV to Downloads", Sty.DEFAULT)
     print()
 
     printf("Enrollment Codes:", Sty.BOLD)
     printf("  codes list               ", Sty.MAGENTA, "- List enrollment codes", Sty.DEFAULT)
     printf("  codes create             ", Sty.MAGENTA, "- Create enrollment codes (interactive)", Sty.DEFAULT)
     printf("  codes delete             ", Sty.MAGENTA, "- Delete an enrollment code (interactive)", Sty.DEFAULT)
+    printf("'codes csv'     ", Sty.MAGENTA, " - Export ALL enrollment codes as CSV to Downloads", Sty.DEFAULT)
     print()
 
     printf("Database:", Sty.BOLD)
@@ -563,6 +565,7 @@ def server_input(inpu: str) -> bool:
         "groups list": lambda: _stay(lambda: list_user_groups_local(session)),
         "show g": lambda: _stay(lambda: list_user_groups_local(session)),      # old
         "show groups": lambda: _stay(lambda: list_user_groups_local(session)), # old
+        "groups csv": lambda: _stay(export_user_groups_csv_local),
 
         # ---- enrollment codes ----
         "codes create": lambda: _stay(lambda: make_enrollment_codes_local(session)),
@@ -577,6 +580,8 @@ def server_input(inpu: str) -> bool:
         "rm codes": lambda: _stay(lambda: remove_enrollment_code_local(session)), # old
         "rm code": lambda: _stay(lambda: remove_enrollment_code_local(session)),  # old
         "rm c": lambda: _stay(lambda: remove_enrollment_code_local(session)),     # old
+        
+        "codes csv": lambda: _stay(export_enrollment_codes_csv_local),
     }
 
     fn = DISPATCH.get(cmd)

{remoterf_server-0.1.58 → remoterf_server-0.1.59}/src/remoteRF_server/server/user_group_cli.py

@@ -586,4 +586,143 @@ def list_enrollment_codes_local(session) -> None:
     print(header)
     print(sep)
     for row in table:
-        print("  ".join(row[i].ljust(widths[cols[i]]) for i in range(len(cols))))
+        print("  ".join(row[i].ljust(widths[cols[i]]) for i in range(len(cols))))
+        
+from __future__ import annotations
+
+import csv
+import json
+import os
+import re
+from datetime import datetime
+from pathlib import Path
+from typing import Any, Dict, List, Optional
+
+from .user_group_handler import user_group_handler
+
+
+def _resolve_download_dir() -> Path:
+    """
+    Best-effort Downloads folder resolution:
+      1) XDG_DOWNLOAD_DIR env (if set)
+      2) ~/.config/user-dirs.dirs XDG_DOWNLOAD_DIR (Linux desktops)
+      3) ~/Downloads
+      4) fallback: cwd
+    """
+    # 1) Env override (rare, but cheap to support)
+    xdg_env = os.getenv("XDG_DOWNLOAD_DIR")
+    if xdg_env:
+        p = Path(os.path.expandvars(xdg_env)).expanduser()
+        return p
+
+    # 2) user-dirs.dirs (common on Linux w/ xdg-user-dirs)
+    try:
+        user_dirs = Path.home() / ".config" / "user-dirs.dirs"
+        if user_dirs.exists():
+            txt = user_dirs.read_text(encoding="utf-8", errors="ignore")
+            m = re.search(r'^XDG_DOWNLOAD_DIR\s*=\s*"(.*)"\s*$', txt, flags=re.MULTILINE)
+            if m:
+                raw = m.group(1)
+                raw = raw.replace("$HOME", str(Path.home()))
+                p = Path(os.path.expandvars(raw)).expanduser()
+                return p
+    except Exception:
+        pass
+
+    # 3) Default
+    p = Path.home() / "Downloads"
+    return p
+
+
+def _coerce_csv_cell(v: Any) -> str:
+    if v is None:
+        return ""
+    if isinstance(v, (dict, list, tuple)):
+        # stable, readable cell content
+        return json.dumps(v, ensure_ascii=False, separators=(",", ":"))
+    return str(v)
+
+
+def _write_csv(
+    rows: List[Dict[str, Any]],
+    out_path: Path,
+    *,
+    preferred_columns: Optional[List[str]] = None,
+) -> None:
+    if not rows:
+        raise ValueError("No rows to write.")
+
+    preferred_columns = preferred_columns or []
+
+    present = set().union(*(r.keys() for r in rows))
+    columns = [c for c in preferred_columns if c in present]
+    columns += [c for c in sorted(present) if c not in columns]
+
+    out_path.parent.mkdir(parents=True, exist_ok=True)
+
+    with out_path.open("w", newline="", encoding="utf-8") as f:
+        w = csv.DictWriter(f, fieldnames=columns, extrasaction="ignore")
+        w.writeheader()
+        for r in rows:
+            w.writerow({c: _coerce_csv_cell(r.get(c)) for c in columns})
+
+
+def export_user_groups_csv_local() -> Optional[Path]:
+    # include_users=True so CSV truly contains "everything"
+    groups: List[Dict[str, Any]] = user_group_handler.get_all_user_groups(include_users=True) or []
+    if not groups:
+        print("No user groups found.")
+        return None
+
+    ts = datetime.now().strftime("%Y%m%d_%H%M%S")
+    out_dir = _resolve_download_dir()
+    out_path = out_dir / f"remoterf_user_groups_{ts}.csv"
+
+    preferred = [
+        "group_id", "id",
+        "group_name", "name",
+        "devices_whitelist",
+        "max_reservation_time_sec",
+        "max_reservations",
+        "lifetime_sec",
+        "created_at",
+        "users",
+    ]
+
+    try:
+        _write_csv(groups, out_path, preferred_columns=preferred)
+        print(f"Exported user groups CSV -> {out_path}")
+        return out_path
+    except Exception as e:
+        print(f"Failed to export user groups CSV: {e}")
+        return None
+
+
+def export_enrollment_codes_csv_local() -> Optional[Path]:
+    rows: List[Dict[str, Any]] = user_group_handler.get_all_enrollment_codes() or []
+    if not rows:
+        print("No enrollment codes found.")
+        return None
+
+    ts = datetime.now().strftime("%Y%m%d_%H%M%S")
+    out_dir = _resolve_download_dir()
+    out_path = out_dir / f"remoterf_enrollment_codes_{ts}.csv"
+
+    preferred = [
+        "code_name",
+        "group_id",
+        "uses",
+        "uses_left",
+        "remaining_uses",
+        "duration_sec",
+        "expires_at",
+        "created_at",
+    ]
+
+    try:
+        _write_csv(rows, out_path, preferred_columns=preferred)
+        print(f"Exported enrollment codes CSV -> {out_path}")
+        return out_path
+    except Exception as e:
+        print(f"Failed to export enrollment codes CSV: {e}")
+        return None

{remoterf_server-0.1.58 → remoterf_server-0.1.59}/src/remoteRF_server.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: remoteRF-server
-Version: 0.1.58
+Version: 0.1.59
 Description-Content-Type: text/markdown
 Requires-Dist: grpcio
 Requires-Dist: protobuf
@@ -281,10 +281,66 @@ Note that all device and server config parameters need a 'restart' to take affec
 
 ## Server Runtime Configuration
 
-After running 'serverrf --serve', you will have another set of configurations, including managing users and accounts, creating user groups, making registration codes, etc. Below will be a overview of said commands.
+After running `serverrf --serve`, you’ll enter the **RemoteRF Server Shell**. This interactive shell is used for runtime administration: managing users, devices, reservations, user groups, and enrollment codes.
 
+> Tip: Legacy commands (e.g. `show a`, `rm db`) may still work if enabled, but the commands below are the canonical interface.
 
+---
+
+#### Server
+
+* `help` / `?` — Show help
+* `clear` — Clear the screen
+* `status` — Show server status (uptime / bind info)
+* `quit` / `exit` — Exit the server shell
+
+---
+
+#### Users
+
+* `users list` — List all accounts
+* `users manage` — Manage a specific user (permissions / deletion / reservations) *(interactive)*
+* `users purge` — Remove **all** users
+
+---
+
+#### Devices
+
+* `devices list` — List all devices
+
+---
+
+#### Reservations
+
+* `reservations list` — List all reservations
+* `reservations purge` — Remove **all** reservations
 
+---
+
+#### Groups
+
+* `groups list` — List user groups
+* `groups create` — Create a user group *(interactive)*
+* `groups edit` — Edit a user group *(interactive)*
+* `groups delete` — Delete a user group *(interactive)*
+
+---
+
+#### Enrollment Codes
+
+* `codes list` — List enrollment codes
+* `codes create` — Create enrollment codes *(interactive)*
+* `codes delete` — Delete an enrollment code *(interactive)*
+
+---
+
+#### Database
+
+* `db reset` — Remove all database entries
+
+---
+
+## 
 todo:
 <!-- Adding plutos via the CLI -->
 <!-- Testing functionality (disregarding Host pipeline) -->
@@ -295,6 +351,8 @@ Ability to remotely manage groups and codes as admin.
 
 HostRF integration -> Host directory, device routing, dynamic reservation pulling, with activity/status (online, offline, etc.) 
 
+Cleanup code comments.
+
 Update Ian with installation demo (try myself first on the NUC once!) for both server and host.