cleepcli 1.34.2__tar.gz → 1.35.1__tar.gz

{cleepcli-1.34.2/cleepcli.egg-info → cleepcli-1.35.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cleepcli
-Version: 1.34.2
+Version: 1.35.1
 Summary: Cleep-cli helps developers to build great Cleep applications from command line.
 Home-page: https://github.com/CleepDevice/cleep-cli
 Author: Tanguy Bonneau

{cleepcli-1.34.2 → cleepcli-1.35.1}/bin/ccli

@@ -6,7 +6,6 @@
 
 import logging
 import sys
-logging.basicConfig(level=logging.INFO, format=u'%(message)s', stream=sys.stdout)
 import os
 import platform
 import subprocess
@@ -23,10 +22,14 @@ from cleepcli.package import Package
 from cleepcli.docs import Docs
 from cleepcli.check import Check
 from cleepcli.ci import Ci
-from cleepcli.cleepapi import CleepApi
 import cleepcli.config as config
 from cleepcli.version import VERSION
 
+if os.getcwd() == '/root/cleep-cli':
+    # in dev env, force debug log level by default
+    logging.basicConfig(level=logging.DEBUG, format='%(asctime)s %(levelname)s [%(name)s:%(lineno)d]: %(message)s', stream=sys.stdout)
+else:
+    logging.basicConfig(level=logging.INFO, format='%(message)s', stream=sys.stdout)
 
 # install logging trace level
 level = logging.TRACE = logging.DEBUG - 5
@@ -255,8 +258,8 @@ def reset(ctx):
 def mod():
     pass
 
-def get_module_name(param, value):
-    module_name = value if value else None
+def get_module_name(ctx, param, value):
+    module_name = value or None
     try:
         current_path = os.getcwd()
         if current_path.startswith(config.MODULES_SRC) and not module_name:
@@ -272,7 +275,8 @@ def get_module_name(param, value):
     return module_name
 
 @mod.command()
-def modssync():
+@click.option('--run-scripts', default=False, is_flag=True, help='Also run preinst.sh and postinst.sh scripts')
+def modssync(run_scripts):
     """
     Synchronize all mandatory modules (system, network...)
     """
@@ -283,6 +287,9 @@ def modssync():
         res = f.module_sync(module)
         if not res:
             sys.exit(1)
+        res = f.module_run_install_scripts(module)
+        if not res:
+            sys.exit(1)
 
     logging.info('Done')
 
@@ -337,7 +344,7 @@ def watch(quiet, loglevel, rpc_url):
     """
     Start watchdog that monitors filesystem changes on Cleep sources
     """
-    if logging.getLogger().getEffectiveLevel()==logging.DEBUG:
+    if logging.getLogger().getEffectiveLevel() == logging.DEBUG:
         # do not overwrite root logger level if configured to DEBUG (dev mode)
         pass
     elif quiet:
@@ -859,14 +866,14 @@ def print_version(ctx, param, value):
 def cli():
     pass
 
-if __name__ == '__main__':
 
+if __name__ == '__main__':
     def is_raspbian():
         if platform.system()!='Linux':
             return False
         res = subprocess.Popen(u'cat /etc/os-release | grep -i raspbian | wc -l', stdout=subprocess.PIPE, shell=True)
         stdout = res.communicate()[0]
-        if stdout.strip()=='0':
+        if stdout.strip() == '0':
             return False
         return True
 
@@ -874,5 +881,4 @@ if __name__ == '__main__':
     if is_raspbian():
         cli()
     else:
-        click.echo('Cleep-cli runs only on RaspiOS distribution')
-
+        click.echo('Cleep-cli runs only on RaspberrypiOS distribution')

{cleepcli-1.34.2 → cleepcli-1.35.1}/bin/cleep-cli

@@ -6,7 +6,6 @@
 
 import logging
 import sys
-logging.basicConfig(level=logging.INFO, format=u'%(message)s', stream=sys.stdout)
 import os
 import platform
 import subprocess
@@ -23,10 +22,14 @@ from cleepcli.package import Package
 from cleepcli.docs import Docs
 from cleepcli.check import Check
 from cleepcli.ci import Ci
-from cleepcli.cleepapi import CleepApi
 import cleepcli.config as config
 from cleepcli.version import VERSION
 
+if os.getcwd() == '/root/cleep-cli':
+    # in dev env, force debug log level by default
+    logging.basicConfig(level=logging.DEBUG, format='%(asctime)s %(levelname)s [%(name)s:%(lineno)d]: %(message)s', stream=sys.stdout)
+else:
+    logging.basicConfig(level=logging.INFO, format='%(message)s', stream=sys.stdout)
 
 # install logging trace level
 level = logging.TRACE = logging.DEBUG - 5
@@ -255,8 +258,8 @@ def reset(ctx):
 def mod():
     pass
 
-def get_module_name(param, value):
-    module_name = value if value else None
+def get_module_name(ctx, param, value):
+    module_name = value or None
     try:
         current_path = os.getcwd()
         if current_path.startswith(config.MODULES_SRC) and not module_name:
@@ -272,7 +275,8 @@ def get_module_name(param, value):
     return module_name
 
 @mod.command()
-def modssync():
+@click.option('--run-scripts', default=False, is_flag=True, help='Also run preinst.sh and postinst.sh scripts')
+def modssync(run_scripts):
     """
     Synchronize all mandatory modules (system, network...)
     """
@@ -283,6 +287,9 @@ def modssync():
         res = f.module_sync(module)
         if not res:
             sys.exit(1)
+        res = f.module_run_install_scripts(module)
+        if not res:
+            sys.exit(1)
 
     logging.info('Done')
 
@@ -337,7 +344,7 @@ def watch(quiet, loglevel, rpc_url):
     """
     Start watchdog that monitors filesystem changes on Cleep sources
     """
-    if logging.getLogger().getEffectiveLevel()==logging.DEBUG:
+    if logging.getLogger().getEffectiveLevel() == logging.DEBUG:
         # do not overwrite root logger level if configured to DEBUG (dev mode)
         pass
     elif quiet:
@@ -859,14 +866,14 @@ def print_version(ctx, param, value):
 def cli():
     pass
 
-if __name__ == '__main__':
 
+if __name__ == '__main__':
     def is_raspbian():
         if platform.system()!='Linux':
             return False
         res = subprocess.Popen(u'cat /etc/os-release | grep -i raspbian | wc -l', stdout=subprocess.PIPE, shell=True)
         stdout = res.communicate()[0]
-        if stdout.strip()=='0':
+        if stdout.strip() == '0':
             return False
         return True
 
@@ -874,5 +881,4 @@ if __name__ == '__main__':
     if is_raspbian():
         cli()
     else:
-        click.echo('Cleep-cli runs only on RaspiOS distribution')
-
+        click.echo('Cleep-cli runs only on RaspberrypiOS distribution')

{cleepcli-1.34.2 → cleepcli-1.35.1}/cleepcli/file.py

@@ -1,7 +1,6 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
-import sys
 import os
 from .console import Console
 import logging
@@ -36,7 +35,7 @@ class File():
 mkdir -p "%(HTML_DST)s/"
 mkdir -p "%(CORE_DST)s/modules"
 mkdir -p "%(MEDIA_DST)s/modules"
-mdkir -p "%(CONFIG_DIR)s"
+mkdir -p "%(CONFIG_DIR)s"
 rsync -av "%(REPO_DIR)s/cleep/" "%(CORE_DST)s/" --exclude "/tests/" --exclude "modules" --exclude "*__pycache__*" --delete --exclude "*.pyc" --keep-dirlinks
 rsync -av "%(REPO_DIR)s/html/" "%(HTML_DST)s/" --delete --exclude "js/modules/" --exclude "*node_modules*"
 rsync -av "%(REPO_DIR)s/bin/cleep" "%(BIN_DST)s/cleep"
@@ -58,7 +57,8 @@ rsync -av "%(REPO_DIR)s/medias/sounds" "%(MEDIA_DST)s/sounds/" --delete
         Copy specified module content to valid execution location
         """
         if not os.path.exists(os.path.join(config.MODULES_SRC, module_name)):
-            sys.exit('Module "%s" doesn\'t exist [%s]' % (module_name, os.path.join(config.MODULES_SRC, module_name)))
+            self.logger.error('Module "%s" doesn\'t exist [%s]' % (module_name, os.path.join(config.MODULES_SRC, module_name)))
+            return False
     
         if not os.path.exists(os.path.join(config.MODULES_DST, module_name)):
             os.makedirs(os.path.join(config.MODULES_DST, module_name))
@@ -101,3 +101,30 @@ fi
 
         return True
 
+    def module_run_install_scripts(self, module_name):
+        """
+        Run module installation scripts
+        """
+        if not os.path.exists(os.path.join(config.MODULES_SRC, module_name)):
+            self.logger.error('Module "%s" doesn\'t exist [%s]' % (module_name, os.path.join(config.MODULES_SRC, module_name)))
+            return False
+
+        preinst_script = os.path.join(config.MODULES_SCRIPTS_DST, module_name, "preinst.sh")
+        postinst_script = os.path.join(config.MODULES_SCRIPTS_DST, module_name, "postinst.sh")
+        console = Console()
+
+        if os.path.exists(preinst_script):
+            self.logger.info('Running %s scripts', preinst_script)
+            resp = console.command(preinst_script, timeout=300)
+            if resp["returncode"] != 0:
+                self.logger.error('Error running %s [%s]: %s', preinst_script, resp["returncode"], ''.join(resp["stderr"]))
+                return False
+
+        if os.path.exists(postinst_script):
+            self.logger.info('Running %s scripts', postinst_script)
+            resp = console.command(postinst_script, timeout=300)
+            if resp["returncode"] != 0:
+                self.logger.error('Error running %s [%s]: %s', postinst_script, resp["returncode"], ''.join(resp["stderr"]))
+                return False
+
+        return True

{cleepcli-1.34.2 → cleepcli-1.35.1}/cleepcli/version.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
-VERSION = '1.34.2'
+VERSION = '1.35.1'
 

{cleepcli-1.34.2 → cleepcli-1.35.1}/cleepcli/watch.py

@@ -8,18 +8,20 @@ import time
 import logging
 from . import config
 from watchdog.observers import Observer
-from watchdog.events import FileSystemEventHandler
+from watchdog.events import PatternMatchingEventHandler, EVENT_TYPE_MODIFIED
 import watchdog.events as events
 from threading import Thread
 from .cleepapi import CleepApi
 from .file import File
 from collections import deque
 
-class ActionFileSync():
+
+class ActionFileSync:
     def __init__(self, module=None):
         self.module = module
 
-class ActionRestart():
+
+class ActionRestart:
     def __init__(self, frontend=False):
         self.frontend = frontend
 
@@ -29,6 +31,7 @@ class ActionsExecutor(Thread):
     Actions executor
     Implements queue to execute sequentially actions
     """
+
     def __init__(self, rpc_url):
         Thread.__init__(self)
         Thread.daemon = True
@@ -80,51 +83,45 @@ class ActionsExecutor(Thread):
                 self.__execute_action(action)
 
             except IndexError:
-                #no action available
+                # no action available
                 time.sleep(0.25)
 
             except:
-                #error occured during action execution
-                self.logger.exception('Error during action execution:')
+                # error occured during action execution
+                self.logger.exception("Error during action execution:")
 
 
-class CleepHandler(FileSystemEventHandler):
+class CleepHandler(PatternMatchingEventHandler):
     """
     Watchdog handler for Cleep
     """
+
     REJECTED_FILENAMES = [
-        '4913', #vim furtive temp file to check user permissions
-        '.gitignore'
+        "4913",  # vim furtive temp file to check user permissions
+        ".gitignore",
     ]
     REJECTED_EXTENSIONS = [
-        '.swp', #vim
-        '.swpx', #vim
-        '.swx', #vim
-        '.tmp', #generic?
-        '.offset', #pygtail
-        '.pyc', #python compiled
-        '.log' #log file
-    ]
-    REJECTED_PREFIXES = [
-        '.',
-        '~'
-    ]
-    REJECTED_SUFFIXES = [
-        '~'
+        ".swp",  # vim
+        ".swpx",  # vim
+        ".swx",  # vim
+        ".tmp",  # generic?
+        ".offset",  # pygtail
+        ".pyc",  # python compiled
+        ".log",  # log file
     ]
+    REJECTED_PREFIXES = [".", "~"]
+    REJECTED_SUFFIXES = ["~"]
     REJECTED_DIRS = [
-        '.git',
-        '.vscode',
-        '.editor',
-        'backend/__pycache__',
+        ".git",
+        ".vscode",
+        ".editor",
+        "__pycache__",
     ]
-    DEBOUNCE = 0.25 #seconds
+    DEBOUNCE = 0.25  # seconds
 
     def __init__(self, actions_executor):
-        self.__last_times = {
-            'backend': 0,
-            'frontend': 0
-        }
+        super().__init__(ignore_patterns=["(\.git|__pycache__|.vscode|.editor)"])
+        self.__last_times = {"backend": 0, "frontend": 0}
         self.logger = logging.getLogger(self.__class__.__name__)
         self.actions_executor = actions_executor
 
@@ -134,67 +131,74 @@ class CleepHandler(FileSystemEventHandler):
         Return:
             bool: True if event must be dropped
         """
-        #drop dir modified event or created file (that always comes with modified file)
+        # drop dir modified event or created file (that always comes with modified file)
         if type(event) in (events.DirModifiedEvent, events.FileCreatedEvent):
-            self.logger.debug('Filtered: DirModifiedEvent or FileCreatedEvent')
+            self.logger.debug(" Filtered: DirModifiedEvent or FileCreatedEvent")
+            return True
+
+        if event.event_type != EVENT_TYPE_MODIFIED:
+            self.logger.debug(" Filtered: not modified event type")
             return True
 
-        #filter invalid event
+        # filter invalid event
         if not event:
-            self.logger.debug('Filtered: invalid event')
+            self.logger.debug(" Filtered: invalid event")
             return True
 
-        #filter event on current script
-        if event.src_path == '.%s' % __file__:
-            self.logger.debug('Filtered: event on current script')
+        # filter on non
+
+        # filter event on current script
+        if event.src_path == ".%s" % __file__:
+            self.logger.debug(" Filtered: event on current script")
             return True
 
-        #filter root event
-        if event.src_path == '.':
-            self.logger.debug('Filtered: root event')
+        # filter root event
+        if event.src_path == ".":
+            self.logger.debug(" Filtered: root event")
             return True
 
-        #filter invalid extension
+        # filter invalid extension
         src_ext = os.path.splitext(event.src_path)[1]
         if src_ext in self.REJECTED_EXTENSIONS:
-            self.logger.debug('Filtered: invalid extension')
+            self.logger.debug(" Filtered: invalid extension")
             return True
 
-        #filter by prefix
+        # filter by prefix
         for prefix in self.REJECTED_PREFIXES:
             if event.src_path.startswith(prefix):
-                self.logger.debug('Filtered: source prefix')
+                self.logger.debug(" Filtered: source prefix")
                 return True
-            if getattr(event, 'dest_path', None) and event.dest_path.startswith(prefix):
-                self.logger.debug('Filtered: destination prefix')
+            if getattr(event, "dest_path", None) and event.dest_path.startswith(prefix):
+                self.logger.debug(" Filtered: destination prefix")
                 return True
 
-        #filter by suffix
+        # filter by suffix
         for suffix in self.REJECTED_SUFFIXES:
             if event.src_path.endswith(suffix):
-                self.logger.debug('Filtered: source suffix')
+                self.logger.debug("Filtered: source suffix")
                 return True
-            if getattr(event, 'dest_path', None) and event.dest_path.endswith(prefix):
-                self.logger.debug('Filtered: destination suffix')
+            if getattr(event, "dest_path", None) and event.dest_path.endswith(prefix):
+                self.logger.debug(" Filtered: destination suffix")
                 return True
 
-        #filter by filename
+        # filter by filename
         for filename in self.REJECTED_FILENAMES:
             if event.src_path.endswith(filename):
-                self.logger.debug('Filtered: filename')
+                self.logger.debug(" Filtered: filename")
                 return True
 
-        #filter by dir
+        # filter by dir
         parts = event.src_path.split(os.path.sep)
         for folder in self.REJECTED_DIRS:
             if folder in parts:
-                self.logger.debug('Filtered: directory')
+                self.logger.debug(" Filtered: directory")
                 return True
 
+        self.logger.debug(" NotFiltered")
         return False
 
     def __debounce(self, now, last_time):
-        if now<(last_time+self.DEBOUNCE):
+        if now < (last_time + self.DEBOUNCE):
             return True
         return False
 
@@ -208,19 +212,19 @@ class CleepHandler(FileSystemEventHandler):
         Returns:
             module name (string) or None if nothing found
         """
-        pattern = '^%s/(.*?)/(?:frontend|backend|scripts)/.*$' % (config.MODULES_SRC)
-        #self.logger.debug('Module pattern: %s' % pattern)
+        pattern = "^%s/(.*?)/(?:frontend|backend|scripts)/.*$" % (config.MODULES_SRC)
+        # self.logger.debug('Module pattern: %s' % pattern)
 
-        if hasattr(event, 'src_path'):
+        if hasattr(event, "src_path"):
             res = re.findall(pattern, event.src_path)
-            if res and len(res)>0:
+            if res and len(res) > 0:
                 return res[0]
 
-        if hasattr(event, 'dest_path'):
+        if hasattr(event, "dest_path"):
             res = re.findall(pattern, event.dest_path)
-            if res and len(res)>0:
+            if res and len(res) > 0:
                 return res[0]
-        
+
         return None
 
     def __change_on_core(self, event):
@@ -233,18 +237,21 @@ class CleepHandler(FileSystemEventHandler):
         Returns:
             True if change occurs in core, False otherwise
         """
-        pattern_core = '^(%s/(?!tests|modules)(.*\.py)|%s/.*)$' % (config.CORE_SRC, config.HTML_SRC)
-        pattern_bin = '^%s/cleep' % (config.BIN_SRC)
-        #self.logger.debug('Core pattern: %s' % pattern_core)
-        #self.logger.debug('Bin pattern: %s' % pattern_bin)
-
-        if hasattr(event, 'src_path'):
+        pattern_core = "^(%s/(?!tests|modules)(.*\.py)|%s/.*)$" % (
+            config.CORE_SRC,
+            config.HTML_SRC,
+        )
+        pattern_bin = "^%s/cleep" % (config.BIN_SRC)
+        # self.logger.debug('Core pattern: %s' % pattern_core)
+        # self.logger.debug('Bin pattern: %s' % pattern_bin)
+
+        if hasattr(event, "src_path"):
             if re.search(pattern_core, event.src_path):
                 return True
             if re.search(pattern_bin, event.src_path):
                 return True
 
-        if hasattr(event, 'dest_path'):
+        if hasattr(event, "dest_path"):
             if re.search(pattern_core, event.dest_path):
                 return True
 
@@ -260,15 +267,18 @@ class CleepHandler(FileSystemEventHandler):
         Returns:
             True if change on frontend, False otherwise
         """
-        pattern = '^(%s/|%s/(?:.*?)/frontend/).*$' % (config.HTML_SRC, config.MODULES_SRC)
-        #self.logger.debug('Frontend pattern: %s' % pattern)
+        pattern = "^(%s/|%s/(?:.*?)/frontend/).*$" % (
+            config.HTML_SRC,
+            config.MODULES_SRC,
+        )
+        # self.logger.debug('Frontend pattern: %s' % pattern)
 
-        if hasattr(event, 'src_path'):
+        if hasattr(event, "src_path"):
             res = re.search(pattern, event.src_path)
             if res:
                 return True
 
-        if hasattr(event, 'dest_path'):
+        if hasattr(event, "dest_path"):
             res = re.search(pattern, event.dest_path)
             if res:
                 return True
@@ -278,51 +288,54 @@ class CleepHandler(FileSystemEventHandler):
     def on_any_event(self, event):
         try:
             now = time.time()
-            self.logger.debug('Event: %s' % event)
+            self.logger.debug("Event: %s" % event)
             if not self.__is_event_dropped(event):
                 self.__last_action_time = now
 
-                #is event on backend or frontend ?
+                # is event on backend or frontend ?
                 frontend = self.__change_on_frontend(event)
 
-                #debounce ?
-                if self.__debounce(now, self.__last_times[('frontend' if frontend else 'backend')]):
-                    self.logger.debug('  Dropped by debounce')
-                    return 
+                # debounce ?
+                if self.__debounce(
+                    now, self.__last_times[("frontend" if frontend else "backend")]
+                ):
+                    self.logger.debug("  Dropped by debounce")
+                    return
 
-                #is event on module ?
+                # is event on module ?
                 change_on_core = False
                 change_on_module = self.__change_on_module(event)
                 if change_on_module is None:
                     change_on_core = self.__change_on_core(event)
 
-                #push action and update last action time
+                # push action and update last action time
                 if change_on_module:
                     self.logger.debug('  Change on module "%s"' % change_on_module)
                     self.actions_executor.add_action(ActionFileSync(change_on_module))
                 elif change_on_core:
-                    self.logger.debug('  Change on core')
+                    self.logger.debug("  Change on core")
                     self.actions_executor.add_action(ActionFileSync())
                 else:
-                    self.logger.debug('  Dropped due to useless change')
+                    self.logger.debug("  Dropped due to useless change")
                     return
                 if frontend:
-                    self.logger.debug('  Change on frontend')
+                    self.logger.debug("  Change on frontend")
                     self.actions_executor.add_action(ActionRestart(True))
-                    self.__last_times['frontend'] = now
+                    self.__last_times["frontend"] = now
                 else:
-                    self.logger.debug('  Change on backend')
+                    self.logger.debug("  Change on backend")
                     self.actions_executor.add_action(ActionRestart())
-                    self.__last_times['backend'] = now
+                    self.__last_times["backend"] = now
 
         except:
-            self.logger.exception('Error occured during watcher event processing:')
+            self.logger.exception("Error occured during watcher event processing:")
 
 
-class CleepWatchdog():
+class CleepWatchdog:
     """
     Cleep core and module watchdog
     """
+
     def __init__(self, rpc_url):
         """
         Constructor
@@ -337,11 +350,13 @@ class CleepWatchdog():
         """
         Start watchdog that monitors filesystem changes on Cleep sources
         """
-        path = '%s/' % config.REPO_DIR
+        path = "%s/" % config.REPO_DIR
         self.actions_executor.start()
 
         if not os.path.exists(path):
-            self.logger.error('Please get Cleep sources using "cleep-cli getcore" command')
+            self.logger.error(
+                'Please get Cleep sources using "cleep-cli getcore" command'
+            )
             return False
 
         event_handler = CleepHandler(self.actions_executor)
@@ -358,4 +373,3 @@ class CleepWatchdog():
         observer.join()
 
         return True
-

{cleepcli-1.34.2 → cleepcli-1.35.1/cleepcli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cleepcli
-Version: 1.34.2
+Version: 1.35.1
 Summary: Cleep-cli helps developers to build great Cleep applications from command line.
 Home-page: https://github.com/CleepDevice/cleep-cli
 Author: Tanguy Bonneau

{cleepcli-1.34.2 → cleepcli-1.35.1}/cleepcli.egg-info/requires.txt

@@ -1,5 +1,5 @@
-Click<8.0,>=7.0
-watchdog<3.0.0,>=2.1.6
+Click<9.0,>=8.0
+watchdog<4.0.0,>=3.0.0
 Sphinx<5.0.0,>=4.2.0
 sphinx-rtd-theme>=1.0.0
 CProfileV>=1.0.7