cleepcli 1.40.0__tar.gz → 1.41.0__tar.gz

{cleepcli-1.40.0/cleepcli.egg-info → cleepcli-1.41.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cleepcli
-Version: 1.40.0
+Version: 1.41.0
 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.40.0 → cleepcli-1.41.0}/bin/ccli

@@ -542,23 +542,6 @@ def moddoc(module):
         logging.error(str(e))
         sys.exit(1)
 
-@docs.command()
-@click.option('--module', callback=get_module_name, help='Module name.')
-@click.option('--version', prompt="Module version", help='Module version.')
-def moddoctest(module, version):
-    """
-    Test
-    """
-    try:
-        d = Docs()
-        docs = d.generate_module_docs(module)
-        res = d.publish_app_docs(module, version, docs)
-    except Exception as e:
-        if logging.getLogger().getEffectiveLevel() == logging.DEBUG:
-            logging.exception('Test module "%s" doc failed:' % module)
-        logging.error(str(e))
-        sys.exit(1)
-
 @click.group()
 def check():
     pass
@@ -838,13 +821,14 @@ def cimodcheck(module):
 @click.option('--version', prompt='Module version', help='Module version.')
 @click.option('--ghtoken', prompt='Github access token', help='Github access token', default=None)
 @click.option('--ghowner', prompt='Github repo owner', help='Github repo owner', default=None)
-def cimoddocpublish(module, version, ghtoken, ghowner):
+@click.option('--docfile', help='Already generated module doc', default=None, type=click.Path(exists=True))
+def cimoddocpublish(module, version, ghtoken, ghowner, docfile):
     """
     Publish module documentation to keep track of changes and detect breaking changes. Useful for CI
     """
     d = Docs()
     try:
-        d.publish_module_docs(module, version, ghtoken, ghowner)
+        d.publish_module_docs(module, version, ghtoken, ghowner, docfile)
     except Exception as e:
         if logging.getLogger().getEffectiveLevel() == logging.DEBUG:
             logging.exception('Module doc publication failed:')

{cleepcli-1.40.0 → cleepcli-1.41.0}/bin/cleep-cli

@@ -542,23 +542,6 @@ def moddoc(module):
         logging.error(str(e))
         sys.exit(1)
 
-@docs.command()
-@click.option('--module', callback=get_module_name, help='Module name.')
-@click.option('--version', prompt="Module version", help='Module version.')
-def moddoctest(module, version):
-    """
-    Test
-    """
-    try:
-        d = Docs()
-        docs = d.generate_module_docs(module)
-        res = d.publish_app_docs(module, version, docs)
-    except Exception as e:
-        if logging.getLogger().getEffectiveLevel() == logging.DEBUG:
-            logging.exception('Test module "%s" doc failed:' % module)
-        logging.error(str(e))
-        sys.exit(1)
-
 @click.group()
 def check():
     pass
@@ -838,13 +821,14 @@ def cimodcheck(module):
 @click.option('--version', prompt='Module version', help='Module version.')
 @click.option('--ghtoken', prompt='Github access token', help='Github access token', default=None)
 @click.option('--ghowner', prompt='Github repo owner', help='Github repo owner', default=None)
-def cimoddocpublish(module, version, ghtoken, ghowner):
+@click.option('--docfile', help='Already generated module doc', default=None, type=click.Path(exists=True))
+def cimoddocpublish(module, version, ghtoken, ghowner, docfile):
     """
     Publish module documentation to keep track of changes and detect breaking changes. Useful for CI
     """
     d = Docs()
     try:
-        d.publish_module_docs(module, version, ghtoken, ghowner)
+        d.publish_module_docs(module, version, ghtoken, ghowner, docfile)
     except Exception as e:
         if logging.getLogger().getEffectiveLevel() == logging.DEBUG:
             logging.exception('Module doc publication failed:')

{cleepcli-1.40.0 → cleepcli-1.41.0}/cleepcli/ci.py

@@ -139,7 +139,7 @@ class Ci():
             time.sleep(15)
 
             # make sure to have latest modules.json version
-            self.logger.info('  Updating applications list in Cleep')
+            self.logger.info('  Refreshing markets...')
             resp = requests.post(self.CLEEP_COMMAND_URL, json={
                 'command': 'check_modules_updates',
                 'to': 'update',

{cleepcli-1.40.0 → cleepcli-1.41.0}/cleepcli/docs.py

@@ -190,6 +190,9 @@ if [ $? -ne 0 ]; then echo "Error occured"; exit 1; fi
 
         Args:
             module_name (string): module name
+
+        Returns:
+            object: documentation (json)
         """
         if is_cleep_running():
             return self.__generate_module_docs_by_api_call(module_name)
@@ -215,7 +218,7 @@ if [ $? -ne 0 ]; then echo "Error occured"; exit 1; fi
         self.logger.debug("Resp: %s", resp)
 
         if resp["returncode"] != 0:
-            self.logger.error("Unable to generate %s doc", module_name)
+            self.logger.error("Unable to generate %s doc: %s", module_name, resp)
             raise Exception(f"Error occured generating {module_name} documentation")
 
         return json.loads(''.join(resp["stdout"]))
@@ -341,7 +344,7 @@ if [ $? -ne 0 ]; then echo "Error occured"; exit 1; fi
 
         return True
 
-    def publish_module_docs(self, module_name, module_version, github_token=None, github_owner=None):
+    def publish_module_docs(self, module_name, module_version, github_token=None, github_owner=None, doc_file=None):
         """
         Publish application documentation on specified repo.
         It publish both a tagged version and a latest version
@@ -351,6 +354,7 @@ if [ $? -ne 0 ]; then echo "Error occured"; exit 1; fi
             module_version (str): module version (semver)
             github_token (str): github access token (default None)
             github_owner (str): github repo owner (default None)
+            doc_file (str): doc file path containing existing app documentation
 
         Returns:
             bool: True if publication succeed, False otherwise
@@ -364,7 +368,11 @@ if [ $? -ne 0 ]; then echo "Error occured"; exit 1; fi
         if repo is None:
             raise Exception("Unable to connect to app doc repository")
 
-        documentation = self.generate_module_docs(module_name)
+        if doc_file:
+            with open(doc_file, "r") as doc:
+                documentation = json.load(doc)
+        else:
+            documentation = self.generate_module_docs(module_name)
 
         try:
             # latest doc file

{cleepcli-1.40.0 → cleepcli-1.41.0}/cleepcli/version.py

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

{cleepcli-1.40.0 → cleepcli-1.41.0/cleepcli.egg-info}/PKG-INFO

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