invoke-toolkit 0.0.1__tar.gz

invoke_toolkit-0.0.1/.pre-commit-config.yaml

@@ -0,0 +1,43 @@
+# This is an example configuration to enable detect-secrets in the pre-commit hook.
+# Add this file to the root folder of your repository.
+#
+# Read pre-commit hook framework https://pre-commit.com/ for more details about the structure of config yaml file and how git pre-commit would invoke each hook.
+#
+# This line indicates we will use the hook from ibm/detect-secrets to run scan during committing phase.
+repos:
+  - repo: https://github.com/ibm/detect-secrets
+    # If you desire to use a specific version of detect-secrets, you can replace `master` with other git revisions such as branch, tag or commit sha.
+    # You are encouraged to use static refs such as tags, instead of branch name
+    #
+    # Running "pre-commit autoupdate" automatically updates rev to latest tag
+    rev: 0.13.1+ibm.61.dss
+    hooks:
+      - id: detect-secrets # pragma: whitelist secret
+        # Add options for detect-secrets-hook binary. You can run `detect-secrets-hook --help` to list out all possible options.
+        # You may also run `pre-commit run detect-secrets` to preview the scan result.
+        # when "--baseline" without "--use-all-plugins", pre-commit scan with just plugins in baseline file
+        # when "--baseline" with "--use-all-plugins", pre-commit scan with all available plugins
+        # add "--fail-on-unaudited" to fail pre-commit for unaudited potential secrets
+        args: [--baseline, .secrets.baseline, --use-all-plugins]
+        exclude: 'src/fp_helper/_vendor/.*'
+        
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.1.6
+    hooks:
+      # Run the linter.
+      - id: ruff
+        args: [ --fix ]
+        exclude: 'src/.*'
+      # Run the formatter.
+      - id: ruff-format
+        # exclude: 'src/.*'
+
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.2.4
+    hooks:
+      - id: codespell
+        types_or: [python, rst, markdown, cython, c]
+        additional_dependencies: [tomli]
+        # exclude: 'src/.*'

invoke_toolkit-0.0.1/.secrets.baseline

@@ -0,0 +1,85 @@
+{
+  "exclude": {
+    "files": "^.secrets.baseline$",
+    "lines": null
+  },
+  "generated_at": "2024-08-04T19:48:23Z",
+  "plugins_used": [
+    {
+      "name": "AWSKeyDetector"
+    },
+    {
+      "name": "ArtifactoryDetector"
+    },
+    {
+      "name": "AzureStorageKeyDetector"
+    },
+    {
+      "base64_limit": 4.5,
+      "name": "Base64HighEntropyString"
+    },
+    {
+      "name": "BasicAuthDetector"
+    },
+    {
+      "name": "BoxDetector"
+    },
+    {
+      "name": "CloudantDetector"
+    },
+    {
+      "ghe_instance": "github.ibm.com",
+      "name": "GheDetector"
+    },
+    {
+      "name": "GitHubTokenDetector"
+    },
+    {
+      "hex_limit": 3,
+      "name": "HexHighEntropyString"
+    },
+    {
+      "name": "IbmCloudIamDetector"
+    },
+    {
+      "name": "IbmCosHmacDetector"
+    },
+    {
+      "name": "JwtTokenDetector"
+    },
+    {
+      "keyword_exclude": null,
+      "name": "KeywordDetector"
+    },
+    {
+      "name": "MailchimpDetector"
+    },
+    {
+      "name": "NpmDetector"
+    },
+    {
+      "name": "PrivateKeyDetector"
+    },
+    {
+      "name": "SlackDetector"
+    },
+    {
+      "name": "SoftlayerDetector"
+    },
+    {
+      "name": "SquareOAuthDetector"
+    },
+    {
+      "name": "StripeDetector"
+    },
+    {
+      "name": "TwilioKeyDetector"
+    }
+  ],
+  "results": {},
+  "version": "0.13.1+ibm.61.dss",
+  "word_list": {
+    "file": null,
+    "hash": null
+  }
+}

