Merge pull request #1 from bcmi-labs/module_project_restructure

Module - structure aligninment with python requirements

Author: rjtokenring

README.md

@@ -2,4 +2,21 @@
 
 To build package:
 * pip install build
-* python -m build
+* python -m build
+
+# Development
+
+For development purposes, install module a "editable install"
+```sh
+pip install -e ".[dev]"
+```
+
+All tests must be added in tests/ folder. To execute tests, run command:
+```sh
+pytest -vs tests
+```
+
+or, to execute a single test
+```sh
+pytest -vs tests\test_execute_function.py
+```

appslab_modules/steps/db_storage/test_database_storage.py

@@ -22,6 +22,9 @@ dependencies = [
 ]
 
 [project.optional-dependencies]
+dev = [
+    "pytest",
+]
 db_storage = [
     "influxdb_client>=1.48.0",
 ]
@@ -37,8 +40,8 @@ all = [
 "Homepage" = "https://github.com/bcmi-labs/appslab-python-modules"
 
 [tool.setuptools.packages.find]
-where = ["."]
-include = ["appslab_modules*"]
+where = ["src"]
+include = ["*"]
 
 [tool.setuptools.package-data]
 "*" = ["*.yaml", "*.md"]

appslab_modules/steps/execute_function/test_execute_function.py

@@ -0,0 +1 @@
+from .module import get_module_config_file, get_module_compose_file, get_module_linked_resource_file

appslab_modules/steps/json_parser/test_json_parser.py

@@ -0,0 +1,34 @@
+import os
+
+config_file_name = "module_config.yaml"
+compose_config_file_name = "module_compose.yaml"
+
+def get_module_config_file(cls) -> str|None:
+    """Gets the full path of the module_config.yaml file."""
+    return get_module_linked_resource_file(cls, config_file_name)
+
+def get_module_compose_file(cls) -> str|None:
+    """Gets the full path of the module_compose.yaml file, if present."""
+    return get_module_linked_resource_file(cls, compose_config_file_name)
+
+def get_module_linked_resource_file(cls, resource_file_name) -> str|None:
+    """Gets the full path to a config file in the directory containing a class."""
+    try:
+        module = cls.__module__
+        if module == '__main__':
+            directory_path = os.path.dirname(os.path.abspath(__file__))
+        else:
+            module_obj = __import__(module, fromlist=['__file__'])
+            file_path = os.path.abspath(module_obj.__file__)
+            directory_path = os.path.dirname(file_path)
+
+        requested_path = os.path.join(directory_path, resource_file_name)
+        if os.path.exists(requested_path):
+            return requested_path
+        else:
+            return None
+    except AttributeError:
+        # Handle built-in classes or other cases where __file__ is not available
+        return None
+    except ModuleNotFoundError:
+        return None