invoke-toolkit 0.0.4__tar.gz → 0.0.7__tar.gz

invoke_toolkit-0.0.7/.gitignore

@@ -0,0 +1,9 @@
+.*
+!.envrc
+!.gitignore
+**/__pycache__/*
+**/_site/*
+docs/reference/
+**/.quarto/*
+docs/objects.json
+_tasks.py

{invoke_toolkit-0.0.4 → invoke_toolkit-0.0.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: invoke-toolkit
-Version: 0.0.4
+Version: 0.0.7
 Summary: A set of extended APIs for PyInvoke for composable scripts, plugins and richer output
 Project-URL: Documentation, https://github.com/D3f0/invoke-toolkit#readme
 Project-URL: Issues, https://github.com/D3f0/invoke-toolkit/issues
@@ -22,7 +22,12 @@ Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: System :: Software Distribution
 Classifier: Topic :: System :: Systems Administration
-Requires-Python: >=3.8
+Requires-Python: >=3.10
+Requires-Dist: appdirs
+Requires-Dist: invoke>=2.2.1
+Requires-Dist: pyyaml>=6.0.3
+Requires-Dist: rich>=14.2.0
+Requires-Dist: tomlkit>=0.13.3
 Requires-Dist: typing-extensions>=4.13.2
 Description-Content-Type: text/markdown
 

invoke_toolkit-0.0.7/docs/.gitignore

@@ -0,0 +1 @@
+/.quarto/

invoke_toolkit-0.0.7/docs/_quarto.yml

@@ -0,0 +1,84 @@
+project:
+  type: website
+
+website:
+  title: "Invoke Toolkit"
+  navbar:
+    background: primary
+    search: true
+    left: 
+      - text: "Home"
+        file: index.qmd
+      - text: "Reference"
+        file: reference/index.qmd
+    tools:
+      - icon: github
+        menu:
+          - text: Source Code
+            href:  https://github.com/D3f0/invoke-toolkit
+          - text: Report a Bug
+            href:  https://github.com/D3f0/invoke-toolkit/issues/new
+  # sidebar:
+  #   # style: ""
+  #   search: true
+
+
+# tell quarto to read the generated sidebar
+metadata-files:
+  - reference/_sidebar.yml
+
+# tell quarto to read the generated styles
+format:
+  html:
+    css:
+      - reference/_styles-quartodoc.css
+
+quartodoc:
+  # the name used to import the package you want to create reference docs for
+  package: invoke_toolkit
+
+  # write sidebar and style data
+  sidebar: reference/_sidebar.yml
+  css: reference/_styles-quartodoc.css
+
+  sections:
+    - title: Invoke Toolkit special classes
+      desc: Functions to inspect .
+      contents:
+        # the functions being documented in the package.
+        # you can refer to anything: class methods, modules, etc..
+        - program.program
+        - context.InvokeToolkitContext
+        - tasks.plugin
+        - tasks.dist
+        - context.types
+        - config.config
+        - config.status_helper
+        - output.console
+        - output.utils
+        - utils.inspection
+        - collections
+        # - scripts.loader
+        # - program.main
+        # - log.logger
+        # - runners.rich
+        # - executor
+
+    - title: Builtin collections
+      desc: >
+        A
+        B
+        C
+      package: invoke_toolkit.tasks
+      contents:
+        - plugin
+        - dist
+
+    - title: More
+      desc: Invoke reference
+      package: invoke
+      contents:
+        # the functions being documented in the package.
+        # you can refer to anything: class methods, modules, etc..
+        - tasks.task
+        

invoke_toolkit-0.0.7/docs/index.qmd

@@ -0,0 +1,30 @@
+# Welcome to Invoke Toolkit documentation
+
+
+<img alt="PyPI - Package Version" src="https://img.shields.io/pypi/v/invoke-toolkit">
+
+Invoke Toolkit is a set of opinionated extensions to the popular [Python invoke library](https://pyinvoke.org).
+
+- Add's some `Context` attributes
+- Renames the `inv`/`invoke` to `it`/`invoke-toolkit`, reads the same `tasks.py`.
+- Replaces `print()` with `rich`'s Console print (internal logging uses `rich` logger): `it -d`.
+- Command echo defaults to `stderr` (`it -e`)
+- 
+
+## Installation
+
+The recommended way to use `invoke-toolkit` is through `uv` package manager:
+
+```bash
+uv tool install invoke-toolkit
+```
+
+## Simple task example
+
+```python
+from invoke_toolkit import task, Context
+
+@task()
+def build(ctx: Context):
+    ctx.run("quarto build")
+```

invoke_toolkit-0.0.7/output.log

@@ -0,0 +1,87 @@
+[16:44:34] DEBUG    No default namespace provided, trying to load one from disk                                                                  program.py:467
+           DEBUG    FilesystemLoader find starting at '/Users/nahueldefosse/workspace/OSS/invoke-toolkit'                                         loader.py:124
+           DEBUG    Found module: ModuleSpec(name='tasks', loader=<_frozen_importlib_external.SourceFileLoader object at 0x10752ba10>,            loader.py:148
+                    origin='/Users/nahueldefosse/workspace/OSS/invoke-toolkit/tasks.py')                                                                       
+           DEBUG    Didn't see any /Users/nahueldefosse/workspace/OSS/invoke-toolkit/invoke.yaml, skipping.                                       config.py:903
+           DEBUG    Didn't see any /Users/nahueldefosse/workspace/OSS/invoke-toolkit/invoke.yml, skipping.                                        config.py:903
+           DEBUG    Didn't see any /Users/nahueldefosse/workspace/OSS/invoke-toolkit/invoke.json, skipping.                                       config.py:903
+           DEBUG    Merging config sources in order onto new empty _config...                                                                     config.py:947
+           DEBUG    Defaults: {'run': {'asynchronous': False, 'disown': False, 'dry': False, 'echo': False, 'echo_stdin': None, 'encoding': None, config.py:949
+                    'env': {}, 'err_stream': None, 'fallback': True, 'hide': None, 'in_stream': None, 'out_stream': None, 'echo_format':                       
+                    '[bold]{command}[/bold]', 'pty': False, 'replace_env': False, 'shell': '/bin/bash', 'warn': False, 'watchers': []},                        
+                    'runners': {'local': <class 'invoke_toolkit.runners.rich.NoStdoutRunner'>}, 'sudo': {'password': None, 'prompt': '[sudo]                   
+                    password: ', 'user': None}, 'tasks': {'auto_dash_names': True, 'collection_name': 'tasks', 'dedupe': True, 'executor_class':               
+                    None, 'ignore_unknown_help': False, 'search_root': None}, 'timeouts': {'command': None}}                                                   
+           DEBUG    Collection-driven: {}                                                                                                         config.py:951
+           DEBUG    System-wide config file (/etc/invoke.py): {}                                                                                  config.py:977
+           DEBUG    Per-user config file (/Users/nahueldefosse/.invoke.py): {'docker': {'command': 'podman'}}                                     config.py:977
+           DEBUG    Per-project config file (/Users/nahueldefosse/workspace/OSS/invoke-toolkit/invoke.py): {}                                     config.py:977
+           DEBUG    Environment variable config: {}                                                                                               config.py:956
+           DEBUG    Runtime config file has not been loaded yet, skipping                                                                         config.py:974
+           DEBUG    Overrides: {}                                                                                                                 config.py:959
+           DEBUG    Modifications: {}                                                                                                             config.py:961
+           DEBUG    Deletions: {}                                                                                                                 config.py:963
+           DEBUG    Trying to load internal invoke-toolkit collections                                                                           program.py:167
+           INFO     Importing submodules in invoke_toolkit.extensions.tasks                                                                   collections.py:34
+           ERROR    Error loading config: No module named 'yaml'                                                                              collections.py:49
+           DEBUG    🔧 Adding config to module 📦 collections: dict_keys(['a'])                                                              collections.py:163
+           DEBUG    Adding root collection configuration: None                                                                               collections.py:174
+           DEBUG    Adding <parser/Context 'version'>                                                                                              parser.py:78
+           DEBUG    Adding <parser/Context 'build': {'target': <Argument: target_ (t) [list]>, 'output': <Argument: output (o)>}>                  parser.py:78
+           DEBUG    Adding <parser/Context 'clean'>                                                                                                parser.py:78
+           DEBUG    Adding <parser/Context 'test' (t): {'debug': <Argument: debug (d) [bool]>, 'verbose': <Argument: verbose (v) [bool]>,          parser.py:78
+                    'capture-output': <Argument: capture_output (c) [bool]>, 'picked': <Argument: picked (p) [bool]>}>                                         
+           DEBUG    Adding <parser/Context 'release': {'skip-sync': <Argument: skip_sync (s) [bool]>}>                                             parser.py:78
+           DEBUG    Adding <parser/Context 'docs-api-build' (b): {'config': <Argument: config (c)>, 'filter': <Argument: filter_ (f)>, 'dry-run':  parser.py:78
+                    <Argument: dry_run (d) [bool]>, 'watch': <Argument: watch (w) [bool]>, 'verbose': <Argument: verbose (v) [bool]>}>                         
+           DEBUG    Adding <parser/Context 'docs-preview' (p)>                                                                                     parser.py:78
+           DEBUG    Adding <parser/Context 'run-in-container': {'image': <Argument: image (i)>, 'container-tool': <Argument: container_tool (c)>,  parser.py:78
+                    'command': <Argument: command (o)>, 'rm': <Argument: rm (r) [bool]>, 'interactive': <Argument: interactive (n) [bool]>, 'tty':             
+                    <Argument: tty (t) [bool]>}>                                                                                                               
+           DEBUG    Adding <parser/Context 'venv-search' (v)>                                                                                      parser.py:78
+           DEBUG    Adding <parser/Context 'env': {'clear': <Argument: clear (c) [bool]>}>                                                         parser.py:78
+           DEBUG    Adding <parser/Context 'collections.list' (collections)>                                                                       parser.py:78
+           DEBUG    Adding <parser/Context 'collections.add': {'plugin-spec': <Argument: plugin_spec (p) *>}>                                      parser.py:78
+           DEBUG    Adding <parser/Context 'collections.remove': {'name': <Argument: name (n) *>}>                                                 parser.py:78
+           DEBUG    Parsing tasks against <Collection 'tasks': build, clean, docs-api-build, docs-preview, env, release, run-in-container, test, program.py:765
+                    venv-search, version, collections..., dist...>                                                                                             
+           DEBUG    Initialized with context: <parser/Context: {'command-timeout': <Argument: command-timeout (T) [int]>, 'complete': <Argument:  parser.py:238
+                    complete [bool]>, 'config': <Argument: config (f)>, 'debug': <Argument: debug (d) [bool]>, 'dry': <Argument: dry (R) [bool]>,              
+                    'echo': <Argument: echo (e) [bool]>, 'help': <Argument: help (h) ?>, 'hide': <Argument: hide>, 'list': <Argument: list (l)                 
+                    ?>, 'list-depth': <Argument: list-depth (D) [int]>, 'list-format': <Argument: list-format (F)>, 'print-completion-script':                 
+                    <Argument: print-completion-script>, 'prompt-for-sudo-password': <Argument: prompt-for-sudo-password [bool]>, 'pty':                       
+                    <Argument: pty (p) [bool]>, 'version': <Argument: version (V) [bool]>, 'warn-only': <Argument: warn-only (w) [bool]>,                      
+                    'write-pyc': <Argument: write-pyc [bool]>, 'internal-col': <Argument: internal-col (x) [bool]>, 'collection': <Argument:                   
+                    collection (c)>, 'no-dedupe': <Argument: no-dedupe [bool]>, 'search-root': <Argument: search-root (r)>}>                                   
+           DEBUG    Available contexts: {'version': <parser/Context 'version'>, 'build': <parser/Context 'build': {'target': <Argument: target_   parser.py:243
+                    (t) [list]>, 'output': <Argument: output (o)>}>, 'clean': <parser/Context 'clean'>, 'test': <parser/Context 'test' (t):                    
+                    {'debug': <Argument: debug (d) [bool]>, 'verbose': <Argument: verbose (v) [bool]>, 'capture-output': <Argument:                            
+                    capture_output (c) [bool]>, 'picked': <Argument: picked (p) [bool]>}>, 'release': <parser/Context 'release': {'skip-sync':                 
+                    <Argument: skip_sync (s) [bool]>}>, 'docs-api-build': <parser/Context 'docs-api-build' (b): {'config': <Argument: config                   
+                    (c)>, 'filter': <Argument: filter_ (f)>, 'dry-run': <Argument: dry_run (d) [bool]>, 'watch': <Argument: watch (w) [bool]>,                 
+                    'verbose': <Argument: verbose (v) [bool]>}>, 'docs-preview': <parser/Context 'docs-preview' (p)>, 'run-in-container':                      
+                    <parser/Context 'run-in-container': {'image': <Argument: image (i)>, 'container-tool': <Argument: container_tool (c)>,                     
+                    'command': <Argument: command (o)>, 'rm': <Argument: rm (r) [bool]>, 'interactive': <Argument: interactive (n) [bool]>,                    
+                    'tty': <Argument: tty (t) [bool]>}>, 'venv-search': <parser/Context 'venv-search' (v)>, 'env': <parser/Context 'env':                      
+                    {'clear': <Argument: clear (c) [bool]>}>, 'collections.list': <parser/Context 'collections.list' (collections)>,                           
+                    'collections.add': <parser/Context 'collections.add': {'plugin-spec': <Argument: plugin_spec (p) *>}>, 'collections.remove':               
+                    <parser/Context 'collections.remove': {'name': <Argument: name (n) *>}>}                                                                   
+           DEBUG    Wrapping up context None                                                                                                      parser.py:336
+           DEBUG    Starting argv: []                                                                                                             parser.py:123
+           DEBUG    ParseMachine: 'context' => 'end'                                                                                              parser.py:227
+           DEBUG    Wrapping up context None                                                                                                      parser.py:336
+           DEBUG    Resulting task contexts: []                                                                                                  program.py:772
+build                                               Builds distributable package                                                                               
+clean                                               Cleans dist                                                                                                
+docs-api-build (b)                                  Runs uv run quartodoc build with the provided arguments.                                                   
+docs-preview (p)                                    Runs quarto preview to visualize the documentation.                                                        
+env                                                 (re)creates the virtual environment (with uv)                                                              
+release                                             Tags (if the git repo is clean) proposing the next tag                                                     
+run-in-container                                    Runs invoke-toolkit in a container.                                                                        
+test (t)                                            Runs pytest and exposes some commonly used flags                                                           
+venv-search (v)                                                                                                                                                
+version                                             Shows package version (git based)                                                                          
+collections.add                                     Adds a collection from a local path or a remote git repository                                             
+collections.list (collections)                      List all the collections available to invoke-toolkit                                                       
+collections.remove                                  Removes a collection previously added with collections.add                                                 
+           DEBUG    Received a possibly-skippable exception: Exit()                                                                              program.py:400

{invoke_toolkit-0.0.4 → invoke_toolkit-0.0.7}/pyproject.toml

@@ -3,7 +3,7 @@ name = "invoke-toolkit"
 dynamic = ["version"]
 description = "A set of extended APIs for PyInvoke for composable scripts, plugins and richer output"
 readme = "README.md"
-requires-python = ">=3.8"
+requires-python = ">=3.10"
 license = "MIT"
 keywords = []
 authors = [
@@ -26,9 +26,15 @@ classifiers = [
   "Topic :: System :: Systems Administration",
 ]
 dependencies = [
+    "invoke>=2.2.1",
+    "rich>=14.2.0",
     "typing-extensions>=4.13.2",
+    "appdirs",
+    "tomlkit>=0.13.3",
+    "pyyaml>=6.0.3",
 ]
 
+# Git based versioning, uses git tags
 [build-system]
 requires = ["hatchling", "uv-dynamic-versioning"]
 build-backend = "hatchling.build"
@@ -37,16 +43,20 @@ build-backend = "hatchling.build"
 source = "uv-dynamic-versioning"
 
 
-dependencies = [
-  "invoke",
-  "rich",
-  "appdirs",
-]
+
+[tool.commitizen]
+name = "cz_conventional_commits"
+tag_format = "v$version"
+version_scheme = "pep440"
+version_provider = "uv"
+update_changelog_on_bump = true
+major_version_zero = true
 
 [project.scripts]
-invtk = "invoke_toolkit.program.main:program.run"
+it = "invoke_toolkit.program.main:program.run"
 invoke-toolkit = "invoke_toolkit.program.main:program.run"
 
+
 [project.urls]
 Documentation = "https://github.com/D3f0/invoke-toolkit#readme"
 Issues = "https://github.com/D3f0/invoke-toolkit/issues"
@@ -77,7 +87,6 @@ exclude_lines = [
   "if TYPE_CHECKING:",
 ]
 
-
 [tool.hatch.envs.dev]
 dependencies = [
   # Invoke's original set of tasks
@@ -92,14 +101,13 @@ run = "run-coverage --no-cov"
 test = "pytest -v {}"
 testdbg = "pytest -v --pdb {}"
 
-[tool.hatch.envs.docs]
-dependencies = [
-  "sphinx"
-]
-
 
 [tool.ruff.lint.per-file-ignores]
 "*tasks*" = ["ARG001"]
+"__init__.py" = ["E402"]
+"**/{tests,docs}/*" = ["E402"]
+"src/invoke_toolkit/program/program.py" = ["E402"]
+
 
 [dependency-groups]
 dev = [
@@ -108,6 +116,12 @@ dev = [
     "pylint>=3.2.7",
     "pylint-per-file-ignores>=1.0.0",
     "pytest>=8.3.5",
+    "pytest-cov>=5.0.0",
+    "pytest-picked>=0.5.1",
+    "pytest-sugar>=1.1.1",
+]
+doc = [
+    "quartodoc>=0.11.1",
 ]
 
 [tool.pylint.main]
@@ -142,8 +156,8 @@ disable = [
 
 
 per-file-ignores = [
-    "tasks.py:missing-function-docstring,missing-class-docstring,missing-module-docstring",
-    "src/invoke_toolkit/program/program.py:ungrouped-imports",
+    "tasks.py:missing-function-docstring,missing-class-docstring,missing-module-docstring,invalid-name",
+    "src/invoke_toolkit/program/program.py:ungrouped-imports,redefined-builtin,raise-missing-from,attribute-defined-outside-init",
     "src/**/__init__.py:missing-module-docstring",
     "src/invoke_toolkit/scripts/loader.py:redefined-builtin",
     "src/**/tasks/*.py:unused-argument",