invoke_toolkit-0.0.1/.vscode/launch.json

@@ -0,0 +1,23 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Python Debugger: Current File",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "${file}",
+            "console": "integratedTerminal"
+        },
+        {
+            "name": "Python Debugger: Test program (tests/program/main)",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "${workspaceFolder}/tests/program/main.py",
+            "console": "integratedTerminal",
+            "cwd": "${workspaceFolder}/tests/program/"
+        }
+    ]
+}

invoke_toolkit-0.0.1/.vscode/settings.json

@@ -0,0 +1,25 @@
+{
+    "workbench.colorCustomizations": {
+        "activityBar.activeBackground": "#ba5c56",
+        "activityBar.background": "#ba5c56",
+        "activityBar.foreground": "#e7e7e7",
+        "activityBar.inactiveForeground": "#e7e7e799",
+        "activityBarBadge.background": "#77c87c",
+        "activityBarBadge.foreground": "#15202b",
+        "commandCenter.border": "#e7e7e799",
+        "sash.hoverBorder": "#ba5c56",
+        "statusBar.background": "#9d4640",
+        "statusBar.foreground": "#e7e7e7",
+        "statusBarItem.hoverBackground": "#ba5c56",
+        "statusBarItem.remoteBackground": "#9d4640",
+        "statusBarItem.remoteForeground": "#e7e7e7",
+        "titleBar.activeBackground": "#9d4640",
+        "titleBar.activeForeground": "#e7e7e7",
+        "titleBar.inactiveBackground": "#9d464099",
+        "titleBar.inactiveForeground": "#e7e7e799"
+    },
+    "peacock.color": "#9d4640",
+    "ruff.format.preview": true,
+    "ruff.lint.preview": true,
+    "ruff.showNotifications": "onWarning"
+}

invoke_toolkit-0.0.1/LICENSE.txt

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2024-present Nahuel Defossé <nahuel.deofsse@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

invoke_toolkit-0.0.1/PKG-INFO

