multitool 0.3.2__tar.gz → 0.5.0__tar.gz

{multitool-0.3.2 → multitool-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: multitool
-Version: 0.3.2
+Version: 0.5.0
 Summary: General-purpose command-line interface with plugins support
 Home-page: https://github.com/mdelotavo/multitool
 Author: Matthew Delotavo
@@ -13,7 +13,7 @@ Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3.7
-Requires-Python: >=3.6
+Requires-Python: >=3.7
 License-File: LICENSE
 
 multitool
@@ -25,9 +25,7 @@ Multitool is a general-purpose command-line interface with plugins support.
 Why does this exist?
 --------------------
 
-I built this tool so that I can quickly create and distribute command-line tools for consulting work and personal use.
-
-The plugins manager uses ``git`` to manage plugins installed from remote ``git`` repositories.
+I built this tool so I can quickly create and distribute command-line tools for consulting work and personal use.
 
 -----
 Usage
@@ -49,9 +47,6 @@ Usage
     Commands:
       plugins  Simple plugins manager for distributing commands.
 
-.. ..
-    The plugins features are based off those found in the `apigeecli`_.
-
 ----------------
 Managing plugins
 ----------------
@@ -123,7 +118,7 @@ This will install and update plugins.
 Pruning
 ^^^^^^^
 
-If you specified the ``-a`` option when running ``multitool plugins configure`` then the removal of plugins will occur automatically.
+If you remove plugins from the config file or comment them out, and you then specified the ``-a`` option when running ``multitool plugins configure`` then the removal of plugins will occur automatically.
 Otherwise you can run::
 
      multitool plugins prune
@@ -147,6 +142,17 @@ In order for this to work, the plugin needs to have the ``Requires`` key in the
 
     pip3 install $(multitool plugins show -n PLUGIN_NAME --show-dependencies-only)
 
+^^^^^^^^^^^^^^^
+Troubleshooting
+^^^^^^^^^^^^^^^
+
+If you encounter issues with plugins or commands, you can find more detailed debug information and error messages in the log file:
+::
+
+    ~/.multitool/multitool.log
+
+Reviewing this file can help you diagnose installation problems, missing dependencies, or Git-related errors.
+
 .. ..
     ----------------------------
     Create a virtual environment
@@ -168,7 +174,6 @@ In order for this to work, the plugin needs to have the ``Requires`` key in the
         deactivate
 
 .. _`click`: https://click.palletsprojects.com/
-.. _`apigeecli`: https://pypi.org/project/apigeecli/
 .. _`multitool-plugins`: https://github.com/mdelotavo/multitool-plugins
 .. _`public plugins repository`: https://github.com/mdelotavo/multitool-plugins
 

{multitool-0.3.2 → multitool-0.5.0}/README.rst

@@ -7,9 +7,7 @@ Multitool is a general-purpose command-line interface with plugins support.
 Why does this exist?
 --------------------
 
-I built this tool so that I can quickly create and distribute command-line tools for consulting work and personal use.
-
-The plugins manager uses ``git`` to manage plugins installed from remote ``git`` repositories.
+I built this tool so I can quickly create and distribute command-line tools for consulting work and personal use.
 
 -----
 Usage
@@ -31,9 +29,6 @@ Usage
     Commands:
       plugins  Simple plugins manager for distributing commands.
 
-.. ..
-    The plugins features are based off those found in the `apigeecli`_.
-
 ----------------
 Managing plugins
 ----------------
@@ -105,7 +100,7 @@ This will install and update plugins.
 Pruning
 ^^^^^^^
 
-If you specified the ``-a`` option when running ``multitool plugins configure`` then the removal of plugins will occur automatically.
+If you remove plugins from the config file or comment them out, and you then specified the ``-a`` option when running ``multitool plugins configure`` then the removal of plugins will occur automatically.
 Otherwise you can run::
 
      multitool plugins prune
@@ -129,6 +124,17 @@ In order for this to work, the plugin needs to have the ``Requires`` key in the
 
     pip3 install $(multitool plugins show -n PLUGIN_NAME --show-dependencies-only)
 
+^^^^^^^^^^^^^^^
+Troubleshooting
+^^^^^^^^^^^^^^^
+
+If you encounter issues with plugins or commands, you can find more detailed debug information and error messages in the log file:
+::
+
+    ~/.multitool/multitool.log
+
+Reviewing this file can help you diagnose installation problems, missing dependencies, or Git-related errors.
+
 .. ..
     ----------------------------
     Create a virtual environment
@@ -150,6 +156,5 @@ In order for this to work, the plugin needs to have the ``Requires`` key in the
         deactivate
 
 .. _`click`: https://click.palletsprojects.com/
-.. _`apigeecli`: https://pypi.org/project/apigeecli/
 .. _`multitool-plugins`: https://github.com/mdelotavo/multitool-plugins
 .. _`public plugins repository`: https://github.com/mdelotavo/multitool-plugins

multitool-0.5.0/multitool/__init__.py

@@ -0,0 +1,23 @@
+APP = 'multitool'
+__version__ = '0.5.0'
+description = 'General-purpose command-line interface with plugins support'
+# long_description = 'General-purpose command-line interface with plugins support'
+
+import builtins
+from pathlib import Path
+
+from multitool.utils import join_path_components
+
+MULTITOOL_TOGGLE_SILENT = False
+MULTITOOL_TOGGLE_VERBOSE = 0
+
+MULTITOOL_DIRECTORY = join_path_components(Path.home(), '.multitool')
+
+MULTITOOL_LOG_FILE = join_path_components(MULTITOOL_DIRECTORY, f'{APP}.log')
+
+MULTITOOL_PLUGINS_DIRECTORY = join_path_components(MULTITOOL_DIRECTORY, 'plugins')
+MULTITOOL_PLUGINS_CONFIG_FILE = join_path_components(MULTITOOL_PLUGINS_DIRECTORY, 'config')
+MULTITOOL_PLUGINS_PATH = join_path_components(MULTITOOL_PLUGINS_DIRECTORY, '__init__.py')
+
+builtins.MULTITOOL_TOGGLE_SILENT = MULTITOOL_TOGGLE_SILENT
+builtins.MULTITOOL_TOGGLE_VERBOSE = MULTITOOL_TOGGLE_VERBOSE

{multitool-0.3.2 → multitool-0.5.0}/multitool/__main__.py

@@ -1,27 +1,15 @@
 #!/usr/bin/env python
 # __main__.py
 
-import codecs
-import configparser
-import importlib
-import os
-import re
-import sys
-import time
-from functools import update_wrapper
-
 import click
-import requests
 
-from multitool import (APP, MULTITOOL_LOG_FILE, MULTITOOL_PLUGINS_DIRECTORY,
-                       MULTITOOL_PLUGINS_PATH)
+from multitool import APP, MULTITOOL_LOG_FILE, MULTITOOL_PLUGINS_DIRECTORY
 from multitool import __version__ as version
 from multitool.cls import AliasedGroup
-from multitool.exceptions import exception_handler
+from multitool.exceptions import wrap_with_exception_handling
 from multitool.plugins.commands import plugins
-from multitool.utils import (import_all_modules_in_directory,
-                             run_func_on_dir_files, setup_global_logger,
-                             show_message)
+from multitool.utils import (import_plugins_from_directory,
+                             execute_function_on_directory_files, configure_global_logger)
 
 CONTEXT_SETTINGS = dict(help_option_names=['-h', '--help'])
 
@@ -45,15 +33,15 @@ def cli(ctx):
     ctx.ensure_object(dict)
 
 
-@exception_handler
+@wrap_with_exception_handling
 def main():
-    setup_global_logger(MULTITOOL_LOG_FILE)
+    configure_global_logger(MULTITOOL_LOG_FILE)
 
     cli_commands = {plugins}
 
-    run_func_on_dir_files(
+    execute_function_on_directory_files(
         MULTITOOL_PLUGINS_DIRECTORY,
-        import_all_modules_in_directory,
+        import_plugins_from_directory,
         args=(cli_commands,),
         glob='[!.][!__]*/__init__.py',
     )

{multitool-0.3.2 → multitool-0.5.0}/multitool/cls.py

@@ -11,4 +11,4 @@ class AliasedGroup(click.Group):
             return None
         elif len(matches) == 1:
             return click.Group.get_command(self, ctx, matches[0])
-        ctx.fail('Too many matches: %s' % ', '.join(sorted(matches)))
+        ctx.fail(f'Too many matches: {", ".join(sorted(matches))}')

multitool-0.5.0/multitool/console.py

@@ -0,0 +1,23 @@
+import builtins
+import sys
+
+
+def echo(
+    *message,
+    exit_status=None,
+    make_silent=False,
+    current_verbosity=0,
+    expected_verbosity=0,
+    line_ending="\n",
+    should_flush=False
+):
+    toggle_silent = builtins.MULTITOOL_TOGGLE_SILENT
+    toggle_verbose = builtins.MULTITOOL_TOGGLE_VERBOSE
+    if make_silent or toggle_silent:
+        if exit_status:
+            sys.exit(exit_status)
+        return
+    if current_verbosity or toggle_verbose >= expected_verbosity:
+        print(*message, end=line_ending, flush=should_flush)
+    if exit_status:
+        sys.exit(exit_status)

{multitool-0.3.2 → multitool-0.5.0}/multitool/exceptions.py

@@ -1,13 +1,12 @@
 import functools
 import inspect
-import json
 import logging
 import sys
 
 from multitool import console
 
 
-def exception_handler(func):
+def wrap_with_exception_handling(func):
     @functools.wraps(func)
     def wrapper(*args, **kwargs):
         try:

multitool-0.5.0/multitool/plugins/commands.py

@@ -0,0 +1,266 @@
+import configparser
+import os
+import shutil
+import stat
+import sys
+from os import path
+from pathlib import Path
+
+import click
+from click_option_group import MutuallyExclusiveOptionGroup, optgroup
+
+from multitool import (
+    APP,
+    MULTITOOL_PLUGINS_CONFIG_FILE,
+    MULTITOOL_PLUGINS_DIRECTORY,
+    MULTITOOL_PLUGINS_PATH,
+    console,
+)
+from multitool.silent import common_silent_options
+from multitool.utils import (
+    is_directory,
+    is_regular_file,
+    create_directory,
+    read_file_content,
+    execute_function_on_directory_files,
+    create_empty_file,
+)
+from multitool.verbose import common_verbose_options
+
+
+# ---- Global Variables ----
+plugins_command_help = 'Simple plugins manager for distributing commands.'
+
+# ---- Git Check ----
+is_git_installed = False
+try:
+    from git import Repo
+    is_git_installed = True
+except ImportError:
+    plugins_command_help = (
+    "Simple plugins manager for distributing commands. "
+    "[Warning: Git must be installed to use plugin commands]"
+)
+
+
+# ---- Helper Classes ----
+class FileUtils:
+    """Internal helper class for file/directory operations."""
+
+    @staticmethod
+    def chmod_directory(directory, mode):
+        """Recursively change permissions of a directory and its contents."""
+        for root, dirs, files in os.walk(directory):
+            for d in dirs:
+                os.chmod(path.join(root, d), mode)
+            for f in files:
+                os.chmod(path.join(root, f), mode)
+
+
+class GitUtils:
+    """Internal helper class for Git operations."""
+
+    @staticmethod
+    def exit_if_not_installed():
+        if not is_git_installed:
+            sys.exit(0)
+
+
+class PluginManager:
+    """Internal helper class for MULTITOOL plugin management."""
+
+    @staticmethod
+    def initialize_plugins():
+        create_directory(MULTITOOL_PLUGINS_DIRECTORY)
+        create_empty_file(MULTITOOL_PLUGINS_PATH)
+        create_empty_file(MULTITOOL_PLUGINS_CONFIG_FILE)
+
+    @staticmethod
+    def load_config(config_file=MULTITOOL_PLUGINS_CONFIG_FILE):
+        config = configparser.ConfigParser(allow_no_value=True)
+        config.read(config_file)
+        return config
+
+    @staticmethod
+    def clone_repositories(section="sources"):
+        PluginManager.initialize_plugins()
+        config = PluginManager.load_config()
+        if not config._sections:
+            return
+        sources = dict(config._sections[section])
+        for name, uri in sources.items():
+            dest = Path(MULTITOOL_PLUGINS_DIRECTORY) / name
+            if is_directory(dest):
+                continue
+            try:
+                console.echo(f"Installing {name}... ", line_ending="", should_flush=True)
+                Repo.clone_from(uri, dest)
+                console.echo("Done")
+            except Exception as e:
+                console.echo(e)
+
+    @staticmethod
+    def prune_unused_directories(section="sources"):
+        PluginManager.initialize_plugins()
+        config = PluginManager.load_config()
+        if not config._sections:
+            return
+        sources = dict(config._sections[section])
+
+        def _func(path_):
+            if not is_directory(path_):
+                return
+            name = Path(path_).stem
+            if name in sources:
+                return
+            console.echo(f"Removing {name}... ", line_ending="", should_flush=True)
+            plugin_directory = Path(MULTITOOL_PLUGINS_DIRECTORY) / name
+            try:
+                FileUtils.chmod_directory(str(Path(plugin_directory) / ".git"), stat.S_IRWXU)
+                shutil.rmtree(plugin_directory)
+                console.echo("Done")
+            except Exception as e:
+                console.echo(e)
+
+        return execute_function_on_directory_files(
+            MULTITOOL_PLUGINS_DIRECTORY, _func, glob="[!.][!__]*"
+        )
+
+    @staticmethod
+    def update_repositories():
+        def _func(path_):
+            if not is_directory(path_):
+                return
+            console.echo(f"Updating {Path(path_).stem}... ", line_ending="", should_flush=True)
+            repo = Repo(path_)
+            if repo.bare:
+                return
+            try:
+                repo.remotes["origin"].pull()
+                console.echo("Done")
+            except Exception as e:
+                console.echo(e)
+
+        return execute_function_on_directory_files(
+            MULTITOOL_PLUGINS_DIRECTORY, _func, glob="[!.][!__]*"
+        )
+    
+    @staticmethod
+    def list_sources(section="sources"):
+        """Return a dictionary of plugin sources from config."""
+        config = PluginManager.load_config()
+        return dict(config._sections.get(section, {}))
+
+    @staticmethod
+    def get_plugin_info(name):
+        """Return the parsed plugin info JSON or None if file missing."""
+        info_file = Path(MULTITOOL_PLUGINS_DIRECTORY) / name / f"{APP}-info.json"
+        if not is_regular_file(info_file):
+            return None
+        return read_file_content(info_file, type="json")
+
+    @staticmethod
+    def print_latest_commit(name):
+        """Print the latest Git commit of a plugin repository."""
+        GitUtils.exit_if_not_installed()
+        repo = Repo(Path(MULTITOOL_PLUGINS_DIRECTORY) / name)
+        console.echo(repo.git.log(
+            "--pretty=format:%Cred%h%Creset -%C(yellow)%d%Creset %s "
+            "%Cgreen(%cr) %C(bold blue)<%an>%Creset", "-1"
+        ))
+
+    @staticmethod
+    def print_dependencies(plugins_info):
+        """Print the 'Requires' field from plugin info, if any."""
+        requires = plugins_info.get("Requires")
+        if requires:
+            console.echo(requires)
+
+    @staticmethod
+    def print_full_info(plugins_info):
+        """Print all key/value pairs from plugin info."""
+        for key, value in plugins_info.items():
+            console.echo(f"{key}: {value}")
+
+
+# ---- CLI Commands ----
+@click.group(help=plugins_command_help)
+def plugins():
+    pass
+
+
+@plugins.command(help="Edit config file manually.")
+@common_silent_options
+@common_verbose_options
+@click.option(
+    "-a/-A",
+    "--apply-changes/--no-apply-changes",
+    default=False,
+    help="Install plugins from new sources after exiting the editor.",
+    show_default=True,
+)
+def configure(silent, verbose, apply_changes):
+    GitUtils.exit_if_not_installed()
+    PluginManager.initialize_plugins()
+    click.edit(filename=MULTITOOL_PLUGINS_CONFIG_FILE)
+    if apply_changes:
+        PluginManager.clone_repositories()
+        PluginManager.prune_unused_directories()
+    else:
+        console.echo(f"\n  Run `{APP} plugins update` to apply any changes,")
+        console.echo(f"    or rerun `{APP} plugins configure` with `-a`")
+        console.echo("    to apply changes automatically.\n")
+
+
+@plugins.command(help="Update or install plugins.")
+@common_silent_options
+@common_verbose_options
+def update(silent, verbose, section="sources"):
+    GitUtils.exit_if_not_installed()
+    PluginManager.clone_repositories()
+    PluginManager.update_repositories()
+
+
+@plugins.command(help="Show plugins information.")
+@common_silent_options
+@common_verbose_options
+@click.option("-n", "--name", help="Name of the plugins package")
+@optgroup.group("Filter options", cls=MutuallyExclusiveOptionGroup, help="The filter options")
+@optgroup.option(
+    "--show-commit-only/--no-show-commit-only",
+    default=False,
+    help="Only print latest Git commit log",
+)
+@optgroup.option(
+    "--show-dependencies-only/--no-show-dependencies-only",
+    default=False,
+    help="Only print list of required packages",
+)
+def show(silent, verbose, name, section="sources", show_commit_only=False, show_dependencies_only=False):
+    """Show plugins sources, info, commits, or dependencies based on options."""
+
+    if not name:
+        # List all plugin sources
+        sources = PluginManager.list_sources(section)
+        for plugin_name, uri in sources.items():
+            console.echo(f"{plugin_name}: {uri}")
+        return
+
+    plugins_info = PluginManager.get_plugin_info(name)
+    if not plugins_info:
+        return
+
+    if show_commit_only:
+        PluginManager.print_latest_commit(name)
+    elif show_dependencies_only:
+        PluginManager.print_dependencies(plugins_info)
+    else:
+        PluginManager.print_full_info(plugins_info)
+
+
+@plugins.command(help="Prune plugins with removed sources.")
+@common_silent_options
+@common_verbose_options
+def prune(silent, verbose, section="sources"):
+    GitUtils.exit_if_not_installed()
+    PluginManager.prune_unused_directories()

{multitool-0.3.2 → multitool-0.5.0}/multitool/utils.py

@@ -10,38 +10,76 @@ from pathlib import Path
 import click
 
 
-def gen_path_str(*args):
-    if not args:
-        return
-    path = None
-    for arg in args:
-        if not path:
-            path = Path(arg)
-        else:
-            path /= arg
-    return str(path)
+def apply_function_on_iterable(iterable, func, state_op="append", args=(), kwargs=None):
+    if kwargs is None:
+        kwargs = {}
+    state = []
+    for item in iterable:
+        _tuple = (item,)
+        result = func(*(_tuple + args), **kwargs)
+        if result:
+            getattr(state, state_op)(result)
+    return state
 
 
-def is_dir(d):
-    return os.path.isdir(d)
+def configure_global_logger(log_file):
+    create_empty_file(log_file)
+    remove_file_if_above_size(log_file, size_kb=1000)
+    logging.basicConfig(
+        filename=log_file,
+        level=logging.WARNING,
+        format="%(asctime)s - %(name)s - %(levelname)s - %(message)s",
+    )
 
 
-def is_envvar_true(value):
-    return value in (True, 'True', 'true', '1')
+def create_empty_file(path):
+    try:
+        create_directory(os.path.split(path)[0])
+        if not os.path.exists(path):
+            with open(path, "x"):
+                os.utime(path, None)
+    except FileExistsError:
+        logging.warning(f"{inspect.stack()[0][3]}; will ignore FileExistsError")
 
 
-def is_file(f):
-    return os.path.isfile(f)
+def create_directory(path):
+    if not path:
+        return
+    if not os.path.exists(path):
+        try:
+            os.makedirs(path)
+        except FileExistsError:
+            logging.warning(f"{inspect.stack()[0][3]}; will ignore FileExistsError")
+
 
+def execute_function_on_directory_files(dir, func, glob="**/*", args=(), kwargs=None):
+    if kwargs is None:
+        kwargs = {}
+    state = []
+    for file_path in Path(get_resolved_directory_path(dir)).resolve().glob(glob):
+        _tuple = (str(file_path),)
+        result = func(*(_tuple + args), **kwargs)
+        if result:
+            state.append(result)
+    return state
 
-def import_all_modules_in_directory(plugins_init_file, existing_commands):
+
+def get_resolved_directory_path(target_directory=None):
+    if target_directory:
+        if not os.path.exists(target_directory):
+            os.makedirs(target_directory)
+        return str(Path(target_directory).resolve())
+    return os.getcwd()
+
+
+def import_plugins_from_directory(plugins_init_file, existing_commands):
     try:
         spec = importlib.util.spec_from_file_location('plugins_modules', plugins_init_file)
         module = importlib.util.module_from_spec(spec)
         sys.modules[spec.name] = module
         spec.loader.exec_module(module)
-        import plugins_modules
-        from plugins_modules import __all__ as all_plugins_modules
+        import plugins_modules # type: ignore
+        from plugins_modules import __all__ as all_plugins_modules # type: ignore
 
         for module in all_plugins_modules:
             _module = getattr(plugins_modules, module)
@@ -53,73 +91,39 @@ def import_all_modules_in_directory(plugins_init_file, existing_commands):
         )
 
 
-def make_dirs(path):
-    if not os.path.exists(path):
-        try:
-            os.makedirs(path)
-        except FileExistsError:
-            logging.warning(f'{inspect.stack()[0][3]}; will ignore FileExistsError')
+def is_directory(d):
+    return os.path.isdir(d)
 
 
-def read_file(file, type='text'):
-    with open(file, 'r') as f:
-        if type == 'json':
-            return json.loads(f.read())
-        return f.read()
+def is_regular_file(f):
+    return os.path.isfile(f)
 
 
-def remove_file_above_size(file, size_kb=100):
-    if os.path.getsize(file) > size_kb * 1024:
-        os.remove(file)
+def is_truthy_envvar(value):
+    return value in (True, "True", "true", "1")
 
 
-def resolve_target_directory(target_directory=None):
-    if target_directory:
-        if not os.path.exists(target_directory):
-            os.makedirs(target_directory)
-        return str(Path(target_directory).resolve())
-    return os.getcwd()
-
-
-def run_func_on_dir_files(dir, func, glob='**/*', args=(), kwargs={}):
-    state = []
-    for file_path in Path(resolve_target_directory(dir)).resolve().glob(glob):
-        _tuple = (str(file_path),)
-        result = func(*(_tuple + args), **kwargs)
-        if result:
-            state.append(result)
-    return state
+def join_path_components(*components):
+    if not components:
+        return
+    path = None
+    for component in components:
+        if not path:
+            path = Path(component)
+        else:
+            path /= component
+    return str(path)
 
 
-def run_func_on_iterable(iterable, func, state_op='append', args=(), kwargs={}):
-    state = []
-    for item in iterable:
-        _tuple = (item,)
-        result = func(*(_tuple + args), **kwargs)
-        if result:
-            getattr(state, state_op)(result)
-    return state
+def read_file_content(file, type="text"):
+    with open(file, "r") as f:
+        return json.loads(f.read()) if type == "json" else f.read()
 
 
-def setup_global_logger(log_file):
-    touch(log_file)
-    logging.basicConfig(
-        filename=log_file,
-        level=logging.DEBUG,
-        format='%(asctime)s - %(name)s - %(levelname)s - %(message)s',
-    )
-    remove_file_above_size(log_file, size_kb=1000)
+def remove_file_if_above_size(file, size_kb=100):
+    if os.path.getsize(file) > size_kb * 1024:
+        os.remove(file)
 
 
 def show_message(msg):
     print(msg)
-
-
-def touch(path):
-    try:
-        make_dirs(os.path.split(path)[0])
-        if not os.path.exists(path):
-            with open(path, 'x'):
-                os.utime(path, None)
-    except FileExistsError:
-        logging.warning(f'{inspect.stack()[0][3]}; will ignore FileExistsError')

{multitool-0.3.2 → multitool-0.5.0}/multitool/verbose.py

@@ -3,7 +3,6 @@ import http.client as http_client
 import logging
 
 import click
-import requests
 
 
 def verbose_callback(ctx, param, value):

{multitool-0.3.2 → multitool-0.5.0}/multitool.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: multitool
-Version: 0.3.2
+Version: 0.5.0
 Summary: General-purpose command-line interface with plugins support
 Home-page: https://github.com/mdelotavo/multitool
 Author: Matthew Delotavo
@@ -13,7 +13,7 @@ Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3.7
-Requires-Python: >=3.6
+Requires-Python: >=3.7
 License-File: LICENSE
 
 multitool
@@ -25,9 +25,7 @@ Multitool is a general-purpose command-line interface with plugins support.
 Why does this exist?
 --------------------
 
-I built this tool so that I can quickly create and distribute command-line tools for consulting work and personal use.
-
-The plugins manager uses ``git`` to manage plugins installed from remote ``git`` repositories.
+I built this tool so I can quickly create and distribute command-line tools for consulting work and personal use.
 
 -----
 Usage
@@ -49,9 +47,6 @@ Usage
     Commands:
       plugins  Simple plugins manager for distributing commands.
 
-.. ..
-    The plugins features are based off those found in the `apigeecli`_.
-
 ----------------
 Managing plugins
 ----------------
@@ -123,7 +118,7 @@ This will install and update plugins.
 Pruning
 ^^^^^^^
 
-If you specified the ``-a`` option when running ``multitool plugins configure`` then the removal of plugins will occur automatically.
+If you remove plugins from the config file or comment them out, and you then specified the ``-a`` option when running ``multitool plugins configure`` then the removal of plugins will occur automatically.
 Otherwise you can run::
 
      multitool plugins prune
@@ -147,6 +142,17 @@ In order for this to work, the plugin needs to have the ``Requires`` key in the
 
     pip3 install $(multitool plugins show -n PLUGIN_NAME --show-dependencies-only)
 
+^^^^^^^^^^^^^^^
+Troubleshooting
+^^^^^^^^^^^^^^^
+
+If you encounter issues with plugins or commands, you can find more detailed debug information and error messages in the log file:
+::
+
+    ~/.multitool/multitool.log
+
+Reviewing this file can help you diagnose installation problems, missing dependencies, or Git-related errors.
+
 .. ..
     ----------------------------
     Create a virtual environment
@@ -168,7 +174,6 @@ In order for this to work, the plugin needs to have the ``Requires`` key in the
         deactivate
 
 .. _`click`: https://click.palletsprojects.com/
-.. _`apigeecli`: https://pypi.org/project/apigeecli/
 .. _`multitool-plugins`: https://github.com/mdelotavo/multitool-plugins
 .. _`public plugins repository`: https://github.com/mdelotavo/multitool-plugins
 

multitool-0.5.0/multitool.egg-info/requires.txt

@@ -0,0 +1,4 @@
+click-aliases>=1.0.1
+click-option-group>=0.5.5
+click>=8.1.3
+gitpython>=3.1.30

{multitool-0.3.2 → multitool-0.5.0}/setup.py

@@ -1,4 +1,4 @@
-import os, sys, re
+import os
 
 from multitool import APP
 from multitool import __version__ as version
@@ -25,27 +25,18 @@ SETUP_ARGS = dict(
         'Operating System :: OS Independent',
         'Programming Language :: Python :: 3.7',
     ],
-    # py_modules = ['multitool',],
-    # entry_points='''
-    #     [console_scripts]
-    #     multitool=multitool.__main__:cli
-    # ''',
-    entry_points={'console_scripts': ['multitool=multitool.__main__:main']},
+    entry_points = {
+        'console_scripts': [
+            'multitool=multitool.__main__:main'
+        ]
+    },
     install_requires = [
-        'requests>=2.22',
-        'click',
-        'click-aliases',
-        'click-option-group',
-        'colorama',
-        'pyotp',
-        'requests',
-        'tqdm',
-        'tabulate',
-        'pyjwt',
-        'python-gnupg>=0.3.5',
-        'gitpython'
+        'click>=8.1.3',
+        'click-aliases>=1.0.1',
+        'click-option-group>=0.5.5',
+        'gitpython>=3.1.30'
     ],
-    python_requires=">=3.6",
+    python_requires=">=3.7",
 )
 
 if __name__ == '__main__':