@@ -151,9 +165,17 @@ per-file-ignores = [
     "src/invoke_toolkit/utils/inspection.py:logging-fstring-interpolation",
     "**/types.py:too-many-arguments,too-few-public-methods,too-many-locals,missing-class-docstring",
     "**/context.py:too-few-public-methods",
-
-    "**/tasks.py:dangerous-default-value",
-
-    "tests/**/*.py:missing-function-docstring,unused-argument,missing-module-docstring,missing-class-docstring",
+    # This is for the list initialization of var-args in Invoke
+    "**/*.py:dangerous-default-value,line-too-long,logging-format-interpolation,missing-module-docstring,missing-class-docstring",
+    "tests/**/*.py:missing-function-docstring,unused-argument,missing-module-docstring,missing-class-docstring,redefined-outer-name",
     "tests/conftest.py:missing-module-docstring,redefined-outer-name",
+    "src/invoke_toolkit/loader/entrypoint.py:missing-function-docstring,logging-fstring-interpolation,import-outside-toplevel,broad-exception-caught,unused-argument,arguments-differ",
 ]
+
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "--cov=invoke_toolkit"
+filterwarnings = []
+
+ 

invoke_toolkit-0.0.7/src/invoke_toolkit/__init__.py

@@ -0,0 +1,7 @@
+"""Package namespace imports"""
+
+from invoke_toolkit.tasks import task
+from invoke_toolkit.context import InvokeToolkitContext as Context
+
+
+__all__ = ["task", "Context"]

