janito 2.3.1__tar.gz → 2.4.0__tar.gz

janito-2.4.0/.codespellrc

@@ -0,0 +1,2 @@
+[codespell]
+skip = janito/i18n/pt.py

janito-2.4.0/.github/workflows/python-app.yml

@@ -0,0 +1,35 @@
+# This workflow will install Python dependencies, run tests and lint with a single version of Python
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: Python application
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["pypy3.10", "3.10", "3.11", "3.12", "3.13"]
+        
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install tox
+    - name: Test with tox
+      run: |
+        tox -e py

janito-2.4.0/.gitignore

@@ -0,0 +1,66 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Wheel files
+*.whl
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# mypy
+.mypy_cache/
+.dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# Backup files
+*.bak
+
+# Ruff cache
+.ruff_cache/
+
+# Janito logs/history (if not needed in VCS)
+.janito/
+
+# MkDocs build output
+site/

janito-2.4.0/.pre-commit-config.yaml

@@ -0,0 +1,17 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.9  # Updated to latest version after autoupdate
+    hooks:
+      - id: ruff
+        args: ["--fix"]  # Optional: auto-fix issues if possible
+
+  - repo: https://github.com/Yelp/detect-secrets
+    rev: v1.4.0  # Use the latest stable version or specify as needed
+    hooks:
+      - id: detect-secrets
+        args: ["--baseline", ".secrets.baseline", "--exclude-files", "janito/i18n/pt.py"]
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.4.1
+    hooks:
+      - id: codespell

janito-2.4.0/.secrets.baseline

@@ -0,0 +1,11 @@
+{
+  "version": "2.0.0",
+  "plugins_used": [],
+  "results": {},
+  "generated_at": "2024-06-08T00:00:00Z",
+  "allowlist": {
+    "values": [
+      "YOUR_AZURE_OPENAI_KEY"
+    ]
+  }
+}

janito-2.4.0/CHANGELOG.md

@@ -0,0 +1,57 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [2.3.1] - 2025-06-25
+### Changed
+- Bumped version to 2.3.1 in `version.py`, `pyproject.toml`, and `__init__.py`.
+
+## [2.3.0] - 2025-06-25
+### Added
+- requirements-dev.txt with development dependencies (pytest, pre-commit, ruff, detect-secrets, codespell, black) for code quality and testing
+- Java outline support to get_file_outline tool, including package-private methods
+- create_driver method to AzureOpenAIProvider for driver instantiation
+- CLI --version test and suppress pytest-asyncio deprecation warning
+- New dependencies: prompt_toolkit, lxml, requests, bs4 to requirements.txt
+
+### Changed
+- Improved error messages and documentation
+- Refined error handling in open_html_in_browser.py and open_url.py
+- Refactor remove_file tool: use ReportAction.DELETE for all file removal actions
+- Remove redundant _prepare_api_kwargs override in AzureOpenAIModelDriver
+- Refactor(azure_openai): use 'model' directly in API kwargs, remove deployment_name remapping
+- Add public read-only driver_config property to AzureOpenAIProvider
+- Add _prepare_api_kwargs to support deployment_name for Azure OpenAI API compatibility
+- Update toolbar bindings: add CTRL-C for interrupt/exit, clarify F1 usage
+- Update pyproject.toml optional-dependencies section for setuptools compatibility
+- Remove references to max_results in FindFilesTool docstring
+- Refactor: use .jsonl extension for input history files instead of .log
+- Refactor get_file_outline core logic to remove duplication and add tests
+- Test CLI: Ensure error on missing provider and validate supported models output for each provider
+- Configure dynamic dependencies in pyproject.toml
+- Define dependencies in requirements.txt: attrs, rich, pathspec, setuptools, pyyaml, jinja2
+- Add workdir support to LocalToolsAdapter and CLI; improve Python tool adapters
+- Friendly error message when the provider is not present from the available ones
+
+### Fixed
+- Ensure error on missing provider and validate supported models output for each provider
+- Update supported models table; remove o4-mini-high model from code and docs
+
+## [2.1.1] - 2024-06-23
+### Changed
+- Bumped version to 2.1.1 in `version.py`, `pyproject.toml`, and `__init__.py`.
+- docs: add DeepSeek setup guide, update navigation and references
+    - Add docs/deepseek-setup.md with setup instructions for DeepSeek provider
+    - Link DeepSeek setup in docs/index.md and mkdocs.yml navigation
+    - Fix model name: change 'deepseek-coder' to 'deepseek-reasoner' in DeepSeek provider and model_info
+    - Update DeepSeek provider docstrings and options to match supported models
+
+## [2.1.0] - 2024-06-09
+### Added
+
+### Changed
+- Bumped version to 2.1.0 in `version.py`, `pyproject.toml`, and `__init__.py`.
+
+---
+
+*Older changes may not be listed.*