multitool-0.3.2/multitool/__init__.py

@@ -1,23 +0,0 @@
-APP = 'multitool'
-__version__ = '0.3.2'
-description = 'General-purpose command-line interface with plugins support'
-# long_description = 'General-purpose command-line interface with plugins support'
-
-import builtins
-from pathlib import Path
-
-from multitool.utils import gen_path_str
-
-MULTITOOL_TOGGLE_SILENT = False
-MULTITOOL_TOGGLE_VERBOSE = 0
-
-MULTITOOL_DIRECTORY = gen_path_str(Path.home(), '.multitool')
-
-MULTITOOL_LOG_FILE = gen_path_str(MULTITOOL_DIRECTORY, f'{APP}.log')
-
-MULTITOOL_PLUGINS_DIRECTORY = gen_path_str(MULTITOOL_DIRECTORY, 'plugins')
-MULTITOOL_PLUGINS_CONFIG_FILE = gen_path_str(MULTITOOL_PLUGINS_DIRECTORY, 'config')
-MULTITOOL_PLUGINS_PATH = gen_path_str(MULTITOOL_PLUGINS_DIRECTORY, '__init__.py')
-
-builtins.MULTITOOL_TOGGLE_SILENT = MULTITOOL_TOGGLE_SILENT
-builtins.MULTITOOL_TOGGLE_VERBOSE = MULTITOOL_TOGGLE_VERBOSE