invoke_toolkit-0.0.7/src/invoke_toolkit/collections.py

@@ -0,0 +1,203 @@
+"""Extended collection with package inspection"""
+
+import importlib
+import pkgutil
+import sys
+from pathlib import Path
+from types import ModuleType
+from typing import Any, Callable, Dict, Optional, Union, overload
+
+from invoke.collection import Collection
+from invoke.tasks import Task
+from invoke.util import debug
+from invoke_toolkit.tasks import InvokeToolkitTask
+from invoke_toolkit.utils.inspection import get_calling_file_path
+from logging import getLogger
+
+logger = getLogger("invoke")
+
+
+class CollectionError(Exception):
+    """Base class for import discovery errors"""
+
+
+class CollectionNotImportedError(CollectionError): ...
+
+
+class CollectionCantFindModulePathError(CollectionError): ...
+
+
+def import_submodules(package_name: str) -> Dict[str, ModuleType]:
+    """
+    Import all submodules of a module from an imported module
+    """
+    logger.info("Importing submodules in %s", package_name)
+    try:
+        package = importlib.import_module(package_name)
+    except ImportError as import_error:
+        msg = f"Module {package_name} not imported"
+        raise CollectionNotImportedError(msg) from import_error
+    result = {}
+    path = getattr(package, "__path__", None)
+    if path is None:
+        raise CollectionCantFindModulePathError(package)
+    for _loader, name, _is_pkg in pkgutil.walk_packages(package.__path__):
+        try:
+            result[name] = importlib.import_module(package_name + "." + name)
+        except (ImportError, SyntaxError) as error:
+            # TODO: Add a flag to show loading exceptions
+            logger.exception(error)
+            if not name.startswith("__"):
+                logger.error(f"Error loading {name} from {package_name}: {error}")
+
+    return result
+
+
+def clean_collection(collection: "InvokeToolkitCollection") -> None:
+    """Removes tasks that are imported from other modules or start with underscores"""
+
+    def user_facing_task(name: str, task: Task) -> bool:
+        if name.startswith("_"):
+            debug(f"Not adding task {name=} because it starts with _")
+            return False
+        *_, module_name = task.__module__.split(".")
+        # Make sure composed_col is composed-col
+        if module_name.replace("_", "-") != collection.name:
+            debug(f"Imported task from another place {module_name=} {collection.name=}")
+            return False
+
+        return True
+
+    collection.tasks = {
+        name: task
+        for name, task in collection.tasks.items()
+        # if not name.startswith("_")
+        if user_facing_task(name, task)
+    }
+
+
+class InvokeToolkitCollection(Collection):
+    """
+    This Collection allows to load sub-collections from python package paths/namespaces
+    like `myscripts.tasks.*`
+    """
+
+    @overload
+    def __init__(self, **kwargs) -> None: ...
+
+    @overload
+    def __init__(
+        self,
+        name: str,
+        *args: Union[Task, InvokeToolkitTask, Collection, "InvokeToolkitCollection"],
+        **kwargs,
+    ) -> None: ...
+
+    def __init__(
+        self, *args: Union[str, Task, InvokeToolkitTask, Collection], **kwargs
+    ) -> None:
+        debug(f"Instantiating collection with {args=} and {kwargs=}")
+        super().__init__(*args, **kwargs)
+
+    def _add_object(self, obj: Any, name: Optional[str] = None) -> None:
+        method: Callable
+        if isinstance(obj, (Task, InvokeToolkitTask)):
+            method = self.add_task
+        elif isinstance(obj, (InvokeToolkitCollection, Collection, ModuleType)):
+            method = self.add_collection
+        else:
+            raise TypeError("No idea how to insert {!r}!".format(type(obj)))
+        method(obj, name=name)
+
+    def add_collections_from_namespace(self, namespace: str):
+        """Iterates over a namespace and imports the submodules"""
+        # Attempt simple import
+        ok = False
+        if namespace not in sys.modules:
+            debug(f"Attempting simple import of {namespace}")
+            try:
+                importlib.import_module(namespace)
+                ok = True
+            except ImportError:
+                logger.warning(f"Failed to import  {namespace}")
+
+        if not ok:
+            debug("Starting stack inspection to find module")
+            # Trying to import relative to caller's script
+            caller_path = get_calling_file_path(
+                # We're going to get the path of the file where this call
+                # was made
+                find_call_text=".add_collections_from_namespace("
+            )
+            debug(f"Adding {caller_path} in order to import {namespace}")
+            sys.path.append(caller_path)
+            # This should work even if there's no __init__ alongside the
+            # program main
+            importlib.import_module(namespace)
+
+        for name, module in import_submodules(namespace).items():
+            coll = InvokeToolkitCollection.from_module(module)
+            # TODO: Discover if the namespace has configuration
+            #       collection.configure(config)
+            self.add_collection(coll=coll, name=name)
+
+    def load_plugins(self):
+        """
+        This will call to .add_collections_from_namespace but will ensure to
+        add the plugin folder to the sys.path
+        """
+
+    def load_directory(self, directory: Union[str, Path]) -> None:
+        """Loads tasks from a folder"""
+        if isinstance(directory, str):
+            path = Path(directory)
+        elif not isinstance(directory, Path):
+            msg = f"The directory to load plugins is not a str/Path: {directory}:{type(directory)}"
+            raise TypeError(msg)
+        else:
+            path = directory
+
+        existing_paths = {pth for pth in sys.path if Path(pth).is_dir()}
+        if path not in existing_paths:
+            sys.path.append(str(path))
+
+    @classmethod
+    def from_module(
+        cls, module, name=None, config=None, loaded_from=None, auto_dash_names=None
+    ) -> "InvokeToolkitCollection":
+        return super().from_module(module, name, config, loaded_from, auto_dash_names)
+
+    @classmethod
+    def from_package(
+        cls, package_path: str, into: "InvokeToolkitCollection"
+    ) -> "InvokeToolkitCollection":  # pylint: disable=too-many-branches)
+        """
+        Creates a collection from a package and configures it
+        """
+        ns = into or cls()
+        global_config: dict[str, str | dict[str, str]] = {}
+        for name, module in import_submodules(package_path).items():
+            config = getattr(module, "config", None)
+            collection: "InvokeToolkitCollection" = ns.from_module(module)
+            clean_collection(collection=collection)
+            # TODO: Namespaced configuration seems to be an not present when merged!§
+            # if config and isinstance(config, (dict, )):
+            #     debug(f"🔧 Adding config to module 📦 {name}: {config}")
+            #     collection.configure(config)
+            if config:
+                # FIXME: Detect coitions
+                if isinstance(config, (dict,)):
+                    debug(f"🔧 Adding config to module 📦 {name}: {config.keys()}")
+                    prefixed_config = {name: config}
+                    global_config.update(**prefixed_config)
+                else:
+                    debug(f"In the module {module} the config name is for {config}")
+            ns.add_collection(
+                collection,
+                name=name,
+            )
+
+        if global_config:
+            debug(f"Adding root collection configuration: {config}")
+            ns.configure(global_config)
+        return ns

