refactor: rename mc_srv_manager -> modular_server_manager and decouple UI/client

Author: AntoineBuirey

.gitignore

@@ -3,7 +3,7 @@ __pycache__/
 *.egg-info/
 dist/
 build/
-mc_srv_manager/
+modular_server_manager/
 *.log
 *.md
 

makefile

@@ -1,44 +1,21 @@
-.PHONY: all build clean server tests # client
+.PHONY: all build clean server tests
 
 all: build
 
 TEMP_DIR = build
 
-# WEB_SRC_TS = $(wildcard client/src/**/*.ts)
-# WEB_SRC_HTML = $(wildcard client/src/**/*.template.html)
-# WEB_SRC_SASS = $(wildcard client/src/**/*.scss)
-# WEB_ASSETS = $(wildcard client/src/assets/*)
-
-# WEB_DIST_JS = $(patsubst client/src/%.ts,mc_srv_manager/client/%.js,$(WEB_SRC_TS))
-# WEB_DIST_HTML = $(patsubst client/src/%.template.html,mc_srv_manager/client/%.html,$(WEB_SRC_HTML))
-# WEB_DIST_CSS = $(patsubst client/src/%.scss,mc_srv_manager/client/%.css,$(WEB_SRC_SASS))
-# WEB_DIST_ASSETS = $(patsubst client/src/assets/%,mc_srv_manager/client/assets/%,$(WEB_ASSETS))
-# WEB_DIST = $(WEB_DIST_JS) $(WEB_DIST_HTML) $(WEB_DIST_CSS) $(WEB_DIST_ASSETS)
-
-# WEB_DEV_JS = $(patsubst client/src/%.ts,client/dist/%.js,$(WEB_SRC_TS))
-# WEB_DEV_HTML = $(patsubst client/src/%.template.html,client/dist/%.html,$(WEB_SRC_HTML))
-# WEB_DEV_CSS = $(patsubst client/src/%.scss,client/dist/%.css,$(WEB_SRC_SASS))
-# WEB_DEV_ASSETS = $(patsubst client/src/assets/%,client/dist/assets/%,$(WEB_ASSETS))
 WEB_DEV_DIST = $(WEB_DEV_JS) $(WEB_DEV_HTML) $(WEB_DEV_CSS) $(WEB_DEV_ASSETS)
 
 
 SRV_SRC = $(shell find server/src -type f -name "*.py") server/src/minecraft/properties.xml server/src/bus/events.xml server/src/events_descriptions.json
-SRV_DIST = $(patsubst server/src/%,mc_srv_manager/%,$(SRV_SRC))
+SRV_DIST = $(patsubst server/src/%,modular_server_manager/%,$(SRV_SRC))
 
 CONFIG_SRC = $(wildcard server/src/config.json)
-CONFIG_DIST = $(patsubst server/src/%,mc_srv_manager/%,$(CONFIG_SRC))
+CONFIG_DIST = $(patsubst server/src/%,modular_server_manager/%,$(CONFIG_SRC))
 
 TESTS_PY = $(wildcard tests/*.py) $(wildcard tests/**/*.py)
 
 
-# HTML TEMPLATES DEPENDENCIES
-# mc_srv_manager/client/account/index.html:   client/src/metadata.template client/src/header/header.template
-# mc_srv_manager/client/dashboard/index.html: client/src/metadata.template client/src/header/header.template
-# mc_srv_manager/client/server/index.html:    client/src/metadata.template client/src/header/header.template
-# mc_srv_manager/client/login/index.html:     client/src/metadata.template client/src/header/header.template
-
-
-
 PYPROJECT = pyproject.toml
 
 PYTHON_PATH = $(shell if [ -d env/bin ]; then echo "env/bin/"; elif [ -d env/Scripts ]; then echo "env/Scripts/"; else echo ""; fi)
@@ -47,18 +24,17 @@ PYTHON = $(PYTHON_PATH)python
 
 EXECUTABLE_EXTENSION = $(shell if [ -d env/bin ]; then echo ""; elif [ -d env/Scripts ]; then echo ".exe"; else echo ""; fi)
 
