janito 3.14.1__py3-none-any.whl → 3.15.0__py3-none-any.whl

janito/tools/tool_base.py

@@ -1,121 +1,122 @@
-from janito.report_events import ReportEvent, ReportSubtype, ReportAction
-from janito.event_bus.bus import event_bus as default_event_bus
-
-import inspect
-from collections import namedtuple
-
-
-class ToolPermissions(namedtuple("ToolPermissions", ["read", "write", "execute"])):
-    __slots__ = ()
-
-    def __new__(cls, read=False, write=False, execute=False):
-        return super().__new__(cls, read, write, execute)
-
-    def __repr__(self):
-        return f"ToolPermissions(read={self.read}, write={self.write}, execute={self.execute})"
-
-
-class ToolBase:
-    """
-    Base class for all tools in the janito project.
-    Extend this class to implement specific tool functionality.
-    """
-
-    permissions: "ToolPermissions" = None  # Required: must be set by subclasses
-
-    def __init__(self, name=None, event_bus=None):
-        if self.permissions is None or not isinstance(
-            self.permissions, ToolPermissions
-        ):
-            raise ValueError(
-                f"Tool '{self.__class__.__name__}' must define a 'permissions' attribute of type ToolPermissions."
-            )
-        self.name = name or self.__class__.__name__
-        self._event_bus = event_bus or default_event_bus
-
-    @property
-    def event_bus(self):
-        return self._event_bus
-
-    @event_bus.setter
-    def event_bus(self, bus):
-        self._event_bus = bus or default_event_bus
-
-    def report_action(self, message: str, action: ReportAction, context: dict = None):
-        """
-        Report that a tool action is starting. This should be the first reporting call for every tool action.
-        """
-        self._event_bus.publish(
-            ReportEvent(
-                subtype=ReportSubtype.ACTION_INFO,
-                message="  " + message,
-                action=action,
-                tool=self.name,
-                context=context,
-            )
-        )
-
-    def report_error(self, message: str, context: dict = None):
-        self._event_bus.publish(
-            ReportEvent(
-                subtype=ReportSubtype.ERROR,
-                message=message,
-                action=None,
-                tool=self.name,
-                context=context,
-            )
-        )
-
-    def report_success(self, message: str, context: dict = None):
-        self._event_bus.publish(
-            ReportEvent(
-                subtype=ReportSubtype.SUCCESS,
-                message=message,
-                action=None,
-                tool=self.name,
-                context=context,
-            )
-        )
-
-    def report_warning(self, message: str, context: dict = None):
-        self._event_bus.publish(
-            ReportEvent(
-                subtype=ReportSubtype.WARNING,
-                message=message,
-                action=None,
-                tool=self.name,
-                context=context,
-            )
-        )
-
-    def report_stdout(self, message: str, context: dict = None):
-        self._event_bus.publish(
-            ReportEvent(
-                subtype=ReportSubtype.STDOUT,
-                message=message,
-                action=None,
-                tool=self.name,
-                context=context,
-            )
-        )
-
-    def report_stderr(self, message: str, context: dict = None):
-        self._event_bus.publish(
-            ReportEvent(
-                subtype=ReportSubtype.STDERR,
-                message=message,
-                action=None,
-                tool=self.name,
-                context=context,
-            )
-        )
-
-    def run(self, *args, **kwargs):
-        raise NotImplementedError("Subclasses must implement the run method.")
-
-    def get_signature(self):
-        """
-        Return the function signature for this tool's run method.
-        This is used for introspection and validation.
-        """
-        return inspect.signature(self.run)
+from janito.report_events import ReportEvent, ReportSubtype, ReportAction
+from janito.event_bus.bus import event_bus as default_event_bus
+from janito.tools.base import BaseTool
+
+import inspect
+from collections import namedtuple
+
+
+class ToolPermissions(namedtuple("ToolPermissions", ["read", "write", "execute"])):
+    __slots__ = ()
+
+    def __new__(cls, read=False, write=False, execute=False):
+        return super().__new__(cls, read, write, execute)
+
+    def __repr__(self):
+        return f"ToolPermissions(read={self.read}, write={self.write}, execute={self.execute})"
+
+
+class ToolBase(BaseTool):
+    """
+    Base class for all tools in the janito project.
+    Extend this class to implement specific tool functionality.
+    """
+
+    permissions: "ToolPermissions" = None  # Required: must be set by subclasses
+
+    def __init__(self, name=None, event_bus=None):
+        if self.permissions is None or not isinstance(
+            self.permissions, ToolPermissions
+        ):
+            raise ValueError(
+                f"Tool '{self.__class__.__name__}' must define a 'permissions' attribute of type ToolPermissions."
+            )
+        self.name = name or self.__class__.__name__
+        self._event_bus = event_bus or default_event_bus
+
+    @property
+    def event_bus(self):
+        return self._event_bus
+
+    @event_bus.setter
+    def event_bus(self, bus):
+        self._event_bus = bus or default_event_bus
+
+    def report_action(self, message: str, action: ReportAction, context: dict = None):
+        """
+        Report that a tool action is starting. This should be the first reporting call for every tool action.
+        """
+        self._event_bus.publish(
+            ReportEvent(
+                subtype=ReportSubtype.ACTION_INFO,
+                message="  " + message,
+                action=action,
+                tool=self.name,
+                context=context,
+            )
+        )
+
+    def report_error(self, message: str, context: dict = None):
+        self._event_bus.publish(
+            ReportEvent(
+                subtype=ReportSubtype.ERROR,
+                message=message,
+                action=None,
+                tool=self.name,
+                context=context,
+            )
+        )
+
+    def report_success(self, message: str, context: dict = None):
+        self._event_bus.publish(
+            ReportEvent(
+                subtype=ReportSubtype.SUCCESS,
+                message=message,
+                action=None,
+                tool=self.name,
+                context=context,
+            )
+        )
+
+    def report_warning(self, message: str, context: dict = None):
+        self._event_bus.publish(
+            ReportEvent(
+                subtype=ReportSubtype.WARNING,
+                message=message,
+                action=None,
+                tool=self.name,
+                context=context,
+            )
+        )
+
+    def report_stdout(self, message: str, context: dict = None):
+        self._event_bus.publish(
+            ReportEvent(
+                subtype=ReportSubtype.STDOUT,
+                message=message,
+                action=None,
+                tool=self.name,
+                context=context,
+            )
+        )
+
+    def report_stderr(self, message: str, context: dict = None):
+        self._event_bus.publish(
+            ReportEvent(
+                subtype=ReportSubtype.STDERR,
+                message=message,
+                action=None,
+                tool=self.name,
+                context=context,
+            )
+        )
+
+    def run(self, *args, **kwargs):
+        raise NotImplementedError("Subclasses must implement the run method.")
+
+    def get_signature(self):
+        """
+        Return the function signature for this tool's run method.
+        This is used for introspection and validation.
+        """
+        return inspect.signature(self.run)

