multitool 0.8.0__tar.gz → 0.10.0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: multitool
-Version: 0.8.0
+Version: 0.10.0
 Summary: Create and run plugin-based command-line tools.
 Author-email: Matthew Delotavo <matthew.t.delotavo@gmail.com>
 License-Expression: MIT
@@ -73,8 +73,9 @@ Usage
       -h, --help     Show this message and exit.
 
     Commands:
-      plugins  Manage plugin repositories.
-      run      Run installed plugin commands.
+      bootstrap  Create the directory structure for a new Python package...
+      plugins    Manage plugin repositories.
+      run        Run installed plugin commands.
 
 ----------------
 Managing plugins
@@ -145,31 +146,45 @@ plugins directory to use it locally.
 Configuring
 ^^^^^^^^^^^
 
-Configure plugin repositories with::
+Add a plugin repository with::
 
-    multitool plugins configure
+    multitool plugins add https://github.com/mdelotavo/multitool-plugins.git
+
+By default, the repository name is used as the source key. To specify your own
+key::
+
+    multitool plugins add https://github.com/mdelotavo/multitool-plugins.git --key example
+
+Remove a configured plugin source by key or URL::
 
-This opens your editor to modify the plugin configuration. After saving your
-changes, apply them with::
+    multitool plugins remove multitool-plugins
+
+    multitool plugins remove https://github.com/mdelotavo/multitool-plugins.git
+
+Apply configuration changes (install new plugins and update existing plugins)
+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::
+For bulk edits, you can edit the configuration file directly::
+
+    multitool plugins configure
+
+To automatically apply configuration changes after saving and closing the file
+(install new plugins, update existing plugins, and prune removed plugins), use::
 
     multitool plugins configure -a
 
 Example configuration::
 
     [sources]
-    mdelotavo-multitool-plugins = https://github.com/mdelotavo/multitool-plugins.git
+    multitool-plugins = https://github.com/mdelotavo/multitool-plugins.git
 
-After saving, Multitool clones each configured repository into::
+Configured repositories are cloned into::
 
     ~/.multitool/plugins/
 
-You can configure multiple repositories as long as each key is unique.
+Multiple repositories may be configured as long as each source key is unique.
 
 ^^^^^^^^^^
 Installing
@@ -177,14 +192,14 @@ Installing
 
 Install the example plugins::
 
-    echo -e '[sources]\nmdelotavo-multitool-plugins = https://github.com/mdelotavo/multitool-plugins.git' >> ~/.multitool/plugins/config
+    multitool plugins add https://github.com/mdelotavo/multitool-plugins.git
 
     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
+    multitool plugins show -n multitool-plugins
+    multitool plugins show -n multitool-plugins --show-commit-only
+    multitool plugins show -n multitool-plugins --show-dependencies-only
 
     multitool run examples -h
 
@@ -219,7 +234,7 @@ the remaining packages manually. For example::
 
     Updating plugins
     ----------------
-    Updating mdelotavo-multitool-plugins... Done
+    Updating multitool-plugins... Done
     Updating test... Skipped Git pull (not a Git repository)
 
     Checking Python package dependencies
@@ -247,10 +262,20 @@ You can also display a plugin's declared dependencies at any time::
 Pruning
 ^^^^^^^
 
-Remove repositories no longer listed in the configuration::
+To uninstall a plugin repository, first remove it from the configured sources::
+
+    multitool plugins remove multitool-plugins
+
+Then remove any local repositories that are no longer configured::
 
     multitool plugins prune
 
+Alternatively, running::
+
+    multitool plugins configure -a
+
+automatically prunes repositories removed from the configuration.
+
 ^^^^^^^
 Showing
 ^^^^^^^
@@ -274,32 +299,6 @@ If a plugin fails to install or load, check the log file::
 
 It contains installation, dependency, and Git-related errors.
 
