multitool 0.7.0__tar.gz → 0.7.2__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: multitool
-Version: 0.7.0
+Version: 0.7.2
 Summary: Create and run plugin-based command-line tools.
 Author-email: Matthew Delotavo <matthew.t.delotavo@gmail.com>
 License-Expression: MIT
@@ -26,9 +26,9 @@ multitool
 
 Create and run plugin-based command-line tools.
 
------
-TL;DR
------
+----------
+Quickstart
+----------
 
 This section shows how to start prototyping plugins on your local machine.
 See the sections below to learn how to distribute your commands as remote
@@ -155,7 +155,7 @@ don't want changes applied automatically.
 Example configuration::
 
     [sources]
-    public = https://github.com/mdelotavo/multitool-plugins.git
+    mdelotavo-multitool-plugins = https://github.com/mdelotavo/multitool-plugins.git
 
 After saving, Multitool clones each configured repository into::
 
@@ -164,19 +164,19 @@ After saving, Multitool clones each configured repository into::
 You can configure multiple repositories as long as each key is unique.
 
 ^^^^^^^^^^
-Quickstart
+Installing
 ^^^^^^^^^^
 
 Install the example plugins::
 
-    echo -e '[sources]\npublic = https://github.com/mdelotavo/multitool-plugins.git' >> ~/.multitool/plugins/config
+    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 public
-    multitool plugins show -n public --show-commit-only
-    multitool plugins show -n public --show-dependencies-only
-    pip3 install $(multitool plugins show -n public --show-dependencies-only)
+    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
 
@@ -236,41 +236,19 @@ including the repository owner and repository name in the command name.
 For example, a repository configured as::
 
     [sources]
-    public = https://github.com/mdelotavo/multitool-plugins.git
+    mdelotavo-multitool-plugins = https://github.com/mdelotavo/multitool-plugins.git
 
 should expose commands using a unique name such as::
 
     mdelotavo-multitool-plugins
 
-This prevents duplicate command names when multiple repositories provide
-plugins with the same module name. If two plugins expose commands with the
-same name, only one can be loaded and the duplicate plugin will be skipped.
-
-If two repositories expose the same command name, Multitool will fail to load
-the duplicate plugin and raise an error similar to::
-
-    Duplicate plugin command "examples" found in
-    /home/user/.multitool/plugins/PLUGIN_NAME/__init__.py.
-    Already loaded from plugins_modules.examples
-
-To resolve the issue, remove the conflicting plugin repository from your local
-plugins directory::
-
-    ~/.multitool/plugins/PLUGIN_NAME/
-
-and remove the repository from the configured sources.
-
-You can edit the configuration file manually::
-
-    ~/.multitool/plugins/config
+This reduces the likelihood of collisions when multiple repositories expose
+plugins with the same command name.
 
-or open it using::
-
-    multitool plugins configure
-
-After removing the conflicting repository, update the installed plugins::
-
-    multitool plugins update
+If duplicate command names are detected, Multitool will display an error
+prompting you to delete the detected conflicting plugin repositories and, if
+applicable, remove the corresponding remote sources from your plugin
+configuration.
 
 
 .. _`click`: https://click.palletsprojects.com/

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

@@ -3,9 +3,9 @@ multitool
 
 Create and run plugin-based command-line tools.
 
------
-TL;DR
------
+----------
+Quickstart
+----------
 
 This section shows how to start prototyping plugins on your local machine.
 See the sections below to learn how to distribute your commands as remote
@@ -132,7 +132,7 @@ don't want changes applied automatically.
 Example configuration::
 
     [sources]
-    public = https://github.com/mdelotavo/multitool-plugins.git
+    mdelotavo-multitool-plugins = https://github.com/mdelotavo/multitool-plugins.git
 
 After saving, Multitool clones each configured repository into::
 
@@ -141,19 +141,19 @@ After saving, Multitool clones each configured repository into::
 You can configure multiple repositories as long as each key is unique.
 
 ^^^^^^^^^^
-Quickstart
+Installing
 ^^^^^^^^^^
 
 Install the example plugins::
 
-    echo -e '[sources]\npublic = https://github.com/mdelotavo/multitool-plugins.git' >> ~/.multitool/plugins/config
+    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 public
-    multitool plugins show -n public --show-commit-only
-    multitool plugins show -n public --show-dependencies-only
-    pip3 install $(multitool plugins show -n public --show-dependencies-only)
+    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
 
@@ -213,41 +213,19 @@ including the repository owner and repository name in the command name.
 For example, a repository configured as::
 
     [sources]
-    public = https://github.com/mdelotavo/multitool-plugins.git
+    mdelotavo-multitool-plugins = https://github.com/mdelotavo/multitool-plugins.git
 
 should expose commands using a unique name such as::
 
     mdelotavo-multitool-plugins
 