janito/tools/tools_schema.py

@@ -1,104 +1,104 @@
-import inspect
-import typing
-import re
-
-
-class ToolSchemaBase:
-    def parse_param_section(self, lines, param_section_headers):
-        param_descs = {}
-        in_params = False
-        for line in lines:
-            stripped_line = line.strip()
-            if any(
-                stripped_line.lower().startswith(h + ":") or stripped_line.lower() == h
-                for h in param_section_headers
-            ):
-                in_params = True
-                continue
-            if in_params:
-                m = re.match(
-                    r"([a-zA-Z_][a-zA-Z0-9_]*)\s*(?:\(([^)]+)\))?\s*[:\-]?\s*(.+)",
-                    stripped_line,
-                )
-                if m:
-                    param, _, desc = m.groups()
-                    param_descs[param] = desc.strip()
-                elif stripped_line and stripped_line[0] != "-":
-                    if param_descs:
-                        last = list(param_descs)[-1]
-                        param_descs[last] += " " + stripped_line
-            if (
-                stripped_line.lower().startswith("returns:")
-                or stripped_line.lower() == "returns"
-            ):
-                break
-        return param_descs
-
-    def parse_return_section(self, lines):
-        in_returns = False
-        return_desc = ""
-        for line in lines:
-            stripped_line = line.strip()
-            if (
-                stripped_line.lower().startswith("returns:")
-                or stripped_line.lower() == "returns"
-            ):
-                in_returns = True
-                continue
-            if in_returns:
-                if stripped_line:
-                    return_desc += (" " if return_desc else "") + stripped_line
-        return return_desc
-
-    def parse_docstring(self, docstring: str):
-        if not docstring:
-            return "", {}, ""
-        lines = docstring.strip().split("\n")
-        summary = lines[0].strip()
-        param_section_headers = ("args", "arguments", "params", "parameters")
-        param_descs = self.parse_param_section(lines[1:], param_section_headers)
-        return_desc = self.parse_return_section(lines[1:])
-        return summary, param_descs, return_desc
-
-    def validate_tool_class(self, tool_class):
-        if not hasattr(tool_class, "tool_name") or not isinstance(
-            tool_class.tool_name, str
-        ):
-            raise ValueError(
-                "Tool class must have a class-level 'tool_name' attribute (str) for registry and schema generation."
-            )
-        if not hasattr(tool_class, "run") or not callable(getattr(tool_class, "run")):
-            raise ValueError("Tool class must have a callable 'run' method.")
-        func = tool_class.run
-        tool_name = tool_class.tool_name
-        sig = inspect.signature(func)
-        if sig.return_annotation is inspect._empty or sig.return_annotation is not str:
-            raise ValueError(
-                f"Tool '{tool_name}' must have an explicit return type of 'str'. Found: {sig.return_annotation}"
-            )
-        missing_type_hints = [
-            name
-            for name, param in sig.parameters.items()
-            if name != "self" and param.annotation is inspect._empty
-        ]
-        if missing_type_hints:
-            raise ValueError(
-                f"Tool '{tool_name}' is missing type hints for parameter(s): {', '.join(missing_type_hints)}.\nAll parameters must have explicit type hints for schema generation."
-            )
-        class_doc = (
-            tool_class.__doc__.strip() if tool_class and tool_class.__doc__ else ""
-        )
-        summary, param_descs, return_desc = self.parse_docstring(class_doc)
-        description = summary
-        if return_desc:
-            description += f"\n\nReturns: {return_desc}"
-        undocumented = [
-            name
-            for name, param in sig.parameters.items()
-            if name != "self" and name not in param_descs
-        ]
-        if undocumented:
-            raise ValueError(
-                f"Tool '{tool_name}' is missing docstring documentation for parameter(s): {', '.join(undocumented)}.\nParameter documentation must be provided in the Tool class docstring, not the method docstring."
-            )
-        return func, tool_name, sig, summary, param_descs, return_desc, description
+import inspect
+import typing
+import re
+
+
+class ToolSchemaBase:
+    def parse_param_section(self, lines, param_section_headers):
+        param_descs = {}
+        in_params = False
+        for line in lines:
+            stripped_line = line.strip()
+            if any(
+                stripped_line.lower().startswith(h + ":") or stripped_line.lower() == h
+                for h in param_section_headers
+            ):
+                in_params = True
+                continue
+            if in_params:
+                m = re.match(
+                    r"([a-zA-Z_][a-zA-Z0-9_]*)\s*(?:\(([^)]+)\))?\s*[:\-]?\s*(.+)",
+                    stripped_line,
+                )
+                if m:
+                    param, _, desc = m.groups()
+                    param_descs[param] = desc.strip()
+                elif stripped_line and stripped_line[0] != "-":
+                    if param_descs:
+                        last = list(param_descs)[-1]
+                        param_descs[last] += " " + stripped_line
+            if (
+                stripped_line.lower().startswith("returns:")
+                or stripped_line.lower() == "returns"
+            ):
+                break
+        return param_descs
+
+    def parse_return_section(self, lines):
+        in_returns = False
+        return_desc = ""
+        for line in lines:
+            stripped_line = line.strip()
+            if (
+                stripped_line.lower().startswith("returns:")
+                or stripped_line.lower() == "returns"
+            ):
+                in_returns = True
+                continue
+            if in_returns:
+                if stripped_line:
+                    return_desc += (" " if return_desc else "") + stripped_line
+        return return_desc
+
+    def parse_docstring(self, docstring: str):
+        if not docstring:
+            return "", {}, ""
+        lines = docstring.strip().split("\n")
+        summary = lines[0].strip()
+        param_section_headers = ("args", "arguments", "params", "parameters")
+        param_descs = self.parse_param_section(lines[1:], param_section_headers)
+        return_desc = self.parse_return_section(lines[1:])
+        return summary, param_descs, return_desc
+
+    def validate_tool_class(self, tool_class):
+        # Create instance to get tool_name property
+        instance = tool_class()
+        tool_name = instance.tool_name
+        if not tool_name or not isinstance(tool_name, str):
+            raise ValueError(
+                "Tool class must have a valid 'tool_name' property for registry and schema generation."
+            )
+        if not hasattr(tool_class, "run") or not callable(getattr(tool_class, "run")):
+            raise ValueError("Tool class must have a callable 'run' method.")
+        func = tool_class.run
+        sig = inspect.signature(func)
+        if sig.return_annotation is inspect._empty or sig.return_annotation is not str:
+            raise ValueError(
+                f"Tool '{tool_name}' must have an explicit return type of 'str'. Found: {sig.return_annotation}"
+            )
+        missing_type_hints = [
+            name
+            for name, param in sig.parameters.items()
+            if name != "self" and param.annotation is inspect._empty
+        ]
+        if missing_type_hints:
+            raise ValueError(
+                f"Tool '{tool_name}' is missing type hints for parameter(s): {', '.join(missing_type_hints)}.\nAll parameters must have explicit type hints for schema generation."
+            )
+        class_doc = (
+            tool_class.__doc__.strip() if tool_class and tool_class.__doc__ else ""
+        )
+        summary, param_descs, return_desc = self.parse_docstring(class_doc)
+        description = summary
+        if return_desc:
+            description += f"\n\nReturns: {return_desc}"
+        undocumented = [
+            name
+            for name, param in sig.parameters.items()
+            if name != "self" and name not in param_descs
+        ]
+        if undocumented:
+            raise ValueError(
+                f"Tool '{tool_name}' is missing docstring documentation for parameter(s): {', '.join(undocumented)}.\nParameter documentation must be provided in the Tool class docstring, not the method docstring."
+            )
+        return func, tool_name, sig, summary, param_descs, return_desc, description