{janito-2.3.1 → janito-2.4.0}/PKG-INFO

@@ -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.

janito-2.4.0/PROVIDERS.md

@@ -0,0 +1,47 @@
+## Providers
+
+### Provider Parameters (`config`)
+
+All LLM providers support an optional `config` dictionary for provider-specific settings. You can pass this dictionary to the provider constructor:
+
+```python
+provider = OpenAIProvider(model_name="gpt-4o", config={"base_url": "https://api.example.com/v1"})
+```
+
+- For `openai` and compatible providers, you can set `base_url` to use a custom endpoint.
+- For Azure, additional options like `endpoint` and `api_version` may be supported as keys within `config`.
+
+---
+
+### anthropic
+
+**Description:** Anthropic Claude v3 (Opus, Sonnet, Haiku), via official Anthropic API.
+
+**Models:**
+- claude-3-opus-20240229: Most advanced, very high context and reasoning.
+- claude-3-sonnet-20240229: Fast, large-context, good for chat.
+- claude-3-haiku-20240307: Fastest, cheap, smaller context.
+
+**Auth:**
+- Expects official Claude API key via credential system only (environment variables are not supported).
+
+**Usage:**
+- Use provider name `anthropic` in CLI/config. Model selection applies as above.
+
+---
+
+### azure_openai
+
+**Description:** Azure-hosted OpenAI models (API-compatible, may require endpoint and version)
+
+**Models:**
+- azure-gpt-35-turbo: GPT-3.5 family turbo, hosted via Azure.
+- azure-gpt-4: GPT-4 model, hosted via Azure.
+
+**Auth:**
+- Expects API key and Azure endpoint via credential manager only (environment variables are not supported).
+
+**Usage:**
+- Use provider name `azure_openai` in CLI/config. Model selection as shown above.
+
+---

janito-2.4.0/README-dev.md

@@ -0,0 +1,50 @@
+# Developer README for janito
+
+This document provides guidelines and instructions for developers contributing to the `janito` project.
+
+## Version Management
+
+- The project uses [setuptools_scm](https://github.com/pypa/setuptools_scm) for automatic version management.
+- Do **not** manually set the version in any Python file or in `pyproject.toml`.
+- The version is derived from your latest Git tag. To update the version, create a new tag:
+  ```sh
+  git tag vX.Y.Z
+  git push --tags
+  ```
+- The `__version__` attribute is available via `janito.__version__`.
+
+## Project Structure
+
+- Source code is in the `janito/` directory.
+- Entry points and CLI are defined in `janito/__main__.py`.
+- Tests should be placed in a `tests/` directory (create if missing).
+
+## Dependencies
+
+- Runtime dependencies are listed in `requirements.txt`.
+- Development dependencies are in `requirements-dev.txt`.
+- Dependencies are dynamically loaded via `pyproject.toml`.
+
+## Building and Installing
+
+- To build the project:
+  ```sh
+  python -m build
+  ```
+- To install in editable mode:
+  ```sh
+  pip install -e .
+  ```
+
+## Running Tests
+
+- (Add test instructions here if/when tests are present)
+
+## Contributing
+
+- Follow PEP8 and use [ruff](https://github.com/charliermarsh/ruff) for linting.
+- Document all public functions and classes.
+- Update this README-dev.md as needed for developer-facing changes.
+
+---
+For more information, see the main `README.md` or contact the maintainers.