Added cli4 -e option to display example file path names

Author: mahtin

README.md

@@ -500,6 +500,34 @@ $
 
 The [examples](https://github.com/cloudflare/python-cloudflare/tree/master/examples) folder contains many examples in both simple and verbose formats.
 
+You can see the installed path of these files directly via `cli4 -e` command.
+
+```bash
+$ cli4 -e
+Python .py files:
+	...
+	/opt/homebrew/lib/python3.11/site-packages/examples/example_always_use_https.py
+	...
+Bash .sh files:
+	...
+	/opt/homebrew/lib/python3.11/site-packages/examples/example_paging_thru_zones.sh
+	...
+$
+```
+
+The exact path will vary depending on your system.
+The above example is MacOS and Python 3.9 hence the `/opt/homebrew/lib/python3.11/site-packages/` path.
+One Linux, the Python pip command may install the code is a system location like `/usr/lib/python3/dist-packages` or `~/.local/lib/python3.9/site-packages/` or something different.
+The `cli4 -e` command will try to decode the location and display the example files.
+
+If you are running release before Python 3.9 then you will be asked to install the following:
+
+```bash
+$ pip install importlib_resources
+...
+$
+```
+
 ## A DNS zone code example
 
 ```python

cli4/cli4.py

@@ -13,6 +13,7 @@
 import CloudFlare
 from .dump import dump_commands, dump_commands_from_web
 from . import converters
+from . import examples
 
 def load_and_check_yaml():
     """ load_and_check_yaml() """
@@ -365,6 +366,7 @@ def do_it(args):
 
     verbose = False
     output = 'json'
+    example = False
     raw = False
     dump = False
     openapi_url = None
@@ -374,6 +376,7 @@ def do_it(args):
 
     usage = ('usage: cli4 '
              + '[-V|--version] [-h|--help] [-v|--verbose] [-q|--quiet] '
+             + '[-e|--examples] '
              + '[-j|--json] [-y|--yaml] [-n|ndjson] '
              + '[-r|--raw] '
              + '[-d|--dump] '
@@ -386,10 +389,10 @@ def do_it(args):
 
     try:
         opts, args = getopt.getopt(args,
-                                   'VhvqjyrdA:bp:GPOUD',
+                                   'VhvqejyrdA:bp:GPOUD',
                                    [
                                        'version',
-                                       'help', 'verbose', 'quiet', 'json', 'yaml', 'ndjson',
+                                       'help', 'verbose', 'quiet', 'examples', 'json', 'yaml', 'ndjson',
                                        'raw',
                                        'dump', 'openapi=',
                                        'binary',
@@ -407,6 +410,8 @@ def do_it(args):
             verbose = True
         elif opt in ('-q', '--quiet'):
             output = None
+        elif opt in ('-e', '--examples'):
+            example = True
         elif opt in ('-j', '--json'):
             output = 'json'
         elif opt in ('-y', '--yaml'):
@@ -440,6 +445,13 @@ def do_it(args):
         elif opt in ('-D', '--delete'):
             method = 'DELETE'
 
+    if example:
+        try:
+            examples.display()
+        except ModuleNotFoundError as e:
+            sys.exit(e)
+        sys.exit(0)
+
     try:
         cf = CloudFlare.CloudFlare(debug=verbose, raw=raw, profile=profile)
     except Exception as e:

cli4/examples.py

@@ -0,0 +1,39 @@
+"""Cloudflare API via command line"""
+
+import os
+import sys
+
+if sys.version_info < (3, 9):
+    # importlib.resources either doesn't exist or lacks the files()
+    # function, so use the PyPI version:
+    try:
+        import importlib_resources
+    except ModuleNotFoundError as e:
+        importlib_resources = None
+else:
+    # importlib.resources has files(), so use that:
+    import importlib.resources as importlib_resources
+
+examples_package_name = 'examples'
+
+def display():
+    """ display() """
+
+    if not importlib_resources:
+        raise ModuleNotFoundError('Module "importlib_resources" missing - please "pip install importlib_resources" as your Python version is lower than 3.9')
+
+    try:
+        pkg = importlib_resources.files(examples_package_name)
+    except ModuleNotFoundError as e:
+        raise e
+
+    for ext,name in {'c': 'C', 'h': 'C', 'cc': 'C++', 'py':'Python', 'sh':'Bash', 'awk':'AWK'}.items():
+        l = sorted(pkg.glob('**/*.' + ext))
+        if len(l) == 0:
+            continue
+        print('%s .%s files:' % (name, ext))
+        for f in sorted(pkg.glob('**/*.' + ext)):
+            if '__init__.py' in os.fspath(f):
+                continue
+            print('\t%s' % (os.fspath(f)))
+