[Packaging] install tentacles in user-appdirs

Author: Guillaume De Saint Martin

LICENSE

@@ -1,13 +1,20 @@
+PROJECT_NAME = "OctoBot-Pro"
+AUTHOR = "Drakkar-Software"
+VERSION = "0.0.1"  # major.minor.revision
+
+
 def _use_module_local_tentacles():
     import sys
     import os
+    import appdirs
     if os.getenv("USE_CUSTOM_TENTACLES", "").lower() == "true":
         # do not use octobot_pro/imports tentacles
         # WARNING: in this case, all the required tentacles imports still have to work
         # and therefore be bound to another tentacles folder
         return
-    # import tentacles from octobot_pro/imports directory
-    internal_import_path = os.path.join(os.path.dirname(os.path.abspath(__file__)), "imports")
+    # import tentacles from user-appdirs/imports directory
+    dirs = appdirs.AppDirs(PROJECT_NAME, AUTHOR, VERSION)
+    internal_import_path = os.path.join(dirs.user_data_dir, "imports")
     sys.path.insert(0, internal_import_path)
 
 
@@ -33,6 +40,3 @@ def _use_module_local_tentacles():
 from octobot_pro.constants import *
 from octobot_pro.api import *
 from octobot_pro.model import *
-
-PROJECT_NAME = "OctoBot-Pro"
-VERSION = "0.0.1"  # major.minor.revision

octobot_pro/__init__.py

@@ -25,11 +25,11 @@
 import octobot_tentacles_manager.api as api
 
 
-async def _install_all_tentacles(quite_mode) -> int:
+async def install_all_tentacles(quite_mode) -> int:
     octobot_pro_logging.enable_base_logger()
     error_count = 0
     logger = commons_logging.get_logger(f"{op.PROJECT_NAME}-CLI")
-    install_path = octobot_mocks.get_module_install_path()
+    install_path = octobot_mocks.get_module_appdir_path()
     tentacles_path = octobot_mocks.get_tentacles_path()
     tentacles_urls = octobot_mocks.get_public_tentacles_urls()
     async with aiohttp.ClientSession() as aiohttp_session:
@@ -52,7 +52,7 @@ def handle_octobot_pro_command(starting_args) -> int:
         print(f"{op.PROJECT_NAME} version {op.VERSION}")
         return 0
     if starting_args.install_tentacles:
-        return asyncio.run(_install_all_tentacles(starting_args.quite))
+        return asyncio.run(install_all_tentacles(starting_args.quite))
     print(f"No provided command. See --help to get more details on how to use {op.PROJECT_NAME}-CLI", file=sys.stderr)
     return -1
 

octobot_pro/cli.py

@@ -1,6 +1,8 @@
 import os
 import json
+import appdirs
 
+import octobot_pro
 import octobot_pro.constants as constants
 import octobot_tentacles_manager.api as octobot_tentacles_manager_api
 import octobot_tentacles_manager.constants as octobot_tentacles_manager_constants
@@ -26,19 +28,24 @@ def get_module_config_path(file_name):
     return os.path.join(get_module_install_path(), constants.CONFIG_PATH, file_name)
 
 
-def get_internal_import_path():
-    return os.path.join(get_module_install_path(), constants.ADDITIONAL_IMPORT_PATH)
+def get_module_appdir_path():
+    dirs = appdirs.AppDirs(octobot_pro.PROJECT_NAME, octobot_pro.AUTHOR, octobot_pro.VERSION)
+    return dirs.user_data_dir
 
 
-def get_imported_tentacles_path():
-    import tentacles
-    return os.path.dirname(os.path.abspath(tentacles.__file__))
+def get_internal_import_path():
+    return os.path.join(get_module_appdir_path(), constants.ADDITIONAL_IMPORT_PATH)
 
 
 def get_tentacles_path():
     return os.path.join(get_internal_import_path(), octobot_tentacles_manager_constants.TENTACLES_PATH)
 
 
+def get_imported_tentacles_path():
+    import tentacles
+    return os.path.dirname(os.path.abspath(tentacles.__file__))
+
+
 def get_public_tentacles_urls():
     return [
         octobot_configuration_manager.get_default_tentacles_url()

octobot_pro/internal/octobot_mocks.py

@@ -1,2 +1,5 @@
 # Drakkar-Software requirements
 OctoBot==0.4.27
+
+# manage tentacles install path
+appdirs==1.4.4

requirements.txt

@@ -1,12 +1,27 @@
+import asyncio
+
 from setuptools import find_packages
 from setuptools import setup
+from distutils.command.install import install
+
 
 # from octobot_pro import PROJECT_NAME, VERSION
 # todo figure out how not to import octobot_pro.__init__.py here
 PROJECT_NAME = "OctoBot-Pro"
 VERSION = "0.0.1"  # major.minor.revision
 
 
+def _post_install():
+    import octobot_pro.cli
+    asyncio.run(octobot_pro.cli.install_all_tentacles(True))
+
+
+class InstallWithPostInstallAction(install):
+    def run(self):
+        install.run(self)
+        self.execute(_post_install, (), msg="Installing OctoBot-Pro tentacles")
+
+
 PACKAGES = find_packages(
     exclude=[
         "tests",
@@ -31,7 +46,7 @@
     author_email='drakkar-software@protonmail.com',
     description='Backtesting framework of the OctoBot Ecosystem',
     packages=PACKAGES,
-    include_package_data=True,
+    cmdclass={'install': InstallWithPostInstallAction},
     long_description=DESCRIPTION,
     long_description_content_type='text/markdown',
     tests_require=["pytest"],