multitool-0.3.2/multitool/console.py

@@ -1,17 +0,0 @@
-import builtins
-import sys
-
-
-def echo(
-    *message, status=None, silent=False, curr_verbosity=0, expc_verbosity=0, end='\n', flush=False
-):
-    toggle_silent = builtins.MULTITOOL_TOGGLE_SILENT
-    toggle_verbose = builtins.MULTITOOL_TOGGLE_VERBOSE
-    if silent or toggle_silent:
-        if status:
-            sys.exit(status)
-        return
-    if curr_verbosity or toggle_verbose >= expc_verbosity:
-        print(*message, end=end, flush=flush)
-    if status:
-        sys.exit(status)

multitool-0.3.2/multitool/plugins/commands.py

@@ -1,231 +0,0 @@
-import configparser
-import json
-import os
-import shutil
-import stat
-import sys
-from os import path
-from pathlib import Path
-
-import click
-from click_option_group import MutuallyExclusiveOptionGroup, optgroup
-
-from multitool import (MULTITOOL_PLUGINS_CONFIG_FILE,
-                       MULTITOOL_PLUGINS_DIRECTORY, MULTITOOL_PLUGINS_PATH,
-                       console)
-from multitool.silent import common_silent_options
-from multitool.utils import (is_dir, is_file, make_dirs, read_file,
-                             run_func_on_dir_files, touch)
-from multitool.verbose import common_verbose_options
-
-is_git_installed = False
-plugins_command_help = 'Simple plugins manager for distributing commands.'
-
-try:
-    import git
-    from git import Git, Repo
-
-    is_git_installed = True
-except ImportError:
-    plugins_command_help = '[Git not found! Please install Git first.] Simple plugins manager for distributing commands. This command requires Git to be installed.'
-
-
-def exit_if_git_not_installed():
-    if not is_git_installed:
-        sys.exit(0)
-
-
-@click.group(help=plugins_command_help)
-def plugins():
-    pass
-
-
-def init():
-    make_dirs(MULTITOOL_PLUGINS_DIRECTORY)
-    touch(MULTITOOL_PLUGINS_PATH)
-    touch(MULTITOOL_PLUGINS_CONFIG_FILE)
-
-
-def load_config(config_file=MULTITOOL_PLUGINS_CONFIG_FILE):
-    config = configparser.ConfigParser(allow_no_value=True)
-    config.read(config_file)
-    return config
-
-
-def save_config(plugins_file, config_file, section='sources'):
-    init()
-    config = load_config()
-    if not config._sections:
-        return
-
-
-def clone_all(section='sources'):
-    init()
-    config = load_config()
-    if not config._sections:
-        return
-    sources = dict(config._sections[section])
-    for name, uri in sources.items():
-        dest = Path(MULTITOOL_PLUGINS_DIRECTORY) / name
-        if is_dir(dest):
-            continue
-        try:
-            console.echo(f'Installing {name}... ', end='', flush=True)
-            Repo.clone_from(uri, dest)
-            console.echo('Done')
-        except Exception as e:
-            console.echo(e)
-
-
-def pull_all():
-    def _func(path):
-        if not is_dir(path):
-            return
-        console.echo(f'Updating {Path(path).stem}... ', end='', flush=True)
-        repo = Repo(path)
-        if repo.bare:
-            return
-        try:
-            repo.remotes['origin'].pull()
-            console.echo('Done')
-        except Exception as e:
-            console.echo(e)
-
-    return run_func_on_dir_files(MULTITOOL_PLUGINS_DIRECTORY, _func, glob='[!.][!__]*')
-
-
-@plugins.command(help='Edit config file manually.')
-@common_silent_options
-@common_verbose_options
-@click.option(
-    '-a/-A',
-    '--apply-changes/--no-apply-changes',
-    default=False,
-    help='Install plugins from new sources after exiting the editor.',
-    show_default=True,
-)
-def configure(silent, verbose, apply_changes):
-    exit_if_git_not_installed()
-    init()
-    click.edit(filename=MULTITOOL_PLUGINS_CONFIG_FILE)
-    if apply_changes:
-        clone_all()
-        prune_all()
-    else:
-        console.echo('\n  Run `multitool plugins update` to apply any changes,')
-        console.echo('    or rerun `multitool plugins configure` with `-a`')
-        console.echo('    to apply changes automatically.\n')
-
-
-def install():
-    pass
-
-
-@plugins.command(help='Update or install plugins.')
-@common_silent_options
-@common_verbose_options
-def update(silent, verbose, section='sources'):
-    exit_if_git_not_installed()
-    clone_all()
-    pull_all()
-
-
-@plugins.command(help='Show plugins information.')
-@common_silent_options
-@common_verbose_options
-@click.option('-n', '--name', help='name of the plugins package')
-@optgroup.group('Filter options', cls=MutuallyExclusiveOptionGroup, help='The filter options')
-@optgroup.option(
-    '--show-commit-only/--no-show-commit-only',
-    default=False,
-    help='only print latest Git commit log',
-)
-@optgroup.option(
-    '--show-dependencies-only/--no-show-dependencies-only',
-    default=False,
-    help='only print list of required packages',
-)
-def show(
-    silent, verbose, name, section='sources', show_commit_only=False, show_dependencies_only=False
-):
-    if not name:
-        config = load_config()
-        if not config._sections:
-            return
-        sources = dict(config._sections[section])
-        for name, uri in sources.items():
-            console.echo(f'{name}: {uri}')
-        return
-    plugins_info_file = Path(MULTITOOL_PLUGINS_DIRECTORY) / name / 'multitool-info.json'
-    if not is_file(plugins_info_file):
-        return
-    plugins_info = read_file(plugins_info_file, type='json')
-    if show_commit_only:
-        exit_if_git_not_installed()
-        console.echo(
-            Repo(Path(MULTITOOL_PLUGINS_DIRECTORY) / name).git.log(
-                '--pretty=format:%Cred%h%Creset -%C(yellow)%d%Creset %s %Cgreen(%cr) %C(bold blue)<%an>%Creset',
-                '-1',
-            )
-        )
-        return
-    if show_dependencies_only:
-        if plugins_info.get('Requires'):
-            console.echo(plugins_info.get('Requires'))
-        return
-    for k, v in plugins_info.items():
-        console.echo(f'{k}: {v}')
-
-
-def info():
-    pass
-
-
-def chmod_directory(directory, mode):
-    """https://stackoverflow.com/a/58878271"""
-    for root, dirs, files in os.walk(directory):
-        for dir in dirs:
-            os.chmod(path.join(root, dir), mode)
-        for file in files:
-            os.chmod(path.join(root, file), mode)
-
-
-def prune_all(section='sources'):
-    init()
-    config = load_config()
-    if not config._sections:
-        return
-    sources = dict(config._sections[section])
-
-    def _func(path):
-        if not is_dir(path):
-            return
-        name = Path(path).stem
-        if name in sources.keys():
-            return
-        console.echo(f'Removing {name}... ', end='', flush=True)
-        plugin_directory = Path(MULTITOOL_PLUGINS_DIRECTORY) / name
-        try:
-            chmod_directory(str(Path(plugin_directory) / '.git'), stat.S_IRWXU)
-            shutil.rmtree(plugin_directory)
-            console.echo('Done')
-        except Exception as e:
-            console.echo(e)
-
-    return run_func_on_dir_files(MULTITOOL_PLUGINS_DIRECTORY, _func, glob='[!.][!__]*')
-
-
-@plugins.command(help='Prune plugins with removed sources.')
-@common_silent_options
-@common_verbose_options
-def prune(silent, verbose, section='sources'):
-    exit_if_git_not_installed()
-    prune_all()
-
-
-def uninstall():
-    pass
-
-
-def clean():
-    pass

multitool-0.3.2/multitool.egg-info/requires.txt

@@ -1,12 +0,0 @@
-requests>=2.22
-click
-click-aliases
-click-option-group
-colorama
-pyotp
-requests
-tqdm
-tabulate
-pyjwt
-python-gnupg>=0.3.5
-gitpython