{janito-3.14.1.dist-info → janito-3.15.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: janito
-Version: 3.14.1
+Version: 3.15.0
 Summary: A new Python package called janito.
 Author-email: João Pinto <janito@ikignosis.org>
 Project-URL: Homepage, https://github.com/ikignosis/janito
@@ -40,7 +40,7 @@ Dynamic: license-file
 $ janito --help
 Usage: janito <command>
 
-Interact with Nine API resources. See https://docs.nineapis.ch for the full API docs.
+A command-line tool for managing your projects.
 
 Run "janito <command> --help" for more information on a command.
 ```
@@ -48,38 +48,15 @@ Run "janito <command> --help" for more information on a command.
 ## Setup
 
 ```bash
-# If you have go already installed
-go install github.com/ninech/janito@latest
+# Install using pip
+pip install janito
 
-# Homebrew
-brew install ninech/taps/janito
-
-# Debian/Ubuntu
-echo "deb [trusted=yes] https://repo.nine.ch/deb/ /" | sudo tee /etc/apt/sources.list.d/repo.nine.ch.list
-sudo apt-get update
-sudo apt-get install janito
-
-# Fedora/RHEL
-cat <<EOF > /etc/yum.repos.d/repo.nine.ch.repo
-[repo.nine.ch]
-name=Nine Repo
-baseurl=https://repo.nine.ch/yum/
-enabled=1
-gpgcheck=0
-EOF
-dnf install janito
-
-# Arch
-# Install yay: https://github.com/Jguer/yay#binary
-yay --version
-yay -S janito-bin
+# Or install from source
+git clone https://github.com/yourusername/janito.git
+cd janito
+pip install -e .
 ```
 
-For Windows users, janito is also built for arm64 and amd64. You can download the
-latest exe file from the [releases](https://github.com/ninech/janito/releases) and
-install it.
-
 ## Getting started
 
-* login to the API using `janito auth login`
-* run `janito --help` to get a list of all available commands
+* Run `janito --help` to get a list of all available commands