Add making canned client rules

Author: ivmfnal

Makefile

@@ -1,35 +1,54 @@
 PRODUCT=metacat
 BUILD_DIR=$(HOME)/build/$(PRODUCT)
-TARDIR=/tmp
+TARDIR=/tmp/$(USER)
 LIBDIR=$(BUILD_DIR)/lib
 MODULEDIR=$(LIBDIR)/metacat
 SERVER_DIR=$(BUILD_DIR)/server
 DOCSDIR=$(BUILD_DIR)/docs
 DOCSREL=$(BUILD_DIR)/docs
 UI_DIR=$(BUILD_DIR)/ui
+DEPS_DIR=$(BUILD_DIR)/dependencies
 SERVER_TAR=$(TARDIR)/$(PRODUCT)_server_$(VERSION).tar
+CLIENT_TAR=$(TARDIR)/$(PRODUCT)_client_$(VERSION).tar
 
-all:
+CANNED_MODULES=pythreader jwt requests
+CANNED_PIP_MODULES="pythreader>=2.8.0" "pyjwt" "requests"
+
+all:	
 	echo Use "make dune" or "make generic"
-	
+
 dune:
 	make VERSION=`python metacat/version.py`_dune dune_with_version_defined
 
 generic:
 	make VERSION=`python metacat/version.py` generic_with_version_defined
 
-dune_with_version_defined:	build dune_specifics
-	make VERSION=$(VERSION) tars
-	
-generic_with_version_defined:	build
-	make VERSION=$(VERSION) tars
+dune_with_version_defined:	dune_specifics tars
 
-tars:  $(TARDIR)
+generic_with_version_defined:	tars
+
+tars:  build $(TARDIR)
 	cd $(BUILD_DIR); tar cf $(SERVER_TAR) lib server docs
 	@echo \|
-	@echo \| tarfile is created: $(SERVER_TAR)
+	@echo \| Server tarfile is created: $(SERVER_TAR)
 	@echo \|
 
+client:
+	make VERSION=`python metacat/version.py` client_with_version_defined
+
+client_with_version_defined: canned_client $(TARDIR)
+	cd $(BUILD_DIR); tar cf $(CLIENT_TAR) lib dependencies docs ui canned_client_setup.sh
+	@echo \|
+	@echo \| Canned client tarfile is created: $(CLIENT_TAR)
+	@echo \|
+
+canned_client: build $(DEPS_DIR)
+	pip install $(CANNED_PIP_MODULES)
+	python tools/copy_modules.py -c $(CANNED_MODULES) $(DEPS_DIR)
+	rm -rf $(DEPS_DIR)/*/__pycache__
+	find $(DEPS_DIR) -type f -name \*.pyc -exec rm -f {} \;
+	cp canned_client_setup.sh $(BUILD_DIR)
+
 dune_specifics:
 	cd DUNE_specials; make SERVER_DIR=$(SERVER_DIR) build
 
@@ -38,13 +57,17 @@ build:  clean $(BUILD_DIR)
 	cd metacat; make LIBDIR=$(LIBDIR) VERSION=$(VERSION) BINDIR=$(UI_DIR) build
 	cd webserver; make SERVER_DIR=$(SERVER_DIR) LIBDIR=$(LIBDIR) VERSION=$(VERSION) build
 	cd docs; make SERVER_DIR=$(SERVER_DIR) DOCSDIR=$(DOCSDIR) -f Makefile-product build
-	
+	find $(BUILD_DIR) -type d -name __pycache__ -print | xargs rm -rf
+	find $(BUILD_DIR) -type f -name \*.pyc -print -exec rm {} \;
+
 clean:
 	rm -rf $(BUILD_DIR) $(SERVER_TAR)
 
 $(TARDIR):
 	mkdir -p $@
 
+$(DEPS_DIR):
+	mkdir -p $@
 
 $(BUILD_DIR):
 	mkdir -p $@

canned_client_setup.sh

@@ -0,0 +1,14 @@
+# edit and soutrce this file
+
+export METACAT_SERVER_URL=...
+export METACAT_AUTH_SERVER_URL=...
+
+METACAT_CLIENT_ROOT=...         # where you untared the metacat_client_...tar
+
+# to use dependencies installed with pip or otherwise
+export PYTHONPATH=${METACAT_CLIENT_ROOT}/lib
+
+# to use canned dependencies, add dependencies subdirectory
+# export PYTHONPATH=${METACAT_CLIENT_ROOT}/lib:${METACAT_CLIENT_ROOT}/dependencies
+
+export PATH=${METACAT_CLIENT_ROOT}/ui

setup.py

@@ -20,7 +20,7 @@ def get_version():
     keywords = "metadata, data management, database, web service",
     url = "https://github.com/ivmfnal/metacat",
     packages=['metacat', 'metacat.db', 'metacat.util', 'metacat.webapi', 'metacat.ui', 'metacat.auth', 'metacat.ui.cli'],
-    install_requires=["pyjwt", "requests"],
+    install_requires=["pyjwt", "requests", "pythreader>=2.8.0"],
     zip_safe = False,
     classifiers=[
     ],

tools/copy_modules.py

@@ -0,0 +1,46 @@
+import sys, importlib, os.path, getopt
+from pythreader import ShellCommand
+
+Usage = """
+python copy_modules.py [options] <module> [...] <out_dir>"
+options:
+    -q                          - quiet, do not print status information
+    -c                          - create output directory if does not exist. Raise an error otherwise.
+"""
+
+def copy_module(mod_name, out_dir):
+    mod = importlib.import_module(mod_name)
+    mod_file = mod.__file__
+    mod_dir, mod_file_name = os.path.split(mod.__file__)
+    if mod_file_name.startswith("__init__"):
+        cmd = f"/bin/cp -R {mod_dir} {out_dir}"
+    else:
+        cmd = f"/bin/cp {mod_file} {out_dir}"
+    status, out, error = ShellCommand.execute(cmd)
+    if status != 0:
+        raise RuntimeError(f"Error copying module {mod_name}: {out}\n{error}")
+
+opts, args = getopt.getopt(sys.argv[1:], "qch?")
+opts = dict(opts)
+
+if not args or "-?" in opts or "-h" in opts:
+    print(Usage)
+    sys.exit(2)
+
+modules, out_dir = args[:-1], args[-1]
+
+if not os.path.isdir(out_dir):
+    if "-c" in opts:
+        os.makedirs(out_dir, mode=0o744)
+    else:
+        print(f"Output directory {out_dir} does not exist. Use -c to create", file=sys.stderr)
+        sys.exit(1)
+
+for mod in modules:
+    try:
+        copy_module(mod, out_dir)
+    except Exception as e:
+        print(e, file=sys.stderr)
+        sys.exit(1)
+    if "-q" not in opts:
+        print("copied:", mod)