Normalize CLI options

Fix doc strings
Fix command parameters processing

Author: const-cloudinary

cloudinary_cli/cli.py

@@ -1,4 +1,5 @@
 #!/usr/bin/env python3
+import platform
 import shutil
 import sys
 
@@ -13,11 +14,17 @@
 from cloudinary_cli.utils.config_utils import initialize, load_config, refresh_cloudinary_config, \
     is_valid_cloudinary_config
 from cloudinary_cli.utils.utils import log_exception, ConfigurationError
+from cloudinary_cli.version import __version__ as cli_version
 
 CONTEXT_SETTINGS = dict(max_content_width=shutil.get_terminal_size()[0], terminal_width=shutil.get_terminal_size()[0])
 
 
 @click.group(context_settings=CONTEXT_SETTINGS)
+@click.help_option()
+@click.version_option(cli_version, prog_name="Cloudinary CLI",
+                      message=f"%(prog)s, version %(version)s\n"
+                              f"Cloudinary SDK, version {cloudinary.VERSION}\n"
+                              f"Python, version {platform.python_version()}")
 @click.option("-c", "--config",
               help="""Tell the CLI which account to run the command on by specifying an account environment variable."""
               )

cloudinary_cli/core/search.py

@@ -1,7 +1,5 @@
-from webbrowser import open as open_url
-
 import cloudinary
-from click import command, argument, option
+from click import command, argument, option, launch
 
 from cloudinary_cli.defaults import logger
 from cloudinary_cli.utils.json_utils import write_json_to_file, print_json
@@ -35,7 +33,7 @@
 def search(query, with_field, sort_by, aggregate, max_results, next_cursor,
            auto_paginate, force, filter_fields, json, csv, doc):
     if doc:
-        return open_url("https://cloudinary.com/documentation/search_api")
+        return launch("https://cloudinary.com/documentation/search_api")
 
     fields_to_keep = []
     if filter_fields:

cloudinary_cli/core/uploader.py

@@ -13,7 +13,7 @@
 \b
 Run any methods that can be called through the upload API.
 Format: cld <cli options> uploader <command options> <method> <method parameters>
-\te.g. cld uploader upload http://res.cloudinary.com/demo/image/upload/sample public_id=flowers invalidate=True
+\te.g. cld uploader upload https://res.cloudinary.com/demo/image/upload/sample public_id=flowers invalidate=True
 \b
 \te.g. cld uploader rename flowers secret_flowers to_type=private
 \t      OR

cloudinary_cli/core/utils.py

@@ -1,11 +1,9 @@
-from webbrowser import open as open_url
-
-from click import command, argument, option, Choice, echo
+from click import command, argument, option, Choice, echo, launch
 from cloudinary import utils as cld_utils
 
 from cloudinary_cli.core.overrides import cloudinary_url
 from cloudinary_cli.utils.api_utils import handle_command
-from cloudinary_cli.utils.utils import print_help
+from cloudinary_cli.utils.utils import print_api_help
 
 cld_utils.cloudinary_url = cloudinary_url
 
@@ -22,7 +20,7 @@
 @option("-ls", "--ls", is_flag=True, help="List all available utility methods.")
 def utils(params, optional_parameter, optional_parameter_parsed, ls):
     if ls or len(params) < 1:
-        return print_help(cld_utils, allow_list=utils_list)
+        return print_api_help(cld_utils, allow_list=utils_list)
 
     echo(handle_command(params, optional_parameter, optional_parameter_parsed, cld_utils, "Utils"))
 
