janito 2.3.1__py3-none-any.whl → 2.4.0__py3-none-any.whl

janito/tools/adapters/local/validate_file_syntax/core.py

@@ -1,6 +1,6 @@
 import os
 from janito.i18n import tr
-from janito.tools.tool_base import ToolBase
+from janito.tools.tool_base import ToolBase, ToolPermissions
 from janito.report_events import ReportAction
 from janito.tools.adapters.local.adapter import register_local_tool
 from janito.tools.tool_utils import display_path
@@ -82,7 +82,7 @@ class ValidateFileSyntaxTool(ToolBase):
             - "⚠️ Warning: Syntax error: <error message>"
             - "⚠️ Warning: Unsupported file extension: <ext>"
     """
-
+    permissions = ToolPermissions(read=True)
     tool_name = "validate_file_syntax"
 
     def run(self, file_path: str) -> str:

janito/tools/adapters/local/view_file.py

@@ -1,4 +1,4 @@
-from janito.tools.tool_base import ToolBase
+from janito.tools.tool_base import ToolBase, ToolPermissions
 from janito.report_events import ReportAction
 from janito.tools.adapters.local.adapter import register_local_tool
 from janito.tools.tool_utils import pluralize
@@ -25,6 +25,7 @@ class ViewFileTool(ToolBase):
             - "❗ not found"
     """
 
+    permissions = ToolPermissions(read=True)
     tool_name = "view_file"
 
     def run(self, file_path: str, from_line: int = None, to_line: int = None) -> str:

janito/tools/permissions.py

@@ -0,0 +1,45 @@
+from janito.tools.tool_base import ToolPermissions
+
+class AllowedPermissionsState:
+    _instance = None
+    _permissions = ToolPermissions(read=False, write=False, execute=False)
+    _default_permissions = None
+
+    def __new__(cls):
+        if cls._instance is None:
+            cls._instance = super().__new__(cls)
+        return cls._instance
+
+    @classmethod
+    def get_permissions(cls):
+        return cls._permissions
+
+    @classmethod
+    def set_permissions(cls, permissions):
+        if not isinstance(permissions, ToolPermissions):
+            raise ValueError("permissions must be a ToolPermissions instance")
+        cls._permissions = permissions
+
+    @classmethod
+    def set_default_permissions(cls, permissions):
+        if not isinstance(permissions, ToolPermissions):
+            raise ValueError("permissions must be a ToolPermissions instance")
+        cls._default_permissions = permissions
+
+    @classmethod
+    def get_default_permissions(cls):
+        return cls._default_permissions
+
+# Convenience functions
+
+def get_global_allowed_permissions():
+    return AllowedPermissionsState.get_permissions()
+
+def set_global_allowed_permissions(permissions):
+    AllowedPermissionsState.set_permissions(permissions)
+
+def set_default_allowed_permissions(permissions):
+    AllowedPermissionsState.set_default_permissions(permissions)
+
+def get_default_allowed_permissions():
+    return AllowedPermissionsState.get_default_permissions()

janito/tools/permissions_parse.py

@@ -0,0 +1,12 @@
+from janito.tools.tool_base import ToolPermissions
+
+def parse_permissions_string(perm_str: str) -> ToolPermissions:
+    """
+    Parse a string like 'rwx', 'rw', 'r', etc. into a ToolPermissions object.
+    """
+    perm_str = perm_str.lower()
+    return ToolPermissions(
+        read='r' in perm_str,
+        write='w' in perm_str,
+        execute='x' in perm_str,
+    )

janito/tools/tool_base.py

@@ -2,14 +2,27 @@ from janito.report_events import ReportEvent, ReportSubtype, ReportAction
 from janito.event_bus.bus import event_bus as default_event_bus
 
 
+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.
     """
-    provides_execution = False  # Indicates if the tool provides execution capability (default: False)
+    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
 

janito/tools/tool_utils.py

@@ -20,9 +20,8 @@ def display_path(path):
     Returns:
         str: Display path, as an ANSI hyperlink.
     """
-    from janito.cli.config import get_termweb_port
-
-    port = get_termweb_port()
+    
+    port = 8088
     if os.path.isabs(path):
         cwd = os.path.abspath(os.getcwd())
         abs_path = os.path.abspath(path)
@@ -33,9 +32,8 @@ def display_path(path):
             disp = path
     else:
         disp = os.path.relpath(path)
-    url = f"http://localhost:{port}/?path={urllib.parse.quote(path)}"
-    # Use Rich markup for hyperlinks
-    return f"[link={url}]{disp}[/link]"
+    # URL injection removed; just return display path
+    return disp
 
 
 def pluralize(word: str, count: int) -> str:

janito/tools/tools_adapter.py

@@ -1,8 +1,7 @@
 from janito.tools.tool_base import ToolBase
 from janito.tools.tool_events import ToolCallStarted, ToolCallFinished, ToolCallError
 from janito.exceptions import ToolCallException