------------
-Limitations
------------
-
-Plugin command names must be unique across all installed repositories.
-
-To avoid naming conflicts, plugin modules should follow the convention of
-including the repository owner and repository name in the command name.
-
-For example, a repository configured as::
-
-    [sources]
-    mdelotavo-multitool-plugins = https://github.com/mdelotavo/multitool-plugins.git
-
-should expose commands using a unique name such as::
-
-    mdelotavo-multitool-plugins
-
-This reduces the likelihood of collisions when multiple repositories expose
-plugins with the same command name.
-
-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-plugins`: https://github.com/mdelotavo/multitool-plugins

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

@@ -49,8 +49,9 @@ Usage
       -h, --help     Show this message and exit.
 
     Commands:
-      plugins  Manage plugin repositories.
-      run      Run installed plugin commands.
+      bootstrap  Create the directory structure for a new Python package...
+      plugins    Manage plugin repositories.
+      run        Run installed plugin commands.
 
 ----------------
 Managing plugins
@@ -121,31 +122,45 @@ plugins directory to use it locally.
 Configuring
 ^^^^^^^^^^^
 
-Configure plugin repositories with::
+Add a plugin repository with::
 
-    multitool plugins configure
+    multitool plugins add https://github.com/mdelotavo/multitool-plugins.git
+
+By default, the repository name is used as the source key. To specify your own
+key::
+
+    multitool plugins add https://github.com/mdelotavo/multitool-plugins.git --key example
+
+Remove a configured plugin source by key or URL::
 
-This opens your editor to modify the plugin configuration. After saving your
-changes, apply them with::
+    multitool plugins remove multitool-plugins
+
+    multitool plugins remove https://github.com/mdelotavo/multitool-plugins.git
+
+Apply configuration changes (install new plugins and update existing plugins)
+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::
+For bulk edits, you can edit the configuration file directly::
+
+    multitool plugins configure
+
+To automatically apply configuration changes after saving and closing the file
+(install new plugins, update existing plugins, and prune removed plugins), use::
 
     multitool plugins configure -a
 
 Example configuration::
 
     [sources]
-    mdelotavo-multitool-plugins = https://github.com/mdelotavo/multitool-plugins.git
+    multitool-plugins = https://github.com/mdelotavo/multitool-plugins.git
 
-After saving, Multitool clones each configured repository into::
+Configured repositories are cloned into::
 
     ~/.multitool/plugins/
 
-You can configure multiple repositories as long as each key is unique.
+Multiple repositories may be configured as long as each source key is unique.
 
 ^^^^^^^^^^
 Installing
@@ -153,14 +168,14 @@ Installing
 
 Install the example plugins::
 
-    echo -e '[sources]\nmdelotavo-multitool-plugins = https://github.com/mdelotavo/multitool-plugins.git' >> ~/.multitool/plugins/config
+    multitool plugins add https://github.com/mdelotavo/multitool-plugins.git
 
     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
+    multitool plugins show -n multitool-plugins
+    multitool plugins show -n multitool-plugins --show-commit-only
+    multitool plugins show -n multitool-plugins --show-dependencies-only
 
     multitool run examples -h
 
@@ -195,7 +210,7 @@ the remaining packages manually. For example::
 
     Updating plugins
     ----------------
-    Updating mdelotavo-multitool-plugins... Done
+    Updating multitool-plugins... Done
     Updating test... Skipped Git pull (not a Git repository)
 
     Checking Python package dependencies
@@ -223,10 +238,20 @@ You can also display a plugin's declared dependencies at any time::
 Pruning
 ^^^^^^^
 
-Remove repositories no longer listed in the configuration::
+To uninstall a plugin repository, first remove it from the configured sources::
+
+    multitool plugins remove multitool-plugins
+
+Then remove any local repositories that are no longer configured::
 
     multitool plugins prune
 
+Alternatively, running::
+
+    multitool plugins configure -a
+
+automatically prunes repositories removed from the configuration.
+
 ^^^^^^^
 Showing
 ^^^^^^^
@@ -250,32 +275,6 @@ If a plugin fails to install or load, check the log file::
 
 It contains installation, dependency, and Git-related errors.
 
------------
-Limitations
------------
-
-Plugin command names must be unique across all installed repositories.
-
-To avoid naming conflicts, plugin modules should follow the convention of
-including the repository owner and repository name in the command name.
-
-For example, a repository configured as::
-
-    [sources]
-    mdelotavo-multitool-plugins = https://github.com/mdelotavo/multitool-plugins.git
-
-should expose commands using a unique name such as::
-
-    mdelotavo-multitool-plugins
-
-This reduces the likelihood of collisions when multiple repositories expose
-plugins with the same command name.
-
-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-plugins`: https://github.com/mdelotavo/multitool-plugins

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

@@ -1,5 +1,5 @@
 APP = "multitool"
-__version__ = "0.8.0"
+__version__ = "0.10.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.8.0 → multitool-0.10.0}/multitool/__main__.py

@@ -5,10 +5,12 @@ import click
 
 from multitool import APP, MULTITOOL_LOG_FILE, MULTITOOL_PLUGINS_DIRECTORY
 from multitool import __version__ as version
+from multitool.bootstrap.commands import bootstrap
 from multitool.cls import AliasedGroup
 from multitool.exceptions import wrap_with_exception_handling
 from multitool.plugins.commands import plugins
-from multitool.utils import (configure_root_logger, for_each_file, load_plugins)
+from multitool.run.commands import run
+from multitool.utils import configure_root_logger, for_each_file, load_plugins
 
 CONTEXT_SETTINGS = dict(help_option_names=["-h", "--help"])
 
@@ -21,17 +23,11 @@ def cli(ctx):
     ctx.ensure_object(dict)
 
 
-@click.group(cls=AliasedGroup)
-def run():
-    """Run installed plugin commands."""
-    pass
-
-
 @wrap_with_exception_handling
 def main():
     configure_root_logger(MULTITOOL_LOG_FILE)
 
-    cli_commands = {plugins, run}
+    cli_commands = {plugins, run, bootstrap}
 
     run_commands = {}