-APP_EXECUTABLE = $(PYTHON_PATH)mc-srv-manager$(EXECUTABLE_EXTENSION)
+APP_EXECUTABLE = $(PYTHON_PATH)modular-server-manager$(EXECUTABLE_EXTENSION)
 
 # if not defined, get the version from git
 VERSION ?= $(shell $(PYTHON) get_version.py)
 
 # if version is in the form of x.y.z-dev-aaaa or x.y.z-dev+aaaa, set it to x.y.z-dev
-# VERSION_STR = $(shell echo $(VERSION) | sed 's/-dev-[a-z0-9]*\/\/')
 VERSION_STR = $(shell echo $(VERSION) | sed "s/-dev-[a-z0-9]*//; s/-dev+.*//")
 
 
-WHEEL = mc_srv_manager-$(VERSION_STR)-py3-none-any.whl
-ARCHIVE = mc_srv_manager-$(VERSION_STR).tar.gz
+WHEEL = modular_server_manager-$(VERSION_STR)-py3-none-any.whl
+ARCHIVE = modular_server_manager-$(VERSION_STR).tar.gz
 
 $(PYTHON_LIB)/build:
 	$(PYTHON_PATH)pip install build
@@ -67,53 +43,33 @@ $(PYTHON_LIB)/build:
 print-%:
 	@echo $* = $($*)
 
-# mc_srv_manager/client/%.html: client/src/%.template.html
-# 	@mkdir -p $(@D)
-# 	@echo "Compiling $< to $@"
-# 	@$(PYTHON) html_template.py client/src $(subst .template.html,,$(subst client/src/,,$<)) -o $@
-
-# mc_srv_manager/client/%.js: client/src/%.ts
-# 	@mkdir -p $(dir $@)
-# 	@echo "Compiling $< to $@"
-# 	@tsc --outDir mc_srv_manager/client $< --module es6 --target es6 --strict
-
-# mc_srv_manager/client/%.css: client/src/%.scss
-# 	@mkdir -p $(@D)
-# 	@echo "Compiling $< to $@"
-# 	@sass $< $@ --no-source-map
-
-mc_srv_manager/%.py: server/src/%.py
+modular_server_manager/%.py: server/src/%.py
 	@mkdir -p $(@D)
 	@echo "Copying $< to $@"
 	@cp $< $@
 
-mc_srv_manager/%.json: server/src/%.json
+modular_server_manager/%.json: server/src/%.json
 	@mkdir -p $(@D)
 	@echo "Copying $< to $@"
 	@cp $< $@
 
-# mc_srv_manager/client/assets/%: client/src/assets/%
-# 	@mkdir -p $(@D)
-# 	@echo "Copying $< to $@"
-# 	@cp $< $@
-
-mc_srv_manager/%: server/src/%
+modular_server_manager/%: server/src/%
 	@mkdir -p $(@D)
 	@echo "Copying $< to $@"
 	@cp $< $@
 
 dist:
 	mkdir -p dist
 
