remoterf 0.1.0.3__py3-none-any.whl

remoteRF/remoterf_cli.py

@@ -0,0 +1,203 @@
+# src/remoteRF/cli.py
+from __future__ import annotations
+
+import argparse
+import sys
+from typing import Optional, Sequence
+
+import sys
+
+from pathlib import Path
+
+def _config_root() -> Path:
+    return Path.home() / ".config" / "remoterf"
+
+def _env_path() -> Path:
+    return _config_root() / ".env"
+
+def _read_dotenv_kv(path: Path) -> dict[str, str]:
+    """
+    Tiny dotenv reader (KEY=VALUE lines). Good enough for your use-case.
+    """
+    out: dict[str, str] = {}
+    if not path.exists():
+        return out
+
+    for raw in path.read_text(encoding="utf-8").splitlines():
+        line = raw.strip()
+        if not line or line.startswith("#") or "=" not in line:
+            continue
+        k, v = line.split("=", 1)
+        k = k.strip()
+        v = v.strip().strip('"').strip("'")
+        out[k] = v
+    return out
+
+def _ensure_config_present() -> tuple[bool, str]:
+    env_file = _env_path()
+    if not env_file.exists():
+        return (
+            False,
+            "RemoteRF is not configured.\n"
+            "Run:\n"
+            "  remoterf --config --addr <host:port>\n"
+            "Example:\n"
+            "  remoterf --config --addr 123.45.654.321:12321\n",
+        )
+
+    kv = _read_dotenv_kv(env_file)
+    addr = kv.get("REMOTERF_ADDR", "").strip()
+    ca = kv.get("REMOTERF_CA_CERT", "").strip()
+
+    if not addr or not ca:
+        return (
+            False,
+            "RemoteRF config is incomplete.\n"
+            f"Expected REMOTERF_ADDR and REMOTERF_CA_CERT in:\n  {env_file}\n"
+            "Fix by re-running:\n"
+            "  remoterf --config --addr <host:port>\n",
+        )
+
+    ca_path = Path(ca).expanduser()
+    if not ca_path.exists():
+        return (
+            False,
+            "RemoteRF config points to a missing CA certificate.\n"
+            f"REMOTERF_CA_CERT={ca}\n"
+            "Fix by re-running:\n"
+            "  remoterf --config --addr <host:port>\n",
+        )
+
+    return True, ""
+
+def print_help() -> None:
+    print(
+        "RemoteRF CLI Help\n"
+        "\n"
+        "Usage:\n"
+        "  remoterf                          Show this help\n"
+        "  remoterf -h | --help              Show this help\n"
+        "\n"
+        "  remoterf -l | --login             Login / register\n"
+        "  remoterf -v | --version           Print version\n"
+        "\n"
+        "  remoterf -c | --config [options]\n"
+        "    -a, --addr, -addr <host:port>   Set target server \n"
+        "    -w, --wipe, -wipe               Delete all local config\n"
+        "    -y, --yes, -yes                 Skip wipe confirmation\n"
+        "\n"
+        "Examples:\n"
+        "  remoterf --login\n"
+        "  remoterf --version\n"
+        "  remoterf --config --addr 123.45.654.321:12321\n"
+        "  remoterf --config --wipe\n"
+        "  remoterf --config --wipe --yes\n"
+    )
+
+def main() -> int:
+    argv = list(sys.argv[1:])
+
+    # ---- Debug ----
+    # print(f"argc={len(argv)}")
+    # for i, a in enumerate(argv):
+    #     print(f"argv[{i}] = {a!r}")
+
+    if len(argv) == 0 or argv[0] in ("--help", "-help", "-h"):
+        print_help()
+        return 0
+
+    if argv[0] in ("--login", "-login", "-l"):
+        ok, msg = _ensure_config_present()
+        if not ok:
+            print(msg)
+            return 2
+
+        from remoteRF.core.acc_login import main as _
+        return 0
+
+    if argv[0] in ("--version", "-version", "-v"):
+        from remoteRF.core.version import main as version_main
+        
+        print("RemoteRF version:", end=" ")
+        version_main()
+        return 0
+
+    if argv[0] in ("--config", "-config", "-c"):
+        from remoteRF.config.config import configure, wipe_config
+
+        addr = None
+        wipe = False
+        yes = False
+
+        i = 1
+        while i < len(argv):
+            tok = argv[i]
+
+            if tok in ("--addr", "-a", "-addr"):
+                if i + 1 >= len(argv):
+                    print("ERROR: missing required argument after --addr/-a/-addr")
+                    return 2
+                addr = argv[i + 1]
+                i += 2
+                continue
+
+            if tok in ("--wipe", "-w", "-wipe"):
+                wipe = True
+                i += 1
+                continue
+
+            if tok in ("--yes", "-y", "-yes"):
+                yes = True
+                i += 1
+                continue
+
+            print(f"ERROR: unknown config argument: {tok!r}")
+            return 2
+
+        # Mirror remoterf-config behavior:
+        if wipe and addr is not None:
+            print("ERROR: cannot use --wipe and --addr together")
+            return 2
+
+        if wipe:
+            # wipe_config returns the proper exit code
+            return int(wipe_config(yes=yes))
+
+        if addr is not None:
+            # parse host:port (minimal, strict)
+            s = addr.strip()
+            if "://" in s:
+                s = s.split("://", 1)[1]
+            if ":" not in s:
+                print("ERROR: addr must be in 'host:port' form")
+                return 2
+
+            host, port_str = s.rsplit(":", 1)
+            host = host.strip()
+            try:
+                port = int(port_str.strip())
+            except Exception:
+                print("ERROR: port must be an integer")
+                return 2
+
+            # configure returns the proper exit code
+            cert_port = port + 1
+            configure(host, port, cert_port)
+            return 0
+
+        # No args -> same behavior as remoterf-config missing addr (exit code 2)
+        print(
+            "\nError: missing required argument: host:port\n\n"
+            "Usage:\n"
+            "  remoterf --config --addr <host:port>\n"
+            "  remoterf -c -a <host:port>\n"
+            "  remoterf --config --wipe [--yes]\n\n"
+            "Example:\n"
+            "  remoterf --config --addr 123.45.678.901:12345\n"
+        )
+        return 2
+
+
+    # fallback
+    print(f"ERROR: unknown command: {argv[0]!r}")
+    return 2

