remoteRF-server 0.1.0__tar.gz

remoterf_server-0.1.0/PKG-INFO

@@ -0,0 +1,9 @@
+Metadata-Version: 2.4
+Name: remoteRF-server
+Version: 0.1.0
+Requires-Dist: grpcio
+Requires-Dist: protobuf
+Requires-Dist: numpy
+Requires-Dist: prompt_toolkit
+Requires-Dist: python-dotenv
+Requires-Dist: grpcio-tools

remoterf_server-0.1.0/README.md

@@ -0,0 +1,171 @@
+# Remote RF Linux Server
+
+A python codebase to host the remoteRF Platform. 
+
+Courtesy of Wireless Lab @ UCLA. - Ethan Ge
+
+## Prerequisites
+
+- **Local Linux Computer**: You will need a linux based machine to run the server, along with the networking that goes along with it.
+
+- **Python 3.12**: Honestly I am not sure what minimum version is required. But 3.12 for sure works. 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
+```
+
+- **Adalm Pluto Python Drivers**: You will need to install this if you wish to use the adalm pluto SDR. [Adalm Pluto Python Drivers](https://pysdr.org/content/pluto.html).
+
+- **Other Devices**: At the moment, although a couple other devices are loosely supported, the Pluto is the only 'full support' device. More can be easily added though.
+
+## Installation
+
+### **Note**: 
+These instructions are confirmed to be working on Fedora LTS Server build. Although nothing should need changing on different distros, I cannot confirm nor deny that.
+
+### **Clone Repo**: 
+First clone the server repo [here](https://github.com/WirelessLabAtUCLA/RemoteRF-Server).
+
+### **Python Dependencies**: 
+Navigate to the cloned repo. Run the below commands. Mind that a python virtual environment `VENV` is recommended, although given device drivers, it may not be the easiest.
+
+```bash
+    python3 -m venv venv        # Create venv folder
+    source venv/bin/activate    # Activate venv
+
+    pip install setuptools -e . # Auto installs dependencies
+
+    RRRFserver                  # Run Remote RF Server
+```
+If you have errors, such as `ModuleNotFoundError: No module named 'adi'`, yet you are able to use the adi package elsewhere, such as in the global interpreter, you will need to update your python path to include the adi package, which you should've installed earlier from [here](https://pysdr.org/content/pluto.html).
+
+If you are too lazy to do so, you can just repeat the same steps but on the global python interpreter, which should solve the issue, albeit a less clean solution.
+
+## Configuration
+
+Now onto the configuration of the server for use. Server script needs to be restarted for config to take place.
+
+### Network parameters:
+The server requires a specified port as well as a manual IP to be set. You can do an online search for "how to input manual IP address for OS TYPE".
+
+Navigate to `src/remoteRF_server/certs` directory.
+```bash
+    cd src/remoteRF_server/certs    # From repo root
+
+    openssl req -newkey rsa:2048 -nodes -keyout server.key -x509 -days 365 -out server.crt -subj "/CN=XXX.XX.XXX.XXX" -addext "subjectAltName=IP:XXX.XX.XXX.XXX"    # Generate the certs. Replace XXX.XX.XXX.XXX with the server IP.
+```
+Navigate to `src/remoteRF_server/server/.env.server`.
+```bash
+    GRPC_PORT='XXXXX'   # Replace XXXXX with the server port.
+```
+Copy the internals of `/certs`, and replace the remoteRF-Client cert folder with these new certificates. This is done as **BOTH** the client and server need to have access to the same generated certificates for secure HTTPs transfer.
+
+### Device parameters:
+
+Navigate to `src/remoteRF_server/server/device_manager.py`. Scroll down until you see:
+```python
+    devices = { # device, salt, hash
+        0: (connect_pluto(usb='1.6.5'), '', ''),
+        1: (connect_pluto(usb='1.7.5'), '', ''),
+        # ...
+    }
+```
+To add more devices, simply duplicate the item and increment the device id. You also need to configure the usb port. To find this value, run this in the terminal once you have connected your desired devices.
+```bash
+    iio_info -s # displays usb port info
+```
+```bash
+    Available contexts:
+    	0: (jc42,coretemp,pch_skylake,nouveau,acpitz,jc42,dell_smm,hidpp_battery_0,nvme on Dell Inc.) [local:]
+    	1: 0456:b673 (Analog Devices Inc. PlutoSDR (ADALM-PLUTO)), serial=10447392da110010f9ff1500612ff8ecb0 [usb:1.6.5]    
+        # Use this `usb:1.6.5` as the input for the device init
+```
+Under `devices` there is also `device_info`. Update this accordingly. This is what is displayed when users request to see what devices there are.
+
+Remember to update default permissions and the like! Otherwise users won't be able to add the new devices.
+
+### Permission parameters:
+
+In the repo, navigate to `src/remoteRF_server/server/acc_perms.py`. You should see:
+```python
+    class userperms:
+        def __init__(self): # default user perms settings
+            self.id = 'user'
+            self.max_reservations = 1
+            self.max_reservation_time_sec = 3600
+            self.devices_allowed = [0, 1]   # device ID
+```
+Here, you can set the default user perms. This default is given to all 'normal users', and is also the permission level when users first make their accounts. For the other two tiers of users, they are configured on run time when the server is running. The server saves all run time changes so no data hypothetically can be lost.
+
+### .Proto regen:
+Only needed if, well, you need to update the base networking.
+```bash
+pip install --upgrade grpcio grpcio-tools protobuf
+
+cd src/remoteRF_server/common/grpc
+python -m grpc_tools.protoc \
+      -I=. \
+      --python_out=. \
+      --grpc_python_out=. \
+      grpc.proto
+```
+
+## Time to Serve!
+
+Once your basic config is setup, you can begin testing the basics of the server! 
+
+```bash
+    RRRFserver  # Start the server
+```
+
+Given my weird setup, this is what I did to make it work:
+New Terminal
+cd Documents/GitHub/RemoteRF-Server
+sudo pip install -e . (don't use pip3)
+sudo RRRFserver
+
+IF the changes you make don't seem to apply ...
+which RRRFserver
+What worked for me (if u accidently use pip3)
+sudo python3 -m pip uninstall RemoteRF-Server (destroy pip3)
+
+Bruh ....
+
+python3 -m pip uninstall -y remoteRF_server RRRFserver || true
+rm -f ~/.local/bin/RRRFserver
+hash -r
+
+python3 -m pip install -e . --user --force-reinstall
+hash -r
+
+Type `help` to see the list of commands. They are pretty self explanatory. Run them and try it out! You can use arrow keys to cycle commands.
+
+```bash
+'exit' - Stop server.
+'help' - Help.
+'clear' - Clear terminal screen.
+'printa' - Print all accounts
+'printd' - Print all devices
+'printp' - Print all perms
+'printr' - Print all reservations
+'rm aa' - Remove all accounts
+'rm a' - Remove one account
+```
+
+Follow the [README](https://github.com/WirelessLabAtUCLA/RemoteRF-Client/blob/main/README.md) on this repo to configure the client side.
+
+I would suggest first trying to connect locally (on the same machine), and then remotely. You do not need the VPN if you are testing locally or on LAN. If all goes well, the server should be now ready for use! 
+
+**WARNING**: The current system distributes the private certificates. It is safe as UCLA wraps the network in a VPN, however if you open the server to all of the internet, this approach can be very dangerous.
+
+## Troubleshooting
+I had a variety of issues setting up the server. Here is a list of steps to take if the server refuses to connect:
+
+### Server Certificates:
+Confirm that the server certs were generated with the right IPs, and that the existing server certs weren't expired. If you are not sure how to check them, just regenerate them. Remember that if you do regenerate you will need to give the client a exact copy of those certs as well.
+
+### Local Firewall: 
+Some distros come with default firewall settings that block traffic on specific ports. Make sure that your firewall settings permit traffic to and from the server.
+
+- **ISP Firewall**: If doing this on UCLA Campus, they block and manage much of the traffic. You will need to submit a [Firewall Access Form](https://www.seasnet.ucla.edu/firewall-access-request/).

remoterf_server-0.1.0/pyproject.toml

@@ -0,0 +1,27 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "remoteRF-server"
+version = "0.1.0"
+dependencies = [
+  "grpcio",
+  "protobuf",
+  "numpy",
+  "prompt_toolkit",
+  "python-dotenv",
+  "grpcio-tools",
+]
+
+[project.scripts]
+RRRFserver = "remoteRF_server.server.grpc_server:main"
+RRRFcerts  = "remoteRF_server.tools.cert_gen:main"
+
+# RRRFcerts --ip XXX.XX.XXX.XXX --ca-days 7300 --days 3650 --force
+
+[tool.setuptools]
+package-dir = { "" = "src" }
+
+[tool.setuptools.packages.find]
+where = ["src"]

remoterf_server-0.1.0/setup.cfg

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

remoterf_server-0.1.0/src/remoteRF_server/common/grpc/__init__.py

@@ -0,0 +1 @@
+from . import grpc_pb2, grpc_pb2_grpc

remoterf_server-0.1.0/src/remoteRF_server/common/grpc/grpc_host_pb2.py

@@ -0,0 +1,53 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# NO CHECKED-IN PROTOBUF GENCODE
+# source: grpc_host.proto
+# Protobuf Python Version: 6.31.1
+"""Generated protocol buffer code."""
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
+from google.protobuf import runtime_version as _runtime_version
+from google.protobuf import symbol_database as _symbol_database
+from google.protobuf.internal import builder as _builder
+_runtime_version.ValidateProtobufRuntimeVersion(
+    _runtime_version.Domain.PUBLIC,
+    6,
+    31,
+    1,
+    '',
+    'grpc_host.proto'
+)
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+import grpc_pb2 as grpc__pb2
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x0fgrpc_host.proto\x12\x08remoterf\x1a\ngrpc.proto\"-\n\tHostHello\x12\x0f\n\x07host_id\x18\x01 \x01(\t\x12\x0f\n\x07version\x18\x02 \x01(\t\"^\n\nDeviceInfo\x12\x10\n\x08local_id\x18\x01 \x01(\r\x12\r\n\x05label\x18\x02 \x01(\t\x12\x11\n\tdevice_id\x18\x03 \x01(\t\x12\x0e\n\x06serial\x18\x04 \x01(\t\x12\x0c\n\x04kind\x18\x05 \x01(\t\"_\n\x0e\x44\x65viceAnnounce\x12%\n\x07\x64\x65vices\x18\x01 \x03(\x0b\x32\x14.remoterf.DeviceInfo\x12\x0f\n\x07unix_ms\x18\x02 \x01(\x04\x12\x15\n\rfull_snapshot\x18\x03 \x01(\x08\"\xab\x01\n\nRpcRequest\x12\x0e\n\x06req_id\x18\x01 \x01(\t\x12\x18\n\x10global_device_id\x18\x02 \x01(\r\x12\x17\n\x0flocal_device_id\x18\x03 \x01(\r\x12\x11\n\tdevice_id\x18\x04 \x01(\t\x12-\n\x07request\x18\x05 \x01(\x0b\x32\x1c.remote_rf.GenericRPCRequest\x12\x18\n\x10\x64\x65\x61\x64line_unix_ms\x18\x06 \x01(\x04\"i\n\x0bRpcResponse\x12\x0e\n\x06req_id\x18\x01 \x01(\t\x12\n\n\x02ok\x18\x02 \x01(\x08\x12/\n\x08response\x18\x03 \x01(\x0b\x32\x1d.remote_rf.GenericRPCResponse\x12\r\n\x05\x65rror\x18\x04 \x01(\t\"\x1c\n\tHeartbeat\x12\x0f\n\x07unix_ms\x18\x01 \x01(\x04\"\x18\n\x06\x43\x61ncel\x12\x0e\n\x06req_id\x18\x01 \x01(\t\"\x97\x02\n\tHostFrame\x12$\n\x05hello\x18\x01 \x01(\x0b\x32\x13.remoterf.HostHelloH\x00\x12\x33\n\x0f\x64\x65vice_announce\x18\x02 \x01(\x0b\x32\x18.remoterf.DeviceAnnounceH\x00\x12+\n\x0brpc_request\x18\x03 \x01(\x0b\x32\x14.remoterf.RpcRequestH\x00\x12-\n\x0crpc_response\x18\x04 \x01(\x0b\x32\x15.remoterf.RpcResponseH\x00\x12(\n\theartbeat\x18\x05 \x01(\x0b\x32\x13.remoterf.HeartbeatH\x00\x12\"\n\x06\x63\x61ncel\x18\x06 \x01(\x0b\x32\x10.remoterf.CancelH\x00\x42\x05\n\x03msg2E\n\nHostTunnel\x12\x37\n\x07\x43onnect\x12\x13.remoterf.HostFrame\x1a\x13.remoterf.HostFrame(\x01\x30\x01\x62\x06proto3')
+
+_globals = globals()
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'grpc_host_pb2', _globals)
+if not _descriptor._USE_C_DESCRIPTORS:
+  DESCRIPTOR._loaded_options = None
+  _globals['_HOSTHELLO']._serialized_start=41
+  _globals['_HOSTHELLO']._serialized_end=86
+  _globals['_DEVICEINFO']._serialized_start=88
+  _globals['_DEVICEINFO']._serialized_end=182
+  _globals['_DEVICEANNOUNCE']._serialized_start=184
+  _globals['_DEVICEANNOUNCE']._serialized_end=279
+  _globals['_RPCREQUEST']._serialized_start=282
+  _globals['_RPCREQUEST']._serialized_end=453
+  _globals['_RPCRESPONSE']._serialized_start=455
+  _globals['_RPCRESPONSE']._serialized_end=560
+  _globals['_HEARTBEAT']._serialized_start=562
+  _globals['_HEARTBEAT']._serialized_end=590
+  _globals['_CANCEL']._serialized_start=592
+  _globals['_CANCEL']._serialized_end=616
+  _globals['_HOSTFRAME']._serialized_start=619
+  _globals['_HOSTFRAME']._serialized_end=898
+  _globals['_HOSTTUNNEL']._serialized_start=900
+  _globals['_HOSTTUNNEL']._serialized_end=969
+# @@protoc_insertion_point(module_scope)

remoterf_server-0.1.0/src/remoteRF_server/common/grpc/grpc_host_pb2_grpc.py

@@ -0,0 +1,97 @@
+# Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT!
+"""Client and server classes corresponding to protobuf-defined services."""
+import grpc
+import warnings
+
+import grpc_host_pb2 as grpc__host__pb2
+
+GRPC_GENERATED_VERSION = '1.78.0'
+GRPC_VERSION = grpc.__version__
+_version_not_supported = False
+
+try:
+    from grpc._utilities import first_version_is_lower
+    _version_not_supported = first_version_is_lower(GRPC_VERSION, GRPC_GENERATED_VERSION)
+except ImportError:
+    _version_not_supported = True
+
+if _version_not_supported:
+    raise RuntimeError(
+        f'The grpc package installed is at version {GRPC_VERSION},'
+        + ' but the generated code in grpc_host_pb2_grpc.py depends on'
+        + f' grpcio>={GRPC_GENERATED_VERSION}.'
+        + f' Please upgrade your grpc module to grpcio>={GRPC_GENERATED_VERSION}'
+        + f' or downgrade your generated code using grpcio-tools<={GRPC_VERSION}.'
+    )
+
+
+class HostTunnelStub(object):
+    """Missing associated documentation comment in .proto file."""
+
+    def __init__(self, channel):
+        """Constructor.
+
+        Args:
+            channel: A grpc.Channel.
+        """
+        self.Connect = channel.stream_stream(
+                '/remoterf.HostTunnel/Connect',
+                request_serializer=grpc__host__pb2.HostFrame.SerializeToString,
+                response_deserializer=grpc__host__pb2.HostFrame.FromString,
+                _registered_method=True)
+
+
+class HostTunnelServicer(object):
+    """Missing associated documentation comment in .proto file."""
+
+    def Connect(self, request_iterator, context):
+        """Missing associated documentation comment in .proto file."""
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+
+def add_HostTunnelServicer_to_server(servicer, server):
+    rpc_method_handlers = {
+            'Connect': grpc.stream_stream_rpc_method_handler(
+                    servicer.Connect,
+                    request_deserializer=grpc__host__pb2.HostFrame.FromString,
+                    response_serializer=grpc__host__pb2.HostFrame.SerializeToString,
+            ),
+    }
+    generic_handler = grpc.method_handlers_generic_handler(
+            'remoterf.HostTunnel', rpc_method_handlers)
+    server.add_generic_rpc_handlers((generic_handler,))
+    server.add_registered_method_handlers('remoterf.HostTunnel', rpc_method_handlers)
+
+
+ # This class is part of an EXPERIMENTAL API.
+class HostTunnel(object):
+    """Missing associated documentation comment in .proto file."""
+
+    @staticmethod
+    def Connect(request_iterator,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.stream_stream(
+            request_iterator,
+            target,
+            '/remoterf.HostTunnel/Connect',
+            grpc__host__pb2.HostFrame.SerializeToString,
+            grpc__host__pb2.HostFrame.FromString,
+            options,
+            channel_credentials,
+            insecure,
+            call_credentials,
+            compression,
+            wait_for_ready,
+            timeout,
+            metadata,
+            _registered_method=True)

remoterf_server-0.1.0/src/remoteRF_server/common/grpc/grpc_pb2.py

@@ -0,0 +1,59 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# NO CHECKED-IN PROTOBUF GENCODE
+# source: grpc.proto
+# Protobuf Python Version: 5.29.0
+"""Generated protocol buffer code."""
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
+from google.protobuf import runtime_version as _runtime_version
+from google.protobuf import symbol_database as _symbol_database
+from google.protobuf.internal import builder as _builder
+_runtime_version.ValidateProtobufRuntimeVersion(
+    _runtime_version.Domain.PUBLIC,
+    5,
+    29,
+    0,
+    '',
+    'grpc.proto'
+)
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\ngrpc.proto\x12\tremote_rf\"\xa2\x01\n\x11GenericRPCRequest\x12\x15\n\rfunction_name\x18\x01 \x01(\t\x12\x34\n\x04\x61rgs\x18\x02 \x03(\x0b\x32&.remote_rf.GenericRPCRequest.ArgsEntry\x1a@\n\tArgsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\"\n\x05value\x18\x02 \x01(\x0b\x32\x13.remote_rf.Argument:\x02\x38\x01\"\x96\x01\n\x12GenericRPCResponse\x12;\n\x07results\x18\x01 \x03(\x0b\x32*.remote_rf.GenericRPCResponse.ResultsEntry\x1a\x43\n\x0cResultsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\"\n\x05value\x18\x02 \x01(\x0b\x32\x13.remote_rf.Argument:\x02\x38\x01\"\x19\n\nArrayShape\x12\x0b\n\x03\x64im\x18\x01 \x03(\x05\"+\n\rComplexNumber\x12\x0c\n\x04real\x18\x01 \x01(\x02\x12\x0c\n\x04imag\x18\x02 \x01(\x02\"a\n\x11\x43omplexNumpyArray\x12$\n\x05shape\x18\x01 \x01(\x0b\x32\x15.remote_rf.ArrayShape\x12&\n\x04\x64\x61ta\x18\x02 \x03(\x0b\x32\x18.remote_rf.ComplexNumber\"D\n\x0eRealNumpyArray\x12$\n\x05shape\x18\x01 \x01(\x0b\x32\x15.remote_rf.ArrayShape\x12\x0c\n\x04\x64\x61ta\x18\x02 \x03(\x02\"\xd7\x01\n\x08\x41rgument\x12\x16\n\x0cstring_value\x18\x01 \x01(\tH\x00\x12\x15\n\x0bint64_value\x18\x02 \x01(\x03H\x00\x12\x15\n\x0b\x66loat_value\x18\x03 \x01(\x02H\x00\x12\x14\n\nbool_value\x18\x04 \x01(\x08H\x00\x12\x35\n\rcomplex_array\x18\x05 \x01(\x0b\x32\x1c.remote_rf.ComplexNumpyArrayH\x00\x12/\n\nreal_array\x18\x06 \x01(\x0b\x32\x19.remote_rf.RealNumpyArrayH\x00\x42\x07\n\x05value2Q\n\nGenericRPC\x12\x43\n\x04\x43\x61ll\x12\x1c.remote_rf.GenericRPCRequest\x1a\x1d.remote_rf.GenericRPCResponseB\x1e\n\x10\x63om.example.demoB\nDemoProtosb\x06proto3')
+
+_globals = globals()
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'grpc_pb2', _globals)
+if not _descriptor._USE_C_DESCRIPTORS:
+  _globals['DESCRIPTOR']._loaded_options = None
+  _globals['DESCRIPTOR']._serialized_options = b'\n\020com.example.demoB\nDemoProtos'
+  _globals['_GENERICRPCREQUEST_ARGSENTRY']._loaded_options = None
+  _globals['_GENERICRPCREQUEST_ARGSENTRY']._serialized_options = b'8\001'
+  _globals['_GENERICRPCRESPONSE_RESULTSENTRY']._loaded_options = None
+  _globals['_GENERICRPCRESPONSE_RESULTSENTRY']._serialized_options = b'8\001'
+  _globals['_GENERICRPCREQUEST']._serialized_start=26
+  _globals['_GENERICRPCREQUEST']._serialized_end=188
+  _globals['_GENERICRPCREQUEST_ARGSENTRY']._serialized_start=124
+  _globals['_GENERICRPCREQUEST_ARGSENTRY']._serialized_end=188
+  _globals['_GENERICRPCRESPONSE']._serialized_start=191
+  _globals['_GENERICRPCRESPONSE']._serialized_end=341
+  _globals['_GENERICRPCRESPONSE_RESULTSENTRY']._serialized_start=274
+  _globals['_GENERICRPCRESPONSE_RESULTSENTRY']._serialized_end=341
+  _globals['_ARRAYSHAPE']._serialized_start=343
+  _globals['_ARRAYSHAPE']._serialized_end=368
+  _globals['_COMPLEXNUMBER']._serialized_start=370
+  _globals['_COMPLEXNUMBER']._serialized_end=413
+  _globals['_COMPLEXNUMPYARRAY']._serialized_start=415
+  _globals['_COMPLEXNUMPYARRAY']._serialized_end=512
+  _globals['_REALNUMPYARRAY']._serialized_start=514
+  _globals['_REALNUMPYARRAY']._serialized_end=582
+  _globals['_ARGUMENT']._serialized_start=585
+  _globals['_ARGUMENT']._serialized_end=800
+  _globals['_GENERICRPC']._serialized_start=802
+  _globals['_GENERICRPC']._serialized_end=883
+# @@protoc_insertion_point(module_scope)

remoterf_server-0.1.0/src/remoteRF_server/common/grpc/grpc_pb2_grpc.py

@@ -0,0 +1,97 @@
+# Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT!
+"""Client and server classes corresponding to protobuf-defined services."""
+import grpc
+import warnings
+
+from . import grpc_pb2 as grpc__pb2
+
+GRPC_GENERATED_VERSION = '1.71.0'
+GRPC_VERSION = grpc.__version__
+_version_not_supported = False
+
+try:
+    from grpc._utilities import first_version_is_lower
+    _version_not_supported = first_version_is_lower(GRPC_VERSION, GRPC_GENERATED_VERSION)
+except ImportError:
+    _version_not_supported = True
+
+if _version_not_supported:
+    raise RuntimeError(
+        f'The grpc package installed is at version {GRPC_VERSION},'
+        + f' but the generated code in grpc_pb2_grpc.py depends on'
+        + f' grpcio>={GRPC_GENERATED_VERSION}.'
+        + f' Please upgrade your grpc module to grpcio>={GRPC_GENERATED_VERSION}'
+        + f' or downgrade your generated code using grpcio-tools<={GRPC_VERSION}.'
+    )
+
+
+class GenericRPCStub(object):
+    """Missing associated documentation comment in .proto file."""
+
+    def __init__(self, channel):
+        """Constructor.
+
+        Args:
+            channel: A grpc.Channel.
+        """
+        self.Call = channel.unary_unary(
+                '/remote_rf.GenericRPC/Call',
+                request_serializer=grpc__pb2.GenericRPCRequest.SerializeToString,
+                response_deserializer=grpc__pb2.GenericRPCResponse.FromString,
+                _registered_method=True)
+
+
+class GenericRPCServicer(object):
+    """Missing associated documentation comment in .proto file."""
+
+    def Call(self, request, context):
+        """Missing associated documentation comment in .proto file."""
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+
+def add_GenericRPCServicer_to_server(servicer, server):
+    rpc_method_handlers = {
+            'Call': grpc.unary_unary_rpc_method_handler(
+                    servicer.Call,
+                    request_deserializer=grpc__pb2.GenericRPCRequest.FromString,
+                    response_serializer=grpc__pb2.GenericRPCResponse.SerializeToString,
+            ),
+    }
+    generic_handler = grpc.method_handlers_generic_handler(
+            'remote_rf.GenericRPC', rpc_method_handlers)
+    server.add_generic_rpc_handlers((generic_handler,))
+    server.add_registered_method_handlers('remote_rf.GenericRPC', rpc_method_handlers)
+
+
+ # This class is part of an EXPERIMENTAL API.
+class GenericRPC(object):
+    """Missing associated documentation comment in .proto file."""
+
+    @staticmethod
+    def Call(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_unary(
+            request,
+            target,
+            '/remote_rf.GenericRPC/Call',
+            grpc__pb2.GenericRPCRequest.SerializeToString,
+            grpc__pb2.GenericRPCResponse.FromString,
+            options,
+            channel_credentials,
+            insecure,
+            call_credentials,
+            compression,
+            wait_for_ready,
+            timeout,
+            metadata,
+            _registered_method=True)

remoterf_server-0.1.0/src/remoteRF_server/common/utils/__init__.py

@@ -0,0 +1,5 @@
+from .api_token import validate_token, generate_token, hash_token
+from .process_arg import unmap_arg, map_arg
+from .ansi_codes import printf, stylize, Sty
+from .list_string import list_to_str, str_to_list
+from .db_connection import db_connection

remoterf_server-0.1.0/src/remoteRF_server/common/utils/ansi_codes.py

@@ -0,0 +1,120 @@
+from prompt_toolkit.styles import Style
+from prompt_toolkit.formatted_text import FormattedText
+from prompt_toolkit import print_formatted_text
+from enum import Enum
+
+class Sty(Enum):
+    # Basic colors
+    RED = 'red'
+    GREEN = 'green'
+    BLUE = 'blue'
+    YELLOW = 'yellow'
+    MAGENTA = 'magenta'
+    CYAN = 'cyan'
+    GRAY = 'gray'
+    
+    # Background colors
+    BG_RED = 'bg-red'
+    BG_GREEN = 'bg-green'
+    BG_BLUE = 'bg-blue'
+    
+    # Bright versions
+    BRIGHT_RED = 'bright-red'
+    BRIGHT_GREEN = 'bright-green'
+    BRIGHT_BLUE = 'bright-blue'
+    
+    # Formatting
+    BOLD = 'bold'
+    ITALIC = 'italic'
+    UNDERLINE = 'underline'
+    BLINK = 'blink'
+    REVERSE = 'reverse'
+    
+    # Combinations
+    ERROR = 'error'
+    WARNING = 'warning'
+    INFO = 'info'
+    
+    # Special
+    SELECTED = 'selected'
+    DEFAULT = 'default'
+
+# Define the styles based on ANSI codes
+style = Style.from_dict({
+    # Basic colors
+    'red': 'fg:#110000',
+    'green': 'fg:#003300',
+    'blue': 'fg:#0000ff',
+    'yellow': 'fg:#ffff00',
+    'magenta': 'fg:#ff00ff',
+    'cyan': 'fg:#00ffff',
+    'gray': 'fg:#808080',
+    
+    # Bright versions
+    'bright-red': 'fg:#ff5555',
+    'bright-green': 'fg:#00ff00',
+    'bright-blue': 'fg:#5555ff',
+    
+    # Formatting
+    'bold': 'bold',
+    'italic': 'italic',
+    'underline': 'underline',
+    'reverse': 'reverse',
+    
+    # Combinations
+    'error': 'bg:#ff0000 fg:#ffffff bold',
+    'warning': 'bg:#ffff00 fg:#000000 bold',
+    'info': 'bg:#0000ff fg:#ffffff italic underline',
+    
+    # Special
+    'selected': 'bg:#ffffff #000000 reverse',
+    'default':''
+})
+
+def printf(*args) -> str:
+    if len(args) % 2 != 0:
+        raise ValueError('Arguments must be in pairs of two.')
+    
+    # Create formatted text using the defined style
+    formatted_text = []
+    
+    for i in range(0, len(args), 2):
+        message = args[i]
+        styles = args[i+1]
+        
+        if not isinstance(styles, tuple):
+            styles = (styles,)
+            
+        resolved_styles = (s.value if isinstance(s, Enum) else s for s in styles)
+        
+        style_class = ' '.join(resolved_styles)
+        
+        formatted_text.append(('class:' + style_class, message))
+    
+    # Create FormattedText object from pairs
+    text = FormattedText(formatted_text)
+    
+    print_formatted_text(text, style=style)
+    return text
+
+def stylize(*args):
+    """
+    Create a styled prompt text based on pairs of (text, (Sty, ...), ...).
+    """
+    if len(args) % 2 != 0:
+        raise ValueError("Arguments must be in pairs of (text, style_class).")
+    
+    styled_parts = []
+    for i in range(0, len(args), 2):
+        text = args[i]
+        styles = args[i + 1]
+        
+        if not isinstance(styles, tuple):
+            styles = (styles,)
+            
+        resolved_styles = (s.value if isinstance(s, Enum) else s for s in styles)
+        
+        style_class = ' '.join(resolved_styles)
+        styled_parts.append(('class:' + style_class, text))
+    
+    return FormattedText(styled_parts)