@@ -47,4 +45,4 @@ def url(public_id, transformation, resource_type, delivery_type, open_in_browser
     echo(res)
 
     if open_in_browser:
-        open_url(res)
+        launch(res)

cloudinary_cli/modules/make.py

@@ -1,22 +1,55 @@
-from click import command, argument, echo
+import os
 
-from cloudinary_cli.defaults import TEMPLATE_EXTS
-from cloudinary_cli.utils.utils import load_template
+from click import command, argument, echo, option
+
+from cloudinary_cli.defaults import TEMPLATE_EXTS, TEMPLATE_FOLDER
+from cloudinary_cli.utils.utils import load_template, print_help_and_exit
 
 
 @command("make", short_help="Return template code for implementing the specified Cloudinary widget.",
          help="""\b
 Return template code for implementing the specified Cloudinary widget.
-e.g. cld make product_gallery
+e.g. cld make media library widget
+     cld make python find all empty folders
 """)
 @argument("template", nargs=-1)
-def make(template):
-    language = "html"
+@option("-ll", "--list-languages", is_flag=True, help="List available languages.")
+@option("-lt", "--list-templates", is_flag=True, help="List available templates.")
+def make(template, list_languages, list_templates):
+    if not any([template, list_languages, list_templates]):
+        print_help_and_exit()
+
+    if list_languages:
+        echo("Available languages")
+        with os.scandir(TEMPLATE_FOLDER) as languages:
+            for tpl_language in languages:
+                if tpl_language.is_dir():
+                    echo(tpl_language.name)
+        return True
+
+    language, template = _handle_language_and_template(template)
+
+    if list_templates:
+        echo(f"Available templates for language: {language}")
+        with os.scandir(os.path.join(TEMPLATE_FOLDER, language)) as templates:
+            for template_file in templates:
+                if template_file.is_file():
+                    echo(template_file.name.replace("_", " "))
+        return True
+
+    echo(load_template(language, '_'.join(template)))
+
+
+def _handle_language_and_template(language_and_template):
+    language = "html"  # default language, in case not specified
+
+    if not language_and_template:
+        return language, language_and_template
+
+    template = list(language_and_template)
     if template[-1] in TEMPLATE_EXTS.keys():
-        language = template[-1]
-        template = template[:-1]
+        language = template.pop()
     elif template[0] in TEMPLATE_EXTS.keys():
-        language = template[0]
-        template = template[1:]
+        language = template.pop(0)
 
-    echo(load_template(language, '_'.join(template)))
+    return language, template

cloudinary_cli/modules/sync.py

@@ -79,12 +79,12 @@ def __init__(self, local_dir, remote_dir, include_hidden, concurrent_workers, fo
         Cloudinary is a very permissive service. When uploading files that contain invalid characters, 
         unicode characters, etc, Cloudinary does the best effort to store those files. 
         
-        Usually Cloudinary sanitizes those file names and strips invalid characters. Although it is good best effort for
-        a general use case, when syncing local folder with Cloudinary, it is not the best option, since directories will
-        be always out-of-sync.
+        Usually Cloudinary sanitizes those file names and strips invalid characters. Although it is a good best effort 
+        for a general use case, when syncing local folder with Cloudinary, it is not the best option, since directories 
+        will be always out-of-sync.
          
         To overcome this limitation, cloudinary-cli keeps .cld-sync hidden file in the sync directory that contains a 
-        mapping of the diverse file names. This file keeps tracking on the files and allows syncing in both directions.
+        mapping of the diverse file names. This file keeps tracking of the files and allows syncing in both directions.
         """
         diverse_file_names = read_json_from_file(self.sync_meta_file, does_not_exist_ok=True)
         self.diverse_file_names = dict(

cloudinary_cli/modules/upload_dir.py

@@ -21,7 +21,7 @@
              "You can specify a whole path, for example folder1/folder2/folder3. "
              "Any folders that do not exist are automatically created.")
 @option("-p", "--preset", help="The upload preset to use.")
-@option("-w", "--concurrent_workers", type=int, default=30, help="Specify number of concurrent network threads.")
+@option("-w", "--concurrent_workers", type=int, default=30, help="Specify the number of concurrent network threads.")
 def upload_dir(directory, optional_parameter, optional_parameter_parsed, transformation, folder, preset,
                concurrent_workers):
     items, skipped = {}, {}

cloudinary_cli/samples/__init__.py

@@ -1,7 +1,5 @@
-from webbrowser import open as open_url
-
 import cloudinary
-from click import command, argument, option
+from click import command, argument, option, launch
 from cloudinary.utils import cloudinary_url
 
 
@@ -31,7 +29,7 @@ def _handle_sample_command(source, transformation=None, open_in_browser=False, r
     res = cloudinary_url(source, raw_transformation=transformation, resource_type=resource_type)
     print(res)
     if open_in_browser:
-        open_url(res)
+        launch(res)
 
 
 commands = [

cloudinary_cli/templates/python/explicit

@@ -3,9 +3,9 @@
 {% block content %}
 from cloudinary import uploader
 
-res = uploader.explcit("sample", **{
+res = uploader.explicit("sample", **{
     "eager": "w_2000"
 })
 
 print(res)
-{% endblock %}
+{% endblock %}

cloudinary_cli/utils/api_utils.py

@@ -1,19 +1,17 @@
 import logging
 from os import path, makedirs
-from webbrowser import open as open_url
 
-import cloudinary
 import requests
-from click import style
+from click import style, launch
 from cloudinary import Search, uploader
 from cloudinary.utils import cloudinary_url
 
 from cloudinary_cli.defaults import logger
+from cloudinary_cli.utils.config_utils import is_valid_cloudinary_config
 from cloudinary_cli.utils.file_utils import normalize_file_extension, posix_rel_path
 from cloudinary_cli.utils.json_utils import print_json, write_json_to_file
-from cloudinary_cli.utils.utils import print_help, log_exception, confirm_action, \
-    get_command_params, merge_responses, normalize_list_params, ConfigurationError
-from cloudinary_cli.utils.config_utils import is_valid_cloudinary_config
+from cloudinary_cli.utils.utils import log_exception, confirm_action, get_command_params, merge_responses, \
+    normalize_list_params, ConfigurationError, print_api_help
 
 PAGINATION_MAX_RESULTS = 500
 
@@ -154,10 +152,10 @@ def handle_api_command(
     Used by Admin and Upload API commands
     """
     if doc:
-        return open_url(doc_url)
+        return launch(doc_url)
 
     if ls or len(params) < 1:
-        return print_help(api_instance)
+        return print_api_help(api_instance)
 
     func, args, kwargs = get_command_params(
         params,