-from typing import Optional
-
+from janito.tools.tool_base import ToolPermissions
 
 class ToolsAdapterBase:
     """
@@ -13,11 +12,10 @@ class ToolsAdapterBase:
     """
 
     def __init__(
-        self, tools=None, event_bus=None, enabled_tools: Optional[list] = None
+        self, tools=None, event_bus=None
     ):
         self._tools = tools or []
         self._event_bus = event_bus  # event bus can be set on all adapters
-        self._enabled_tools = set(enabled_tools) if enabled_tools is not None else None
         self.verbose_tools = False
 
     def set_verbose_tools(self, value: bool):
@@ -31,11 +29,28 @@ class ToolsAdapterBase:
     def event_bus(self, bus):
         self._event_bus = bus
 
+    def is_tool_allowed(self, tool):
+        """Check if a tool is allowed based on current global AllowedPermissionsState."""
+        from janito.tools.permissions import get_global_allowed_permissions
+        allowed_permissions = get_global_allowed_permissions()
+        perms = tool.permissions  # permissions are mandatory and type-checked
+        # If all permissions are False, block all tools
+        if not (allowed_permissions.read or allowed_permissions.write or allowed_permissions.execute):
+            return False
+        for perm in ['read', 'write', 'execute']:
+            if getattr(perms, perm) and not getattr(allowed_permissions, perm):
+                return False
+        return True
+
     def get_tools(self):
-        """Return the list of enabled tools managed by this provider."""
-        if self._enabled_tools is None:
-            return self._tools
-        return [tool for tool in self._tools if getattr(tool, 'tool_name', None) in self._enabled_tools]
+        """Return the list of enabled tools managed by this provider, filtered by allowed permissions."""
+        tools = [tool for tool in self._tools if self.is_tool_allowed(tool)]
+        return tools
+
+    def set_allowed_permissions(self, allowed_permissions):
+        """Set the allowed permissions at runtime. This now updates the global AllowedPermissionsState only."""
+        from janito.tools.permissions import set_global_allowed_permissions
+        set_global_allowed_permissions(allowed_permissions)
 
     def add_tool(self, tool):
         self._tools.append(tool)
@@ -231,18 +246,8 @@ class ToolsAdapterBase:
         )
 
     def _check_tool_permissions(self, tool_name, request_id, arguments):
-        if self._enabled_tools is not None and tool_name not in self._enabled_tools:
-            error_msg = f"Tool '{tool_name}' is not enabled in this adapter."
-            if self._event_bus:
-                self._event_bus.publish(
-                    ToolCallError(
-                        tool_name=tool_name,
-                        request_id=request_id,
-                        error=error_msg,
-                        arguments=arguments,
-                    )
-                )
-            raise ToolCallException(tool_name, error_msg, arguments=arguments)
+        # No enabled_tools check anymore; permission checks are handled by is_tool_allowed
+        pass
 
     def _ensure_tool_exists(self, tool, tool_name, request_id, arguments):
         if tool is None:

