overlord: restructure dir structure, add setup.py

Author: aitjcize

.github/workflows/build.yml

@@ -19,7 +19,7 @@ jobs:
           apk add git python3 make gcc linux-headers libc-dev py-pip
           python3 -m venv .venv
           source .venv/bin/activate
-          pip install -r requirements.txt
+          pip install -r py/requirements.txt
       - name: Fix permission
         run: git config --global --add safe.directory $PWD
       - name: test

.gitignore

@@ -14,3 +14,4 @@ dist
 xcuserdata
 __pycache__
 *.pyc
+.DS_Store

Dockerfile

@@ -36,7 +36,7 @@ RUN mkdir -p /config /app /app/webroot/upgrade
 WORKDIR /app
 
 COPY --from=gobuilder /src/bin/overlordd /app
-COPY --from=gobuilder /src/scripts/start_overlordd.sh /app
+COPY --from=gobuilder /src/sh/start_overlordd.sh /app
 COPY --from=gobuilder /src/bin/ghost.* /app/webroot/upgrade/
 COPY --from=pybuilder /src/bin/ghost.* /app/webroot/upgrade/
 COPY --from=pybuilder /src/bin/ovl.* /app/webroot/upgrade/

Makefile

@@ -11,7 +11,7 @@ LDFLAGS=
 WEBROOT_DIR=$(CURDIR)/webroot
 DIST_APPS_DIR=$(WEBROOT_DIR)/apps
 GO_DIRS=./overlord/... ./cmd/...
-PY_FILES=$(shell find scripts -name "*.py")
+PY_FILES=$(shell find py -name "*.py")
 
 # Supported architectures for ghost binary
 GHOST_ARCHS=amd64 386 arm64 arm
@@ -74,9 +74,9 @@ ghost-all: $(GHOST_BINS) $(GHOST_BINS:=.sha1)
 build-go: overlordd ghost ghost-all
 
 build-py:
-	@ln -sf ../scripts/ghost.py bin
+	@ln -sf ../py/ghost.py bin
 	$(call cmd_msg,SHA1,ghost.py)
-	@sha1sum scripts/ghost.py > bin/ghost.py.sha1
+	@sha1sum py/ghost.py > bin/ghost.py.sha1
 
 	@mkdir -p $(BUILD)
 	$(call cmd_msg,VENV,creating virtualenv)
@@ -85,19 +85,19 @@ build-py:
 	$(call cmd_msg,PIP,installing requirements)
 	@cd $(BUILD); \
 	. $(BUILD)/.venv/bin/activate; \
-	pip install -q -r $(CURDIR)/requirements.txt; \
+	pip install -q -r $(CURDIR)/py/requirements.txt; \
 	pip install -q pyinstaller
 
 	$(call cmd_msg,GEN,ovl.pybin)
 	@cd $(BUILD); . $(BUILD)/.venv/bin/activate; \
-	pyinstaller --onefile $(CURDIR)/scripts/ovl.py > /dev/null;
+	pyinstaller --onefile $(CURDIR)/py/ovl.py > /dev/null;
 	@mv $(BUILD)/dist/ovl $(BIN)/ovl.pybin
 	$(call cmd_msg,SHA1,ovl.pybin)
 	@cd $(BIN) && sha1sum ovl.pybin > ovl.pybin.sha1
 
 	$(call cmd_msg,GEN,ghost.pybin)
 	@cd $(BUILD); . $(BUILD)/.venv/bin/activate; \
-	pyinstaller --onefile $(CURDIR)/scripts/ghost.py > /dev/null
+	pyinstaller --onefile $(CURDIR)/py/ghost.py > /dev/null
 	@mv $(BUILD)/dist/ghost $(BIN)/ghost.pybin
 	$(call cmd_msg,SHA1,ghost.pybin)
 	@cd $(BIN) && sha1sum ghost.pybin > ghost.pybin.sha1

scripts/ghost.py renamed to py/ghost.py

@@ -909,10 +909,10 @@ def CheckDaemon(self):
     self._state = DaemonState.FromDict(self._server.State())
     sha1sum = GetVersionDigest()
 
-    #if sha1sum != self._state.version_sha1sum:
-    #  print('ovl server is out of date.  killing...')
-    #  KillGraceful(self._server.GetPid())
-    #  self.StartServer()
+    if sha1sum != self._state.version_sha1sum:
+      print('ovl server is out of date.  killing...')
+      KillGraceful(self._server.GetPid())
+      self.StartServer()
 
   def GetSSHControlFile(self, host):
     return _SSH_CONTROL_SOCKET_PREFIX + host
@@ -1765,11 +1765,11 @@ def main():
   ovl = OverlordCliClient()
   try:
     ovl.Main()
-  #except KeyboardInterrupt:
-  #  print('Ctrl-C received, abort')
+  except KeyboardInterrupt:
+    print('Ctrl-C received, abort')
   except Exception as e:
     logging.exception(e)
-    #print(f'error: {str(e)}')
+    print(f'error: {str(e)}')
 
 
 if __name__ == '__main__':

scripts/ovl.py renamed to py/ovl.py

@@ -0,0 +1,73 @@
+#!/usr/bin/env python
+# Copyright 2023 The Overlord Authors. All rights reserved.
+
+from setuptools import setup
+import subprocess
+import sys
+
+# Check if we're installing
+if 'install' in sys.argv or 'develop' in sys.argv:
+    # Try to install ws4py from git directly
+    print("Installing ws4py dependency from git...")
+    try:
+        subprocess.check_call([
+            sys.executable, '-m', 'pip', 'install',
+            'git+https://github.com/aitjcize/WebSocket-for-Python.git#egg=ws4py'
+        ])
+        print("Successfully installed ws4py")
+    except subprocess.CalledProcessError as e:
+        print(f"Warning: Failed to install ws4py dependency: {e}")
+        print("You may need to install it manually with:")
+        print("pip install git+https://github.com/aitjcize/WebSocket-for-Python.git")
+
+# Read requirements from requirements.txt
+with open('requirements.txt') as f:
+    requirements = f.read().splitlines()
+
+# Filter out git dependencies for setup.py
+filtered_requirements = []
+for req in requirements:
+    if not req.startswith('ws4py @ git+') and req.strip():
+        filtered_requirements.append(req)
+
+# Add ws4py as a regular requirement
+filtered_requirements.append('ws4py')
+
+setup(
+    name="overlord",
+    version="1.0.0",
+    description="Overlord - Remote Device Management and Control System",
+    author="Wei-Ning Huang",
+    author_email="[email protected]",
+    url="https://github.com/aitjcize/Overlord",
+    py_modules=["ovl", "ghost", "update_ui_status", "relay_overlord_discovery_packet", "stream_camera"],
+    entry_points={
+        'console_scripts': [
+            'ovl=ovl:main',
+            'ghost=ghost:main',
+            'update_ui_status=update_ui_status:main',
+            'relay_overlord_discovery_packet=relay_overlord_discovery_packet:main',
+            'stream_camera=stream_camera:main',
+        ],
+    },
+    install_requires=filtered_requirements,
+    python_requires='>=3.6',
+    classifiers=[
+        "Development Status :: 4 - Beta",
+        "Environment :: Console",
+        "Intended Audience :: Developers",
+        "License :: OSI Approved :: BSD License",
+        "Operating System :: OS Independent",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.6",
+        "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Topic :: Software Development :: Testing",
+        "Topic :: System :: Monitoring",
+        "Topic :: System :: Systems Administration",
+    ],
+    dependency_links=[
+        "https://github.com/aitjcize/WebSocket-for-Python/tarball/master#egg=ws4py-0.5.1"
+    ],
+)