-This prevents duplicate command names when multiple repositories provide
-plugins with the same module name. If two plugins expose commands with the
-same name, only one can be loaded and the duplicate plugin will be skipped.
-
-If two repositories expose the same command name, Multitool will fail to load
-the duplicate plugin and raise an error similar to::
-
-    Duplicate plugin command "examples" found in
-    /home/user/.multitool/plugins/PLUGIN_NAME/__init__.py.
-    Already loaded from plugins_modules.examples
-
-To resolve the issue, remove the conflicting plugin repository from your local
-plugins directory::
-
-    ~/.multitool/plugins/PLUGIN_NAME/
-
-and remove the repository from the configured sources.
-
-You can edit the configuration file manually::
-
-    ~/.multitool/plugins/config
+This reduces the likelihood of collisions when multiple repositories expose
+plugins with the same command name.
 
-or open it using::
-
-    multitool plugins configure
-
-After removing the conflicting repository, update the installed plugins::
-
-    multitool plugins update
+If duplicate command names are detected, Multitool will display an error
+prompting you to delete the detected conflicting plugin repositories and, if
+applicable, remove the corresponding remote sources from your plugin
+configuration.
 
 
 .. _`click`: https://click.palletsprojects.com/

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

@@ -1,5 +1,5 @@
 APP = "multitool"
-__version__ = "0.7.0"
+__version__ = "0.7.2"
 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.")
 
@@ -8,16 +8,19 @@ from pathlib import Path
 
 from multitool.utils_init import join_path
 
+# Runtime configuration
 MULTITOOL_TOGGLE_SILENT = False
 MULTITOOL_TOGGLE_VERBOSE = 0
 
+# Application directories and files
 MULTITOOL_DIRECTORY = join_path(Path.home(), ".multitool")
-
 MULTITOOL_LOG_FILE = join_path(MULTITOOL_DIRECTORY, f"{APP}.log")
 
+# Plugin directories and files
 MULTITOOL_PLUGINS_DIRECTORY = join_path(MULTITOOL_DIRECTORY, "plugins")
 MULTITOOL_PLUGINS_CONFIG_FILE = join_path(MULTITOOL_PLUGINS_DIRECTORY, "config")
-MULTITOOL_PLUGINS_PATH = join_path(MULTITOOL_PLUGINS_DIRECTORY, "__init__.py")
+MULTITOOL_PLUGINS_INIT_FILE = join_path(MULTITOOL_PLUGINS_DIRECTORY, "__init__.py")
 
+# Expose runtime configuration globally
 builtins.MULTITOOL_TOGGLE_SILENT = MULTITOOL_TOGGLE_SILENT
 builtins.MULTITOOL_TOGGLE_VERBOSE = MULTITOOL_TOGGLE_VERBOSE

{multitool-0.7.0 → multitool-0.7.2}/multitool/__main__.py

@@ -8,7 +8,7 @@ from multitool import __version__ as version
 from multitool.cls import AliasedGroup
 from multitool.exceptions import wrap_with_exception_handling
 from multitool.plugins.commands import plugins
-from multitool.utils import (configure_logger, for_each_file, load_plugins)
+from multitool.utils import (configure_root_logger, for_each_file, load_plugins)
 
 CONTEXT_SETTINGS = dict(help_option_names=["-h", "--help"])
 
@@ -29,7 +29,7 @@ def run():
 
 @wrap_with_exception_handling
 def main():
-    configure_logger(MULTITOOL_LOG_FILE)
+    configure_root_logger(MULTITOOL_LOG_FILE)
 
     cli_commands = {plugins, run}
 

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

@@ -13,7 +13,7 @@ from multitool import (
   APP,
   MULTITOOL_PLUGINS_CONFIG_FILE,
   MULTITOOL_PLUGINS_DIRECTORY,
-  MULTITOOL_PLUGINS_PATH,
+  MULTITOOL_PLUGINS_INIT_FILE,
   console,
 )
 from multitool.silent import common_silent_options
@@ -44,7 +44,7 @@ def require_git():
 
 def init():
     mkdir(MULTITOOL_PLUGINS_DIRECTORY)
-    touch(MULTITOOL_PLUGINS_PATH)
+    touch(MULTITOOL_PLUGINS_INIT_FILE)
     touch(MULTITOOL_PLUGINS_CONFIG_FILE)
 
 