{janito-2.3.1.dist-info → janito-2.4.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: janito
-Version: 2.3.1
+Version: 2.4.0
 Summary: A new Python package called janito.
 Author-email: João Pinto <lamego.pinto@gmail.com>
 Project-URL: Homepage, https://github.com/janito-dev/janito
@@ -17,7 +17,7 @@ Requires-Dist: prompt_toolkit>=3.0.51
 Requires-Dist: lxml>=5.4.0
 Requires-Dist: requests>=2.32.4
 Requires-Dist: bs4>=0.0.2
-Requires-Dist: openai
+Requires-Dist: questionary>=2.0.1
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: pre-commit; extra == "dev"
@@ -25,7 +25,8 @@ Requires-Dist: ruff==0.11.9; extra == "dev"
 Requires-Dist: detect-secrets==1.4.0; extra == "dev"
 Requires-Dist: codespell==2.4.1; extra == "dev"
 Requires-Dist: black; extra == "dev"
-Requires-Dist: openai; extra == "dev"
+Requires-Dist: questionary>=2.0.1; extra == "dev"
+Requires-Dist: setuptools_scm>=8.0; extra == "dev"
 Dynamic: license-file
 
 # Janito
@@ -106,6 +107,21 @@ janito -set provider=PROVIDER
 
 After installation, use the `janito` command in your terminal.
 
+Janito supports both general-purpose and specialized assistance through the use of **profiles**. Profiles allow you to select a specific system prompt template and behavior for the agent, enabling workflows tailored to different roles or tasks (e.g., developer, writer, data analyst), or to use Janito as a generic AI assistant.
+
+### Profiles: General-Purpose and Specialized Assistance
+
+- By default, Janito acts as a general-purpose assistant.
+- You can select a specialized profile using the `--profile` option:
+  ```bash
+  janito --profile developer "Refactor this code for better readability."
+  janito --profile writer "Draft a blog post about AI in healthcare."
+  ```
+- Profiles change the system prompt and agent behavior to suit the selected role or workflow.
+- To see available profiles or customize them, refer to the documentation or the `agent/templates/profiles/` directory.
+
+> **Tip:** Use `--profile` for targeted workflows, or omit it for a general-purpose assistant.
+
 Janito has configuration options, like `--set api-key API_KEY` and `--set provider=PROVIDER`, that create durable configurations and single shoot options, like `-p PROVIDER` and `-m MODEL`, that are active for the single run of the command or session.
 
 ### Basic Commands
@@ -153,25 +169,38 @@ Janito has configuration options, like `--set api-key API_KEY` and `--set provid
 
 - **Enable Inline Web File Viewer for Clickable Links**
   
-  By default, Janito can open referenced files in a browser-based viewer when you click on file links in supported terminals. To enable this feature for your session, use the `-w` or `--web` flag:
+  By default, Janito can open referenced files in a browser-based viewer when you click on file links in supported terminals. To enable this feature for your session, use the `--web` flag:
   
   ```bash
-  janito -w
+  janito --web
   ```
 
-  This starts the lightweight web file viewer (termweb) in the background, allowing you to inspect files referenced in responses directly in your browser. Combine with interactive mode or prompts as needed.
+  This starts the lightweight web file viewer () in the background, allowing you to inspect files referenced in responses directly in your browser. Combine with interactive mode or prompts as needed.
   
   > **Tip:** Use with the interactive shell for the best experience with clickable file links.
 
 
 - **Enable Execution Tools (Code/Shell Execution)**
   
-  By default, tools that can execute code or shell commands are **disabled** for safety. To enable these tools (such as code execution, shell commands, etc.), use the `--exec` or `-x` flag:
-  
-  ```bash
-  janito -x "Run this code: print('Hello, world!')"
-  ```
-  > **Warning:** Enabling execution tools allows running arbitrary code or shell commands. Only use `--exec` if you trust your prompt and environment.
+  By default, **all tool privileges (read, write, execute)** are disabled for safety. This means Janito starts with no permissions to run tools that read, write, or execute code/shell commands unless you explicitly enable them.
+
+- To enable **read** tools (e.g., file reading, searching): add `-r` or `--read`
+- To enable **write** tools (e.g., file editing): add `-w` or `--write`
+- To enable **execution** tools (code/shell execution): add `-x` or `--exec`
+
+You can combine these flags as needed. For example, to enable both read and write tools:
+
+```bash
+janito -r -w "Read and update this file: ..."
+```
+
+To enable all permissions (read, write, execute):
+
+```bash
+janito -r -w -x "Run this code: print('Hello, world!')"
+```
+
+> **Warning:** Enabling execution tools allows running arbitrary code or shell commands. Only use `--exec` if you trust your prompt and environment.
 
 - **Set a System Prompt**
   ```bash
@@ -203,7 +232,7 @@ Janito has configuration options, like `--set api-key API_KEY` and `--set provid
 ### Core CLI Options
 | Option                  | Description                                                                 |
 |------------------------|-----------------------------------------------------------------------------|
-| `-w`, `--web`          | Enable the builtin lightweight web file viewer for clickable file links (termweb). |
+| `--web`          | Enable the builtin lightweight web file viewer for clickable file links (). |
 | `--version`            | Show program version                                                        |
 | `--list-tools`         | List all registered tools                                                   |
 | `--list-providers`     | List all supported LLM providers                                            |
@@ -212,7 +241,7 @@ Janito has configuration options, like `--set api-key API_KEY` and `--set provid
 | `--set provider=name`  | Set the current LLM provider (e.g., `janito --set provider=openai`)         |
 | `--set PROVIDER.model=MODEL` or `--set model=MODEL` | Set the default model for the current/selected provider, or globally. (e.g., `janito --set openai.model=gpt-3.5-turbo`) |
 | `-s`, `--system`       | Set a system prompt (e.g., `janito -s path/to/system_prompt.txt "Your prompt here"`) |
-| `-r`, `--role`         | Set the role for the agent (overrides config) (e.g., `janito -r "assistant" "Your prompt here"`) |
+
 | `-p`, `--provider`     | Select LLM provider (overrides config) (e.g., `janito -p openai "Your prompt here"`) |
 | `-m`, `--model`        | Select model for the provider (e.g., `janito -m gpt-3.5-turbo "Your prompt here"`) |
 | `-v`, `--verbose`      | Print extra information before answering                                    |
@@ -246,8 +275,8 @@ Once inside the interactive chat mode, you can use these slash commands:
 | Command              | Description                                  |
 |----------------------|----------------------------------------------|
 | `/tools`             | List available tools                         |
-| `/termweb-status`    | Show status of termweb server                |
-| `/termweb-logs`      | Show last lines of termweb logs              |
+| `/-status`    | Show status of  server                |
+| `/-logs`      | Show last lines of  logs              |
 | `/livelogs`          | Show live updates from server log file       |
 | `/edit <filename>`   | Open file in browser-based editor            |
 
@@ -274,6 +303,12 @@ See [docs/supported-providers-models.md](docs/supported-providers-models.md) for
 
 Contributions are welcome! Please see the `CONTRIBUTING.md` (if available) or open an issue to get started.
 
+---
+
+## Developer Documentation
+
+For developer-specific setup, versioning, and contribution guidelines, see [README-dev.md](./README-dev.md).
+
 ## License
 
 This project is licensed under the terms of the MIT license.