{invoke_toolkit-0.0.4 → invoke_toolkit-0.0.7}/src/invoke_toolkit/config/config.py

@@ -3,16 +3,12 @@ Custom config class passed in every context class as .config
 This module defines some functions/callables
 """
 
-from typing import Any, Dict, Optional
+from typing import Any, Dict
 
 from invoke.config import Config
-from rich import inspect
-from rich.status import Status
 
-from invoke_toolkit.output import get_console, rich_exit
 
 from ..runners.rich import NoStdoutRunner
-from .status_helper import StatusHelper
 
 
 class InvokeToolkitConfig(Config):
@@ -21,8 +17,6 @@ class InvokeToolkitConfig(Config):
     such as .cd, .run, etc.
     """
 
-    _current_status: Optional[Status]
-
     @staticmethod
     def global_defaults() -> Dict[str, Any]:
         """
@@ -38,21 +32,6 @@ class InvokeToolkitConfig(Config):
         .. versionadded:: 1.0
         """
         ret: Dict[str, Any] = Config.global_defaults()
-        console = get_console()
-
-        status_helper = StatusHelper(console=console)
-
-        ret.update(
-            {
-                "console": console,
-                "status": status_helper.status,
-                "status_stop": status_helper.status_stop,
-                "status_update": status_helper.status_update,
-                "rich_exit": rich_exit,
-                "print": console.print,
-                "inspect": inspect,
-            }
-        )
         ret["runners"]["local"] = NoStdoutRunner
         ret["run"]["echo_format"] = "[bold]{command}[/bold]"
         return ret