-dist/$(WHEEL): $(SRV_DIST) $(PYPROJECT) $(CONFIG_DIST) $(PYTHON_LIB)/build dist # $(WEB_DIST)
+dist/$(WHEEL): $(SRV_DIST) $(PYPROJECT) $(CONFIG_DIST) $(PYTHON_LIB)/build dist
 	mkdir -p $(TEMP_DIR)
 	$(PYTHON) build_package.py --outdir $(TEMP_DIR) --wheel --version $(VERSION_STR)
 	mkdir -p dist
 	mv $(TEMP_DIR)/*.whl dist/$(WHEEL)
 	rm -rf $(TEMP_DIR)
 	@echo "Building wheel package complete."
 
-dist/$(ARCHIVE): $(SRV_DIST) $(PYPROJECT) $(CONFIG_DIST) $(PYTHON_LIB)/build dist # $(WEB_DIST) 
+dist/$(ARCHIVE): $(SRV_DIST) $(PYPROJECT) $(CONFIG_DIST) $(PYTHON_LIB)/build dist
 	mkdir -p $(TEMP_DIR)
 	$(PYTHON) build_package.py --outdir $(TEMP_DIR) --sdist --version $(VERSION_STR)
 	mkdir -p dist
@@ -128,13 +84,11 @@ $(APP_EXECUTABLE) : dist/$(WHEEL)
 
 build: dist/$(WHEEL) dist/$(ARCHIVE)
 
-# client: $(WEB_DIST)
-
 server: $(SRV_DIST) $(CONFIG_DIST)
 
 
 
-test-report.xml: $(APP_EXECUTABLE) $(SRV_DIST) $(PYPROJECT) $(CONFIG_DIST) $(TESTS_PY) # $(WEB_DIST) 
+test-report.xml: $(APP_EXECUTABLE) $(SRV_DIST) $(PYPROJECT) $(CONFIG_DIST) $(TESTS_PY)
 	$(PYTHON) -m pytest --junitxml=test-report.xml tests
 
 
@@ -152,10 +106,10 @@ tests: clean-tests test-report.xml
 
 
 clean:
-	rm -rf mc_srv_manager
+	rm -rf modular_server_manager
 	rm -rf dist
-	rm -rf $(PYTHON_LIB)/mc_srv_manager
-	rm -rf $(PYTHON_LIB)/mc_srv_manager-*.dist-info
+	rm -rf $(PYTHON_LIB)/modular_server_manager
+	rm -rf $(PYTHON_LIB)/modular_server_manager-*.dist-info
 	rm -rf $(APP_EXECUTABLE)
 
 clean-tests:

pyproject.toml

@@ -9,56 +9,38 @@ requires-python = ">=3.12"
 dependencies = [
     "argon2-cffi==23.1.0",
     "beautifulsoup4==4.13.4",
-    # "blinker==1.9.0",
     "bs4==0.0.2",
     "certifi==2025.4.26",
     "charset-normalizer==3.4.1",
-    # "click==8.1.8",
     "distro==1.9.0",
-    # "Flask==3.1.1",
     "gamuLogger>=3.2.4",
     "idna==3.10",
-    # "itsdangerous==2.2.0",
-    # "Jinja2==3.1.6",
-    # "MarkupSafe==3.0.2",
     "requests>=2.32.4",
     "soupsieve==2.7",
     "typing_extensions==4.13.2",
     "urllib3==2.5.0",
-    # "Werkzeug==3.1.3",
-    # "dnspython==2.7.0",
-    # "eventlet==0.40.3",
-    # "greenlet==3.2.1",
-    # "python-socketio==5.14.0",
     "cache @ https://github.com/T0ine34/python-sample/releases/download/1.1.6/cache-1.1.6-py3-none-any.whl",
     "config @ https://github.com/T0ine34/python-sample/releases/download/1.1.6/config-1.1.6-py3-none-any.whl",
-    # "http_code @ https://github.com/T0ine34/python-sample/releases/download/1.1.6/http_code-1.1.6-py3-none-any.whl",
     "version @ https://github.com/T0ine34/python-sample/releases/download/1.1.6/version-1.1.6-py3-none-any.whl",
-    # "singleton @ https://github.com/T0ine34/python-sample/releases/download/1.1.6/singleton-1.1.6-py3-none-any.whl"
 ]
 
 [project.scripts]
-mc-srv-manager = "mc_srv_manager.__main__:main"
-mc-srv-manager-event-decoder = "mc_srv_manager.decode_event:main"
-mc-srv-manager-doc-gen = "mc_srv_manager.gen_doc:main"
+modular-server-manager = "modular_server_manager.__main__:main"
+modular-server-manager-event-decoder = "modular_server_manager.decode_event:main"
+modular-server-manager-doc-gen = "modular_server_manager.gen_doc:main"
 
 [tool.setuptools]
-packages = ["mc_srv_manager",
-                "mc_srv_manager.bus",
-                "mc_srv_manager.core",
-                "mc_srv_manager.minecraft",
-                    "mc_srv_manager.minecraft.forge",
-                    "mc_srv_manager.minecraft.vanilla",
-                "mc_srv_manager.user_interface",
-                    "mc_srv_manager.user_interface.database",
-                    "mc_srv_manager.user_interface.tk_window",
-                    "mc_srv_manager.user_interface.web_server",
-                "mc_srv_manager.utils",
-                # "mc_srv_manager.client",
-                #     "mc_srv_manager.client.assets"
+packages = ["modular_server_manager",
+                "modular_server_manager.bus",
+                "modular_server_manager.core",
+                "modular_server_manager.minecraft",
+                    "modular_server_manager.minecraft.forge",
+                    "modular_server_manager.minecraft.vanilla",
+                "modular_server_manager.user_interface",
+                    "modular_server_manager.user_interface.database",
+                "modular_server_manager.utils",
             ]
-package-data = { "mc_srv_manager" = [
-    # "client/**",
+package-data = { "modular_server_manager" = [
     "config.json",
     "minecraft/properties.xml",
     "bus/events.xml",

server/src/user_interface/Base_interface.py

@@ -21,6 +21,7 @@ class BaseInterface:
     It also provides methods to trigger events and handle callbacks.
     The list of callbacks is defined in the `callback_map` dictionary, which maps method names to events.
     """
+
     callback_map: dict[str, Event] = {
         "on_server_starting": Events["SERVER.STARTING"],
         "on_server_started": Events["SERVER.STARTED"],
@@ -39,7 +40,7 @@ class BaseInterface:
         "on_player_pardoned": Events["PLAYERS.PARDONED"]
     }
 
-    def __init__(self, bus_data : BusData, database_path: str):
+    def __init__(self, bus_data : BusData, database_path: str, key: str):
         if hasattr(self, "_BaseInterface__bus"): # Avoid reinitializing the bus
             return
         self.__bus = Bus(bus_data)

server/src/user_interface/__init__.py

@@ -1,10 +1,5 @@
 from typing import Dict
 
 from .Base_interface import BaseInterface
-from .tk_window import TkWindow
-from .web_server import WebServer
 
-UserInterfaceModules : Dict[str, type[BaseInterface]] = {
-    "web": WebServer,
-    "tk": TkWindow
-}
+UserInterfaceModules : Dict[str, type['BaseInterface']] = {}

tests/bus_test.py

@@ -7,9 +7,9 @@
 from gamuLogger import Levels, Logger
 from version import Version
 
-from mc_srv_manager.bus import Bus, BusData, Events
-from mc_srv_manager.bus.bus_dispatcher import BusDispatcher
-from mc_srv_manager.minecraft.forge.web_interface import WebInterface
+from modular_server_manager.bus import Bus, BusData, Events
+from modular_server_manager.bus.bus_dispatcher import BusDispatcher
+from modular_server_manager.minecraft.forge.web_interface import WebInterface
 
 # create a BusDispatcher, start it in a separate thread
 # then create some Bus instances, each one in a separate process

tests/integration/server_test.py

@@ -48,7 +48,7 @@ def setup_and_teardown(self, request : pytest.FixtureRequest):
 
 
         server_process = subprocess.Popen(
-            [sys.executable, "-m", "mc_srv_manager", "--module-level", "all:TRACE", "-c", config_file, "--log-file", f"{BASE_PATH}/temp/{name}.log:TRACE"],
+            [sys.executable, "-m", "modular_server_manager", "--module-level", "all:TRACE", "-c", config_file, "--log-file", f"{BASE_PATH}/temp/{name}.log:TRACE"],
             stdout=sys.stdout,
             stderr=sys.stdout
         )
@@ -103,7 +103,7 @@ def setup_and_teardown(self, request : pytest.FixtureRequest):
         if os.path.exists(f"{BASE_PATH}/temp/server.db"):
             os.remove(f"{BASE_PATH}/temp/server.db")
 
-        server_process = subprocess.Popen([sys.executable, "-m", "mc_srv_manager", "--module-level", "all:TRACE", "-c", CONFIG_FILE, "--log-file", f"tests/end_to_end/temp/{name}.log:TRACE"])
+        server_process = subprocess.Popen([sys.executable, "-m", "modular_server_manager", "--module-level", "all:TRACE", "-c", CONFIG_FILE, "--log-file", f"tests/end_to_end/temp/{name}.log:TRACE"])
         time.sleep(1)  # Wait for the server to start
 
         # create a test user
@@ -155,7 +155,7 @@ def setup_and_teardown(self, request : pytest.FixtureRequest):
         if os.path.exists(f"{BASE_PATH}/temp/server.db"):
             os.remove(f"{BASE_PATH}/temp/server.db")
 
-        server_process = subprocess.Popen([sys.executable, "-m", "mc_srv_manager", "--module-level", "all:TRACE", "-c", CONFIG_FILE, "--log-file", f"tests/end_to_end/temp/{name}.log:TRACE"])
+        server_process = subprocess.Popen([sys.executable, "-m", "modular_server_manager", "--module-level", "all:TRACE", "-c", CONFIG_FILE, "--log-file", f"tests/end_to_end/temp/{name}.log:TRACE"])
         time.sleep(1)
         # Wait for the server to start
         # create a test user