remoterf-0.1.0.3.dist-info/METADATA

@@ -0,0 +1,158 @@
+Metadata-Version: 2.4
+Name: remoterf
+Version: 0.1.0.3
+Summary: A python API to remotely access signal centric hardware. Client-side only! Courtesy of Wireless Lab @ UCLA & Prof. Ian Roberts.
+Author: Ethan Ge
+Author-email: ethoGalaxy@gmail.com
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: grpcio==1.71.0
+Requires-Dist: protobuf<6.0.0,>=5.0.0
+Requires-Dist: numpy
+Requires-Dist: prompt_toolkit
+Requires-Dist: python-dotenv
+Requires-Dist: prompt-toolkit
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# Remote RF
+
+A python API to remotely access signal centric hardware. 
+
+Courtesy of Wireless Lab @ UCLA. - Ethan Ge
+
+## Prerequisites
+
+- **Python 3.10**: This package works in Python 3.10+. If you don’t have Python installed, you can download it from the [official Python website](https://www.python.org/downloads/).
+
+To check your current Python version, open a terminal and run:
+
+```bash
+python --version
+```
+
+- **UCLA VPN**: Please ensure that you are connected to the UCLA VPN. You can download and configure the VPN client from the following link: [UCLA VPN Client Download](https://www.it.ucla.edu/it-support-center/services/virtual-private-network-vpn-clients). If you’re not connected to the VPN, you will not have access to the lab servers.
+
+## Installation
+
+Use the package manager [pip](https://pip.pypa.io/en/stable/) to install remoteRF. It is recommended that you install this package within a [virtual environment](https://docs.python.org/3/library/venv.html).
+
+```bash
+python3 -m venv venv        # Create virtual environment
+source venv/bin/activate    # Activate virtual environment
+
+pip install remoterf        # Install remoteRF
+```
+
+If `pip install` doesn't work, you can clone the [source](https://github.com/WirelessLabAtUCLA/RemoteRF-Client) directly from github.
+
+<!-- 1. **Clone the repository:**
+```bash
+git clone https://github.com/WirelessLabAtUCLA/RemoteRF-Client
+cd repository-name
+```
+2. **Install the package using** `pip` **in editable mode:**
+```bash
+pip install -e .
+```
+This command installs the package in "editable" mode, allowing for modifications to the local code without reinstalling. For more details on installing packages from local directories, refer to Python Packaging: [Installing from Local Archives](https://packaging.python.org/en/latest/tutorials/installing-packages/#installing-packages-from-local-archives). -->
+<!-- 
+## Reservation
+
+Usage of the platform requires you to register a account and reserve a device in order to run scripts remotely. 
+
+### 1. **Start UCLA VPN**
+
+- Start the CISCO Secure client, login and connect to any of the options.
+
+### 2. **Register a account**:
+```bash
+remoterf-login  
+# Run in the terminal 
+# where the Python library is installed
+
+# Typically, this will be the terminal where you’ve activated the virtual environment if you’re using one
+```
+
+- Input `r` to register a account, or `l` to login to a existing one.
+
+```bash
+Welcome to Remote RF Account System.
+Please login or register to continue. (l/r):
+```
+
+- Once in, input `help` to see all avaliable commands.
+
+### 3. **Reserve Device**:
+```bash
+getdev  # To view all avaliable devices
+
+# Note the device ID. You will need this later to reserve said device
+```
+
+```bash
+getres  # To view times not avaliable
+
+# Optionally, you can also view all reservations, and determine a time slot you want a specific device reserved
+```
+```bash
+perms   # To view your permissions
+
+# Depending on your permission levels, you will be given different restrictions 
+```
+
+```bash
+resdev # To reserve a device
+
+# Input the number of days you want to view, and it will display available reservations in that time span.
+
+Reservation successful. Thy Token -> example_token
+
+# Take note of this token. You will need it to actually access the device.
+```
+
+## Remote Access
+
+With this token, you can now run scripts remotely. Please keep in mind that you MUST be connected to the UCLA VPN for this to work.
+Here is a explained sample script to get you going!
+
+#### Python Script:
+
+```python
+from remoteRF.drivers.adalm_pluto import *  # Imports device Pluto SDR remote drivers. Change depending on desired device.
+
+sdr = adi.Pluto(    # Device initialization.
+    token = 'example_token'     # Place the prior token here.
+)
+
+# You can now use this 'sdr' as you normally would with the default Pluto drivers.
+```
+
+If converting a existing `non-remoteRF` compatible script:
+
+```diff
+- import existing_device_drivers 
+
++ from remoteRF.drivers.device_drivers import *
+
+- device = device(init)
+
++ device = device(token = 'sample_token')
+```
+
+Nothing else needs changing! 
+
+## Closing
+
+This is fundamentally a experimental platform, and there will be many unknown bugs and issues. Some devices do not have universal support for all its functions at the moment, I am working on that aspect. 
+
+**So please submit feedback!** -->

remoterf-0.1.0.3.dist-info/RECORD

@@ -0,0 +1,28 @@
+remoteRF/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+remoteRF/remoterf_cli.py,sha256=Oi9uFM6h6xDIV3tbRa6jeKXwUfNo5EI3EsuFGmB8QlU,5924
+remoteRF/common/__init__.py,sha256=8naT0ZphJxv_6uz7RRGvqfNB-UEznkzipJSVPD5n6iM,40
+remoteRF/common/grpc/__init__.py,sha256=GYLHC7riDbjdx2cNOhWymt0GLZ4mtGhuzZAXVRfNynw,37
+remoteRF/common/grpc/grpc_pb2.py,sha256=iMdLw3xly_2WjirEmVaxf7I8iiUmk-3YRqqIiRdNkPs,4082
+remoteRF/common/grpc/grpc_pb2_grpc.py,sha256=NofKaB3t0nAm_uxDgA5WXhWcsRWqsyfuMEEdBrosVKk,3368
+remoteRF/common/utils/__init__.py,sha256=JTP8gH-340HZI4F8oagPW-kxRCoVUnQB-_acmgXPaK4,204
+remoteRF/common/utils/ansi_codes.py,sha256=knGLOJK-lyDjfQHL0Upq5UPTg6J_6WYldga-ZOaerSs,3052
+remoteRF/common/utils/api_token.py,sha256=CdgnAIcKqhkJB_XqrshgJVZzfQIO-xeR8hVMi5bYPSI,1260
+remoteRF/common/utils/list_string.py,sha256=qsch666vX2e3CZ2W5EdYi62dOk37k1v2yPpHHm47a7A,156
+remoteRF/common/utils/process_arg.py,sha256=J1REqgjm-1daqTBdVASgDd-16y-KneOJpCZXPEOklVk,2971
+remoteRF/config/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+remoteRF/config/cert_fetcher.py,sha256=6vOI_v3E36tnS0Lao2pM9t9vX-LuMabQuYBOB2I0wn4,3411
+remoteRF/config/config.py,sha256=Nf-2omCMsYrq2VYsrKpsa6YenK2lzwJPgBwginU_v5w,3744
+remoteRF/core/__init__.py,sha256=XQiCe8kyzM7XLxA883-uDndBmbr-NXo1uvtMJT2h6oA,73
+remoteRF/core/acc_login.py,sha256=UcY3rDLAwHoJ9lYXRfm26z_6yJX0JSoKv-u1mF6n0Gs,49
+remoteRF/core/app.py,sha256=fdGlgsy_l9eoe80gafs03wR3fiKE4oATuRtcPNaCrc8,27004
+remoteRF/core/grpc_acc.py,sha256=iU3earnmoRhMctL1LBxuwDqB9fppx1JH745EEfI2gB0,2862
+remoteRF/core/grpc_client.py,sha256=RqEKQs5GLZC4fiWTZwtdaFznUVAcQMWaVBAHyrPwO5s,9824
+remoteRF/core/version.py,sha256=iMcmRB5ZxCliJZgPU6utwCia5M9HJ-J8E-LpPmcEgS8,182
+remoteRF/drivers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+remoteRF/drivers/adalm_pluto/__init__.py,sha256=_IOOeQXR6paCP7Eciw2aeKBUNvZs-jeBTwW8QqUlFyU,33
+remoteRF/drivers/adalm_pluto/pluto_remote.py,sha256=6TTp6v6HCXnULHFh90GVbLDWk7RXY2oZo7iiCl8EZdI,7460
+remoterf-0.1.0.3.dist-info/METADATA,sha256=FMpjPaOEyhrbCQKnFPtCoeL2unS2mWqL67-QJhixoRE,5163
+remoterf-0.1.0.3.dist-info/WHEEL,sha256=qELbo2s1Yzl39ZmrAibXA2jjPLUYfnVhUNTlyF1rq0Y,92
+remoterf-0.1.0.3.dist-info/entry_points.txt,sha256=La_TjAqCfqdcVTVjB2WrsJNn5rfgcuIYroe2v-CMwRQ,56
+remoterf-0.1.0.3.dist-info/top_level.txt,sha256=XQJoVTmAOsHV9qtPSP_QSh0ma4jKxsDkxn4IjM_ZuZk,9
+remoterf-0.1.0.3.dist-info/RECORD,,

remoterf-0.1.0.3.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.10.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

remoterf-0.1.0.3.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+remoterf = remoteRF.remoterf_cli:main

remoterf-0.1.0.3.dist-info/top_level.txt

@@ -0,0 +1 @@
+remoteRF