@@ -0,0 +1,84 @@
+Metadata-Version: 2.3
+Name: invoke-toolkit
+Version: 0.0.1
+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
+Project-URL: Source, https://github.com/D3f0/invoke-toolkit
+Author-email: Nahuel Defossé <D3f0@users.noreply.github.com>
+License-Expression: MIT
+License-File: LICENSE.txt
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: Unix
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Build Tools
+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-Dist: invoke
+Requires-Dist: rich
+Description-Content-Type: text/markdown
+
+# invoke-toolkit
+
+A set of extended APIs for PyInvoke for composable scripts, plugins and richer output.
+
+This extends the Collection from Invoke so it can create automatically collections.
+
+[![PyPI - Version](https://img.shields.io/pypi/v/invoke-toolkit.svg)](https://pypi.org/project/invoke-toolkit)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/invoke-toolkit.svg)](https://pypi.org/project/invoke-toolkit)
+
+-----
+
+## Table of Contents
+
+- [invoke-toolkit](#invoke-toolkit)
+  - [Table of Contents](#table-of-contents)
+  - [Features](#features)
+  - [Do I need this package](#do-i-need-this-package)
+  - [Installation](#installation)
+  - [Development](#development)
+  - [License](#license)
+
+## Features
+
+- Task discovery by namespace for extendable/composable CLIs
+- Discovery to *plain old* tasks.py (or any other name)
+- Integration with stand alone binaries for specific tasks
+- **Future** Download binaries
+
+## Do I need this package
+
+If you have...
+
+- Used `invoke` for a while and...
+- Have a large `tasks.py` that needs to be modularized
+- Have a lot of copy/pasted code in multiple `tasks.py` across multiple repos.
+- Have exceeded the approach of a repository cloned as `~/tasks/` with more .py files that you want to manage.
+- Or you want to combine various tasks defined in multiple directories
+- You want to create a zipped (shiv) redistribute script for container environments
+  like Kubernetes based CI environments with only requiring the Python interpreter.
+
+## Installation
+
+```console
+pip install invoke-toolkit
+```
+
+## Development
+
+This project utilizes the `pre-commit` framework, make sure you run:
+
+`pre-commit install`
+
+## License
+
+`invoke-toolkit` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

invoke_toolkit-0.0.1/README.md

@@ -0,0 +1,55 @@
+# invoke-toolkit
+
+A set of extended APIs for PyInvoke for composable scripts, plugins and richer output.
+
+This extends the Collection from Invoke so it can create automatically collections.
+
+[![PyPI - Version](https://img.shields.io/pypi/v/invoke-toolkit.svg)](https://pypi.org/project/invoke-toolkit)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/invoke-toolkit.svg)](https://pypi.org/project/invoke-toolkit)
+
+-----
+
+## Table of Contents
+
+- [invoke-toolkit](#invoke-toolkit)
+  - [Table of Contents](#table-of-contents)
+  - [Features](#features)
+  - [Do I need this package](#do-i-need-this-package)
+  - [Installation](#installation)
+  - [Development](#development)
+  - [License](#license)
+
+## Features
+
+- Task discovery by namespace for extendable/composable CLIs
+- Discovery to *plain old* tasks.py (or any other name)
+- Integration with stand alone binaries for specific tasks
+- **Future** Download binaries
+
+## Do I need this package
+
+If you have...
+
+- Used `invoke` for a while and...
+- Have a large `tasks.py` that needs to be modularized
+- Have a lot of copy/pasted code in multiple `tasks.py` across multiple repos.
+- Have exceeded the approach of a repository cloned as `~/tasks/` with more .py files that you want to manage.
+- Or you want to combine various tasks defined in multiple directories
+- You want to create a zipped (shiv) redistribute script for container environments
+  like Kubernetes based CI environments with only requiring the Python interpreter.
+
+## Installation
+
+```console
+pip install invoke-toolkit
+```
+
+## Development
+
+This project utilizes the `pre-commit` framework, make sure you run:
+
+`pre-commit install`
+
+## License
+
+`invoke-toolkit` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

invoke_toolkit-0.0.1/pyproject.toml

@@ -0,0 +1,94 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+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"
+license = "MIT"
+keywords = []
+authors = [
+  { name = "Nahuel Defossé", email = "D3f0@users.noreply.github.com" },
+]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Environment :: Console",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: Implementation :: CPython",
+  "Operating System :: POSIX",
+  "Operating System :: Unix",
+  "Operating System :: MacOS :: MacOS X",
+  "Topic :: Software Development",
+  "Topic :: Software Development :: Build Tools",
+  "Topic :: Software Development :: Libraries",
+  "Topic :: Software Development :: Libraries :: Python Modules",
+  "Topic :: System :: Software Distribution",
+  "Topic :: System :: Systems Administration",
+]
+
+dependencies = [
+  "invoke",
+  "rich"
+]
+
+[project.urls]
+Documentation = "https://github.com/D3f0/invoke-toolkit#readme"
+Issues = "https://github.com/D3f0/invoke-toolkit/issues"
+Source = "https://github.com/D3f0/invoke-toolkit"
+
+[tool.hatch.version]
+path = "src/invoke_toolkit/__about__.py"
+
+[tool.hatch.envs.types]
+extra-dependencies = [
+  "mypy>=1.0.0",
+]
+[tool.hatch.envs.types.scripts]
+check = "mypy --install-types --non-interactive {args:src/invoke_toolkit tests}"
+
+[tool.coverage.run]
+source_pkgs = ["invoke_toolkit", "tests"]
+branch = true
+parallel = true
+omit = [
+  "src/invoke_toolkit/__about__.py",
+]
+
+[tool.coverage.paths]
+invoke_toolkit = ["src/invoke_toolkit", "*/invoke-toolkit/src/invoke_toolkit"]
+tests = ["tests", "*/invoke-toolkit/tests"]
+
+[tool.coverage.report]
+exclude_lines = [
+  "no cov",
+  "if __name__ == .__main__.:",
+  "if TYPE_CHECKING:",
+]
+
+
+[tool.hatch.envs.dev]
+dependencies = [
+  # Invoke's original set of tasks
+  "pytest",
+  "pytest-virtualenv",
+  "coverage",
+  "pdbpp",
+]
+[tool.hatch.envs.dev.scripts]
+run-coverage = "pytest --cov-config=pyproject.toml --cov=pkg --cov=tests"
+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"]

invoke_toolkit-0.0.1/src/invoke_toolkit/__about__.py

@@ -0,0 +1,4 @@
+# SPDX-FileCopyrightText: 2024-present Nahuel Defossé <nahuel.deofsse@gmail.com>
+#
+# SPDX-License-Identifier: MIT
+__version__ = "0.0.1"

invoke_toolkit-0.0.1/src/invoke_toolkit/__init__.py

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: 2024-present Nahuel Defossé <nahuel.deofsse@gmail.com>
+#
+# SPDX-License-Identifier: MIT

invoke_toolkit-0.0.1/src/invoke_toolkit/collections.py

@@ -0,0 +1,100 @@
+import importlib
+import pkgutil
+import sys
+from pathlib import Path
+from types import ModuleType
+from typing import Dict, Union
+
+from invoke.collection import Collection as InvokeCollection
+from invoke.util import debug
+
+from invoke_toolkit.utils.inspection import get_calling_file_path
+
+
+class CollectionError(Exception):
+    """Base class for import discovery errors"""
+
+
+class CollectionNotImportedError(CollectionError):
+    ...
+
+
+def import_submodules(package_name: str) -> Dict[str, ModuleType]:
+    """
+    Import all submodules of a module from an imported module
+
+    :param package_name: Package name
+    :type package_name: str
+    :rtype: dict[types.ModuleType]
+    """
+    debug("Importing submodules in %s", package_name)
+    try:
+        package = sys.modules[package_name]
+    except ImportError as import_error:
+        msg = f"Module {package_name} not imported"
+        raise CollectionNotImportedError(msg) from import_error
+    result = {}
+    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:
+            if not name.startswith("__"):
+                debug(f"Error loading {name}: {error}")
+            else:
+                debug(f"Error loading {name}: {error}")
+
+    return result
+
+
+class Collection(InvokeCollection):
+    """
+    This Collection allows to load sub-collections from python package paths/namespaces
+    like `myscripts.tasks.*`
+    """
+
+    def add_collections_from_namespace(self, namespace: str) -> bool:
+        """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:
+                debug(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 = Collection.from_module(module)
+            self.add_collection(coll=coll, name=name)
+
+    def load_plugins(self):
+        ...
+
+    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))

invoke_toolkit-0.0.1/src/invoke_toolkit/tasks/completion.py

@@ -0,0 +1,9 @@
+from invoke import Context, task
+
+
+@task(default=True)
+def install(ctx: Context):
+    """
+    Installation of Python completions.
+    This is a re-implementation of inv[oke] --print-completion-script
+    """

invoke_toolkit-0.0.1/src/invoke_toolkit/tasks/dist.py

@@ -0,0 +1,3 @@
+"""
+Generate self contained distributable scripts
+"""

invoke_toolkit-0.0.1/src/invoke_toolkit/tasks/plugin.py

@@ -0,0 +1,16 @@
+from invoke import Context, task
+
+
+@task(default=True)
+def list_(ctx: Context):
+    """List plugins"""
+
+
+@task(default=True)
+def add(ctx: Context, plugin_spec: str) -> None:
+    """Add a plugin"""
+
+
+@task(default=True)
+def remove(ctx: Context, name: str) -> None:
+    """Add a plugin"""

invoke_toolkit-0.0.1/src/invoke_toolkit/utils/inspection.py

@@ -0,0 +1,41 @@
+import inspect
+import sys
+from pathlib import Path
+from typing import Optional
+
+from invoke.util import debug
+from rich import print
+
+# def print_call_stack():
+#     """Prints the current call stack."""
+#     for frame_info in inspect.stack():
+#         filename, lineno, function, code_context, index = frame_info
+#         print(f"File: {filename}, Line: {lineno}, Function: {function}")
+
+
+def print_rich_frames(frames: list):
+    print(frames, file=sys.stderr)
+
+
+def get_calling_file_path(find_call_text: str) -> Optional[str]:
+    """Returns the containing folder of the module where the find_call_text is located"""
+
+    # Get the frame object of the caller
+    start_offset = 2
+    stack = inspect.stack()
+    index_frame_dict = dict(enumerate(stack[start_offset:]))
+    # print_rich_frames(stack[:2])
+    # ...
+    # print_rich_frames(index_frame_dict)
+    frame = None
+    found = False
+    for i, frame in index_frame_dict.items():
+        if any(find_call_text in line for line in frame.code_context):
+            debug(f"Found '{find_call_text}' in {frame}, call offset {i+2}")
+            found = True
+            break
+    if not found:
+        return None
+    # Get the module object of the caller
+    containing_directory = str(Path(frame.filename).parent.parent)
+    return containing_directory

invoke_toolkit-0.0.1/tasks.py

@@ -0,0 +1,24 @@
+from invoke import task, Context
+import subprocess
+
+REPO_ROOT = (
+    subprocess.check_output("git rev-parse --show-toplevel", shell="sh")
+    .strip()
+    .decode()
+)
+
+
+@task()
+def build(ctx: Context):
+    ctx.run("hatch build", pty=True)
+
+
+@task()
+def test(ctx: Context):
+    ctx.run("hatch run dev:pytest", pty=True)
+
+
+@task()
+def clean_dist(ctx: Context):
+    with ctx.cd(REPO_ROOT):
+        ctx.run("dist/*")

invoke_toolkit-0.0.1/tests/__init__.py

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: 2024-present Nahuel Defossé <nahuel.deofsse@gmail.com>
+#
+# SPDX-License-Identifier: MIT

invoke_toolkit-0.0.1/tests/program/main.py

@@ -0,0 +1,16 @@
+from invoke.program import Program
+
+from invoke_toolkit.collections import Collection
+
+
+class TestProgram:
+    ...
+
+
+ns = Collection()
+ns.add_collections_from_namespace("program.tasks")
+program = Program(name="test program", version="0.0.1", namespace=ns)
+
+
+if __name__ == "__main__":
+    program.run()

invoke_toolkit-0.0.1/tests/program/tasks/coll1.py

@@ -0,0 +1,6 @@
+from invoke import task
+
+
+@task()
+def task1(c):
+    ...

invoke_toolkit-0.0.1/tests/test_collection.py

@@ -0,0 +1,39 @@
+import importlib
+import pkgutil
+import sys
+import types
+from unittest import mock
+
+from invoke_toolkit.collections import Collection
+
+
+def my_function(package_path):
+    modules = []
+    for _, module_name, _ in pkgutil.walk_packages([package_path]):
+        modules.append(module_name)
+    return modules
+
+
+def test_collection_load_submodules(monkeypatch):
+    ns = Collection()
+
+    def mock_walk_packages(path):
+        # Simulate modules
+        module1 = types.ModuleType("not_to_import")
+        module2 = types.ModuleType("to_import.tasks.mod1")
+        module3 = types.ModuleType("to_import.tasks.mod2")
+        return [
+            ("module1", "", module1),
+            ("to_import.tasks.mod1", "", module2),
+            ("to_import.tasks.mod2", "", module3),
+        ]
+
+    def mock_import_module(name):
+        monkeypatch.setitem(name, types.ModuleType(name=name))
+
+    monkeypatch.setattr(importlib, "import_module", mock.MagicMock())
+    monkeypatch.setattr(pkgutil, "walk_packages", mock_walk_packages)
+    module_to_import = types.ModuleType(name="to_import")
+    monkeypatch.setitem(sys.modules, "to_import.tasks", module_to_import)
+    result = ns.add_collections_from_namespace("to_import.tasks")
+    breakpoint()