multitool 0.7.2__tar.gz → 0.8.0__tar.gz

{multitool-0.7.2 → multitool-0.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: multitool
-Version: 0.7.2
+Version: 0.8.0
 Summary: Create and run plugin-based command-line tools.
 Author-email: Matthew Delotavo <matthew.t.delotavo@gmail.com>
 License-Expression: MIT
@@ -19,6 +19,7 @@ Requires-Dist: click>=8.1.3
 Requires-Dist: click-aliases>=1.0.1
 Requires-Dist: click-option-group>=0.5.5
 Requires-Dist: GitPython>=3.1.30
+Requires-Dist: packaging>=26.2
 Dynamic: license-file
 
 multitool
@@ -51,8 +52,7 @@ Run the example command::
         -vv \
         --enabled \
         --tag alpha \
-        --tag beta \
-        --output result.json
+        --tag beta
 
 Edit the generated source code::
 
@@ -147,10 +147,18 @@ Configuring
 
 Configure plugin repositories with::
 
-    multitool plugins configure -a
+    multitool plugins configure
+
+This opens your editor to modify the plugin configuration. After saving your
+changes, apply them with::
+
+    multitool plugins update
+
+To automatically apply the configuration changes after saving and closing the
+file (install new plugins, update existing plugins, and prune removed plugins),
+use::
 
-This opens your editor to modify the plugin configuration. Omit ``-a`` if you
-don't want changes applied automatically.
+    multitool plugins configure -a
 
 Example configuration::
 
@@ -172,11 +180,11 @@ Install the example plugins::
     echo -e '[sources]\nmdelotavo-multitool-plugins = https://github.com/mdelotavo/multitool-plugins.git' >> ~/.multitool/plugins/config
 
     multitool plugins update
+    
     multitool plugins show
     multitool plugins show -n mdelotavo-multitool-plugins
     multitool plugins show -n mdelotavo-multitool-plugins --show-commit-only
     multitool plugins show -n mdelotavo-multitool-plugins --show-dependencies-only
-    pip3 install $(multitool plugins show -n mdelotavo-multitool-plugins --show-dependencies-only)
 
     multitool run examples -h
 
@@ -184,10 +192,57 @@ Install the example plugins::
 Updating
 ^^^^^^^^
 
-Install new plugins and update existing ones::
+Install new plugins, update existing ones, and automatically install any Python
+dependencies declared in the Requires field of the plugin's
+multitool-info.json file::
 
     multitool plugins update
 
+Update a specific plugin only::
+
+    multitool plugins update -n PLUGIN_NAME
+
+The Requires field is where a plugin declares the Python packages it
+depends on. Any packages listed will be installed automatically when
+multitool plugins update is run. For example::
+
+  {
+    "Homepage": "",
+    "Requires": "click>=8.1.3 click-aliases>=1.0.1 click-option-group>=0.5.5 GitPython>=3.1.30",
+    "Maintainer": "",
+    "Description-en": ""
+  }
+
+If one or more dependencies could not be installed automatically, multitool
+will report the failures and display the appropriate pip command to install
+the remaining packages manually. For example::
+
+    Updating plugins
+    ----------------
+    Updating mdelotavo-multitool-plugins... Done
+    Updating test... Skipped Git pull (not a Git repository)
+
+    Checking Python package dependencies
+    ------------------------------------
+    Checked GitPython (GitPython>=3.1.30)... 3.1.50 installed
+    Installing asdfasdfasdf... Failed
+    Checked click-aliases (click-aliases>=1.0.1)... 1.0.1 installed
+    Checked click-option-group (click-option-group>=0.5.5)... 0.5.5 installed
+    Checked click (click>=8.1.3)... 8.1.8 installed
+    Installing qwerqwerqwer>=8.1.3... Failed
+    Checked tabulate (tabulate)... 0.9.0 installed
+
+    The following dependencies could not be installed automatically:
+      asdfasdfasdf
+      qwerqwerqwer>=8.1.3
+
+    Try installing them manually:
+      /usr/bin/python3 -m pip install asdfasdfasdf qwerqwerqwer>=8.1.3
+
+You can also display a plugin's declared dependencies at any time::
+
+    multitool plugins show --name PLUGIN_NAME --show-dependencies-only
+
 ^^^^^^^
 Pruning
 ^^^^^^^
@@ -209,11 +264,6 @@ Or inspect a specific repository::
     multitool plugins show -n PLUGIN_NAME --show-commit-only
     multitool plugins show -n PLUGIN_NAME --show-dependencies-only
 
-If a plugin declares Python dependencies in ``multitool-info.json``, install
-them with::
-
-    pip3 install $(multitool plugins show -n PLUGIN_NAME --show-dependencies-only)
-
 ---------------
 Troubleshooting
 ---------------

{multitool-0.7.2 → multitool-0.8.0}/README.rst

@@ -28,8 +28,7 @@ Run the example command::
         -vv \
         --enabled \
         --tag alpha \
-        --tag beta \
-        --output result.json
+        --tag beta
 
 Edit the generated source code::
 
@@ -124,10 +123,18 @@ Configuring
 
 Configure plugin repositories with::
 
-    multitool plugins configure -a
+    multitool plugins configure
+
+This opens your editor to modify the plugin configuration. After saving your
+changes, apply them with::
+
+    multitool plugins update
+
+To automatically apply the configuration changes after saving and closing the
+file (install new plugins, update existing plugins, and prune removed plugins),
+use::
 
-This opens your editor to modify the plugin configuration. Omit ``-a`` if you
-don't want changes applied automatically.
+    multitool plugins configure -a
 
 Example configuration::
 
@@ -149,11 +156,11 @@ Install the example plugins::
     echo -e '[sources]\nmdelotavo-multitool-plugins = https://github.com/mdelotavo/multitool-plugins.git' >> ~/.multitool/plugins/config
 
     multitool plugins update
+    
     multitool plugins show
     multitool plugins show -n mdelotavo-multitool-plugins
     multitool plugins show -n mdelotavo-multitool-plugins --show-commit-only
     multitool plugins show -n mdelotavo-multitool-plugins --show-dependencies-only
-    pip3 install $(multitool plugins show -n mdelotavo-multitool-plugins --show-dependencies-only)
 
     multitool run examples -h
 
@@ -161,10 +168,57 @@ Install the example plugins::
 Updating
 ^^^^^^^^
 
-Install new plugins and update existing ones::
+Install new plugins, update existing ones, and automatically install any Python
+dependencies declared in the Requires field of the plugin's
+multitool-info.json file::
 
     multitool plugins update
 
+Update a specific plugin only::
+
+    multitool plugins update -n PLUGIN_NAME
+
+The Requires field is where a plugin declares the Python packages it
+depends on. Any packages listed will be installed automatically when
+multitool plugins update is run. For example::
+
+  {
+    "Homepage": "",
+    "Requires": "click>=8.1.3 click-aliases>=1.0.1 click-option-group>=0.5.5 GitPython>=3.1.30",
+    "Maintainer": "",
+    "Description-en": ""
+  }
+
+If one or more dependencies could not be installed automatically, multitool
+will report the failures and display the appropriate pip command to install
+the remaining packages manually. For example::
+
+    Updating plugins
+    ----------------
+    Updating mdelotavo-multitool-plugins... Done
+    Updating test... Skipped Git pull (not a Git repository)
+
+    Checking Python package dependencies
+    ------------------------------------
+    Checked GitPython (GitPython>=3.1.30)... 3.1.50 installed
+    Installing asdfasdfasdf... Failed
+    Checked click-aliases (click-aliases>=1.0.1)... 1.0.1 installed
+    Checked click-option-group (click-option-group>=0.5.5)... 0.5.5 installed
+    Checked click (click>=8.1.3)... 8.1.8 installed
+    Installing qwerqwerqwer>=8.1.3... Failed
+    Checked tabulate (tabulate)... 0.9.0 installed
+
+    The following dependencies could not be installed automatically:
+      asdfasdfasdf
+      qwerqwerqwer>=8.1.3
+
+    Try installing them manually:
+      /usr/bin/python3 -m pip install asdfasdfasdf qwerqwerqwer>=8.1.3
+
+You can also display a plugin's declared dependencies at any time::
+
+    multitool plugins show --name PLUGIN_NAME --show-dependencies-only
+
 ^^^^^^^
 Pruning
 ^^^^^^^
@@ -186,11 +240,6 @@ Or inspect a specific repository::
     multitool plugins show -n PLUGIN_NAME --show-commit-only
     multitool plugins show -n PLUGIN_NAME --show-dependencies-only
 
-If a plugin declares Python dependencies in ``multitool-info.json``, install
-them with::
-
-    pip3 install $(multitool plugins show -n PLUGIN_NAME --show-dependencies-only)
-
 ---------------
 Troubleshooting
 ---------------

{multitool-0.7.2 → multitool-0.8.0}/multitool/__init__.py

@@ -1,5 +1,5 @@
 APP = "multitool"
-__version__ = "0.7.2"
+__version__ = "0.8.0"
 description = "Create and run plugin-based command-line tools."
 long_description = ("Create and run plugin-based command-line tools by dynamically loading Click commands from local or Git-managed plugin repositories.")
 

{multitool-0.7.2 → multitool-0.8.0}/multitool/plugins/commands.py

@@ -4,6 +4,10 @@ import shutil
 import stat
 import sys
 import uuid
+import shutil
+import subprocess
+from importlib.metadata import PackageNotFoundError, version
+from packaging.requirements import Requirement
 from pathlib import Path
 
 import click
@@ -69,32 +73,173 @@ def clone():
             console.echo(e)
 
 
-def update_repos():
+def pip_command():
+    if sys.executable:
+        return [sys.executable, "-m", "pip"]
 
-    def fn(p):
-        if not is_dir(p):
-            return
+    if shutil.which("pip"):
+        return ["pip"]
 
-        name = Path(p).stem
+    if shutil.which("pip3"):
+        return ["pip3"]
+
+    return None
+
+
+def package_installed(package):
+    try:
+        version(package)
+        return True
+    except PackageNotFoundError:
+        return False
+
+
+def parse_requires(info):
+    requires = info.get("Requires")
+
+    if not requires:
+        return []
+
+    if isinstance(requires, str):
+        return requires.split()
+
+    if isinstance(requires, (list, tuple, set)):
+        return [str(r).strip() for r in requires if str(r).strip()]
+
+    return []
+
+
+def package_status(requirement):
+    req = Requirement(requirement)
+
+    try:
+        installed = version(req.name)
+    except PackageNotFoundError:
+        return req, None, False
+
+    return req, installed, req.specifier.contains(installed, prereleases=True)
+
+
+def install_plugin_dependencies(name=None):
+    cmd = pip_command()
+
+    if cmd is None:
+        console.echo("Unable to locate pip.")
+        return
+
+    required = set()
+
+    def add_dependencies(plugin_name):
+        info = plugin_info(plugin_name)
+
+        if info:
+            required.update(parse_requires(info))
+
+    if name:
+        path = Path(MULTITOOL_PLUGINS_DIRECTORY) / name
+
+        if not is_dir(path):
+            console.echo(f'Plugin "{name}" not found.')
+            sys.exit(1)
+
+        add_dependencies(name)
+
+    else:
+
+        def fn(path):
+            if is_dir(path):
+                add_dependencies(Path(path).stem)
+
+        for_each_file(
+          MULTITOOL_PLUGINS_DIRECTORY,
+          fn,
+          glob="[!.][!__]*",
+        )
 
-        console.echo(f"Updating {name}... ", end="", flush=True)
+    failed = []
+
+    for requirement in sorted(required):
+        req, installed, satisfied = package_status(requirement)
+
+        if satisfied:
+            console.echo(f"Checked {req.name} ({requirement})... "
+                         f"{installed} installed")
+            continue
+
+        if installed is None:
+            console.echo(
+              f"Installing {requirement}... ",
+              end="",
+              flush=True,
+            )
+        else:
+            console.echo(
+              f"Updating {req.name} ({installed} -> {requirement})... ",
+              end="",
+              flush=True,
+            )
+
+        result = subprocess.run(
+          cmd + ["install", requirement],
+          stdout=subprocess.DEVNULL,
+          stderr=subprocess.DEVNULL,
+        )
+
+        if result.returncode == 0:
+            console.echo("Done")
+        else:
+            console.echo("Failed")
+            failed.append(requirement)
+
+    if failed:
+        console.echo()
+        console.echo("The following dependencies could not be installed automatically:")
+
+        for requirement in failed:
+            console.echo(f"  {requirement}")
+
+        console.echo()
+        console.echo("Try installing them manually:")
+        console.echo(f"  {' '.join(cmd)} install {' '.join(failed)}")
+
+
+def update_repos(name=None):
+
+    def update_repo(path):
+        plugin_name = Path(path).stem
+
+        console.echo(f"Updating {plugin_name}... ", end="", flush=True)
 
         try:
-            repo = Repo(p)
+            repo = Repo(path)
 
             if repo.bare:
-                console.echo("Skipped (bare repository)")
+                console.echo("Skipped Git pull (bare repository)")
                 return
 
             if not repo.remotes:
-                console.echo("Skipped (Git repository has no remote)")
+                console.echo("Skipped Git pull (Git repository has no remote)")
                 return
 
             repo.remotes["origin"].pull()
             console.echo("Done")
 
         except Exception:
-            console.echo("Skipped (not a Git repository)")
+            console.echo("Skipped Git pull (not a Git repository)")
+
+    if name:
+        path = Path(MULTITOOL_PLUGINS_DIRECTORY) / name
+
+        if not is_dir(path):
+            console.echo(f'Plugin "{name}" not found.')
+            sys.exit(1)
+
+        update_repo(path)
+        return
+
+    def fn(path):
+        if is_dir(path):
+            update_repo(path)
 
     for_each_file(
       MULTITOOL_PLUGINS_DIRECTORY,
@@ -181,10 +326,17 @@ def configure(silent, verbose, apply_changes):
 @plugins.command()
 @common_silent_options
 @common_verbose_options
-def update(silent, verbose):
+@click.option("-n", "--name")
+def update(silent, verbose, name):
     require_git()
     clone()
-    update_repos()
+    console.echo("Updating plugins")
+    console.echo("----------------")
+    update_repos(name)
+    console.echo()
+    console.echo("Checking Python package dependencies")
+    console.echo("------------------------------------")
+    install_plugin_dependencies(name)
 
 
 @plugins.command()
@@ -260,7 +412,36 @@ def prune(silent, verbose):
 @common_silent_options
 @common_verbose_options
 @click.argument("name")
-def new(silent, verbose, name):
+@click.option(
+  "--requires-format",
+  type=click.Choice(["array", "string"], case_sensitive=False),
+  default="string",
+  show_default=True,
+  help="Format to use for the Requires field.",
+)
+def new(silent, verbose, name, requires_format):
+    if requires_format == "array":
+        info = """{
+  "Homepage": "",
+  "Requires": [
+    "click>=8.1.3",
+    "click-aliases>=1.0.1",
+    "click-option-group>=0.5.5",
+    "GitPython>=3.1.30"
+  ],
+  "Maintainer": "",
+  "Description-en": ""
+}
+"""
+    elif requires_format == "string":
+        info = """{
+  "Homepage": "",
+  "Requires": "click>=8.1.3 click-aliases>=1.0.1 click-option-group>=0.5.5 GitPython>=3.1.30",
+  "Maintainer": "",
+  "Description-en": ""
+}
+"""
+
     init()
 
     if not name.isidentifier():
@@ -381,13 +562,7 @@ def hello(
 '''
     )
 
-    (root / f"{APP}-info.json").write_text("""{
-  "Homepage": "",
-  "Requires": "click",
-  "Maintainer": "",
-  "Description-en": ""
-}
-""")
+    (root / f"{APP}-info.json").write_text(info)
 
     touch(root / "README.md")
     touch(root / "LICENSE")

{multitool-0.7.2 → multitool-0.8.0}/multitool.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: multitool
-Version: 0.7.2
+Version: 0.8.0
 Summary: Create and run plugin-based command-line tools.
 Author-email: Matthew Delotavo <matthew.t.delotavo@gmail.com>
 License-Expression: MIT
@@ -19,6 +19,7 @@ Requires-Dist: click>=8.1.3
 Requires-Dist: click-aliases>=1.0.1
 Requires-Dist: click-option-group>=0.5.5
 Requires-Dist: GitPython>=3.1.30
+Requires-Dist: packaging>=26.2
 Dynamic: license-file
 
 multitool
@@ -51,8 +52,7 @@ Run the example command::
         -vv \
         --enabled \
         --tag alpha \
-        --tag beta \
-        --output result.json
+        --tag beta
 
 Edit the generated source code::
 
@@ -147,10 +147,18 @@ Configuring
 
 Configure plugin repositories with::
 
-    multitool plugins configure -a
+    multitool plugins configure
+
+This opens your editor to modify the plugin configuration. After saving your
+changes, apply them with::
+
+    multitool plugins update
+
+To automatically apply the configuration changes after saving and closing the
+file (install new plugins, update existing plugins, and prune removed plugins),
+use::
 
-This opens your editor to modify the plugin configuration. Omit ``-a`` if you
-don't want changes applied automatically.
+    multitool plugins configure -a
 
 Example configuration::
 
@@ -172,11 +180,11 @@ Install the example plugins::
     echo -e '[sources]\nmdelotavo-multitool-plugins = https://github.com/mdelotavo/multitool-plugins.git' >> ~/.multitool/plugins/config
 
     multitool plugins update
+    
     multitool plugins show
     multitool plugins show -n mdelotavo-multitool-plugins
     multitool plugins show -n mdelotavo-multitool-plugins --show-commit-only
     multitool plugins show -n mdelotavo-multitool-plugins --show-dependencies-only
-    pip3 install $(multitool plugins show -n mdelotavo-multitool-plugins --show-dependencies-only)
 
     multitool run examples -h
 
@@ -184,10 +192,57 @@ Install the example plugins::
 Updating
 ^^^^^^^^
 
-Install new plugins and update existing ones::
+Install new plugins, update existing ones, and automatically install any Python
+dependencies declared in the Requires field of the plugin's
+multitool-info.json file::
 
     multitool plugins update
 
+Update a specific plugin only::
+
+    multitool plugins update -n PLUGIN_NAME
+
+The Requires field is where a plugin declares the Python packages it
+depends on. Any packages listed will be installed automatically when
+multitool plugins update is run. For example::
+
+  {
+    "Homepage": "",
+    "Requires": "click>=8.1.3 click-aliases>=1.0.1 click-option-group>=0.5.5 GitPython>=3.1.30",
+    "Maintainer": "",
+    "Description-en": ""
+  }
+
+If one or more dependencies could not be installed automatically, multitool
+will report the failures and display the appropriate pip command to install
+the remaining packages manually. For example::
+
+    Updating plugins
+    ----------------
+    Updating mdelotavo-multitool-plugins... Done
+    Updating test... Skipped Git pull (not a Git repository)
+
+    Checking Python package dependencies
+    ------------------------------------
+    Checked GitPython (GitPython>=3.1.30)... 3.1.50 installed
+    Installing asdfasdfasdf... Failed
+    Checked click-aliases (click-aliases>=1.0.1)... 1.0.1 installed
+    Checked click-option-group (click-option-group>=0.5.5)... 0.5.5 installed
+    Checked click (click>=8.1.3)... 8.1.8 installed
+    Installing qwerqwerqwer>=8.1.3... Failed
+    Checked tabulate (tabulate)... 0.9.0 installed
+
+    The following dependencies could not be installed automatically:
+      asdfasdfasdf
+      qwerqwerqwer>=8.1.3
+
+    Try installing them manually:
+      /usr/bin/python3 -m pip install asdfasdfasdf qwerqwerqwer>=8.1.3
+
+You can also display a plugin's declared dependencies at any time::
+
+    multitool plugins show --name PLUGIN_NAME --show-dependencies-only
+
 ^^^^^^^
 Pruning
 ^^^^^^^
@@ -209,11 +264,6 @@ Or inspect a specific repository::
     multitool plugins show -n PLUGIN_NAME --show-commit-only
     multitool plugins show -n PLUGIN_NAME --show-dependencies-only
 
-If a plugin declares Python dependencies in ``multitool-info.json``, install
-them with::
-
-    pip3 install $(multitool plugins show -n PLUGIN_NAME --show-dependencies-only)
-
 ---------------
 Troubleshooting
 ---------------

{multitool-0.7.2 → multitool-0.8.0}/multitool.egg-info/requires.txt

@@ -2,3 +2,4 @@ click>=8.1.3
 click-aliases>=1.0.1
 click-option-group>=0.5.5
 GitPython>=3.1.30
+packaging>=26.2

{multitool-0.7.2 → multitool-0.8.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "multitool"
-version = "0.7.2"
+version = "0.8.0"
 description = "Create and run plugin-based command-line tools."
 readme = { file = "README.rst", content-type = "text/x-rst" }
 requires-python = ">=3.7"
@@ -28,7 +28,8 @@ dependencies = [
   "click>=8.1.3",
   "click-aliases>=1.0.1",
   "click-option-group>=0.5.5",
-  "GitPython>=3.1.30"
+  "GitPython>=3.1.30",
+  "packaging>=26.2"
 ]
 
 [project.urls]