@@ -381,9 +381,9 @@ def hello(
 '''
     )
 
-    (root / "multitool-info.json").write_text("""{
+    (root / f"{APP}-info.json").write_text("""{
   "Homepage": "",
-  "Requires": "",
+  "Requires": "click",
   "Maintainer": "",
   "Description-en": ""
 }
@@ -403,9 +403,9 @@ def hello(
     console.echo(f"      {module}.py")
     console.echo()
     console.echo("  • To use this plugin locally:")
-    console.echo("      Copy the plugin directory into another Multitool")
+    console.echo(f"      Copy the plugin directory into another {APP}")
     console.echo("      plugins directory:")
-    console.echo("        ~/.multitool/plugins/")
+    console.echo(f"        ~/.{APP}/plugins/")
     console.echo()
     console.echo("  • To distribute this plugin:")
     console.echo("      1. Initialize a Git repository.")

{multitool-0.7.0 → multitool-0.7.2}/multitool/utils.py

@@ -8,8 +8,10 @@ from pathlib import Path
 
 import click
 
+from multitool import APP
 
-def configure_logger(log_file):
+
+def configure_root_logger(log_file):
     touch(log_file)
     remove_if_large(log_file, size_kb=1000)
     logging.basicConfig(
@@ -98,9 +100,9 @@ Plugin command names must be unique across all installed repositories.
 To resolve this:
   1. Delete one of the conflicting plugin repositories.
   2. If the repository was installed from a remote source, remove or comment
-     out its entry in ~/.multitool/plugins/config (or run
-     `multitool plugins configure`) before running
-     `multitool plugins update` again, otherwise it will be reinstalled.
+     out its entry in ~/.{APP}/plugins/config (or run
+     `{APP} plugins configure`) before running
+     `{APP} plugins update` again, otherwise it will be reinstalled.
   3. Run the command again.
   4. If another duplicate plugin error appears, repeat these steps until no
      duplicate plugin command errors remain.

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: multitool
-Version: 0.7.0
+Version: 0.7.2
 Summary: Create and run plugin-based command-line tools.
 Author-email: Matthew Delotavo <matthew.t.delotavo@gmail.com>
 License-Expression: MIT
@@ -26,9 +26,9 @@ multitool
 
 Create and run plugin-based command-line tools.
 
------
-TL;DR
------
+----------
+Quickstart
+----------
 
 This section shows how to start prototyping plugins on your local machine.
 See the sections below to learn how to distribute your commands as remote
@@ -155,7 +155,7 @@ don't want changes applied automatically.
 Example configuration::
 
     [sources]
-    public = https://github.com/mdelotavo/multitool-plugins.git
+    mdelotavo-multitool-plugins = https://github.com/mdelotavo/multitool-plugins.git
 
 After saving, Multitool clones each configured repository into::
 
@@ -164,19 +164,19 @@ After saving, Multitool clones each configured repository into::
 You can configure multiple repositories as long as each key is unique.
 
 ^^^^^^^^^^
-Quickstart
+Installing
 ^^^^^^^^^^
 
 Install the example plugins::
 
-    echo -e '[sources]\npublic = https://github.com/mdelotavo/multitool-plugins.git' >> ~/.multitool/plugins/config
+    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 public
-    multitool plugins show -n public --show-commit-only
-    multitool plugins show -n public --show-dependencies-only
-    pip3 install $(multitool plugins show -n public --show-dependencies-only)
+    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
 
@@ -236,41 +236,19 @@ including the repository owner and repository name in the command name.
 For example, a repository configured as::
 
     [sources]
-    public = https://github.com/mdelotavo/multitool-plugins.git
+    mdelotavo-multitool-plugins = https://github.com/mdelotavo/multitool-plugins.git
 
 should expose commands using a unique name such as::
 
     mdelotavo-multitool-plugins
 
-This prevents duplicate command names when multiple repositories provide
-plugins with the same module name. If two plugins expose commands with the
-same name, only one can be loaded and the duplicate plugin will be skipped.
-
-If two repositories expose the same command name, Multitool will fail to load
-the duplicate plugin and raise an error similar to::
-
-    Duplicate plugin command "examples" found in
-    /home/user/.multitool/plugins/PLUGIN_NAME/__init__.py.
-    Already loaded from plugins_modules.examples
-
-To resolve the issue, remove the conflicting plugin repository from your local
-plugins directory::
-
-    ~/.multitool/plugins/PLUGIN_NAME/
-
-and remove the repository from the configured sources.
-
-You can edit the configuration file manually::
-
-    ~/.multitool/plugins/config
+This reduces the likelihood of collisions when multiple repositories expose
+plugins with the same command name.
 
-or open it using::
-
-    multitool plugins configure
-
-After removing the conflicting repository, update the installed plugins::
-
-    multitool plugins update
+If duplicate command names are detected, Multitool will display an error
+prompting you to delete the detected conflicting plugin repositories and, if
+applicable, remove the corresponding remote sources from your plugin
+configuration.
 
 
 .. _`click`: https://click.palletsprojects.com/

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

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "multitool"
-version = "0.7.0"
+version = "0.7.2"
 description = "Create and run plugin-based command-line tools."
 readme = { file = "README.rst", content-type = "text/x-rst" }
 requires-python = ">=3.7"