Clone cookiecutter template

Author: rbharvs

.github/workflows/ci.yaml

@@ -0,0 +1,38 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+  workflow_call:
+
+permissions:
+  contents: none
+
+jobs:
+  ci:
+    permissions:
+      contents: read
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@6b9c6063abd6010835644d4c2e1bef4cf5cd0fca
+
+      - name: Install dependencies
+        run: uv sync --dev
+
+      - name: Lint code
+        run: uv run ruff check
+
+      - name: Check formatting
+        run: uv run ruff format --check
+
+      - name: Run type checking
+        run: uv run mypy --strict .
+
+      - name: Run tests
+        run: uv run pytest -v

.github/workflows/publish.yaml

@@ -0,0 +1,34 @@
+name: Publish
+
+on:
+  release:
+    types: [created]
+
+permissions:
+  contents: none
+
+jobs:
+  ci:
+    permissions:
+      contents: read
+    uses: rbharvs/llm-tools-readonly-fs/.github/workflows/ci.yaml@main
+
+  publish:
+    permissions:
+      contents: read
+      id-token: write
+    environment: release
+    runs-on: ubuntu-latest
+    needs: ci
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@6b9c6063abd6010835644d4c2e1bef4cf5cd0fca
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish package
+        run: uv publish

.gitignore

@@ -0,0 +1,12 @@
+.venv
+__pycache__/
+*.py[cod]
+*$py.class
+venv
+.eggs
+.pytest_cache
+*.egg-info
+.DS_Store
+.vscode
+dist
+build

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Brett Harvey
+
+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.

README.md

@@ -0,0 +1,53 @@
+# llm-tools-readonly-fs
+
+[![PyPI](https://img.shields.io/pypi/v/llm-tools-readonly-fs.svg)](https://pypi.org/project/llm-tools-readonly-fs/)
+[![Changelog](https://img.shields.io/github/v/release/rbharvs/llm-tools-readonly-fs?include_prereleases&label=changelog)](https://github.com/rbharvs/llm-tools-readonly-fs/releases)
+[![Tests](https://github.com/rbharvs/llm-tools-readonly-fs/actions/workflows/test.yml/badge.svg)](https://github.com/rbharvs/llm-tools-readonly-fs/actions/workflows/test.yml)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/rbharvs/llm-tools-readonly-fs/blob/main/LICENSE)
+
+Grants LLM the ability to list, view, and search across files within a directory
+
+## Installation
+
+Install this plugin in the same environment as [LLM](https://llm.datasette.io/).
+```bash
+llm install llm-tools-readonly-fs
+```
+## Usage
+
+To use this with the [LLM command-line tool](https://llm.datasette.io/en/stable/usage.html):
+
+```bash
+llm --tool view "Example prompt goes here" --tools-debug
+```
+
+With the [LLM Python API](https://llm.datasette.io/en/stable/python-api.html):
+
+```python
+import llm
+from llm_tools_readonly_fs import view
+
+model = llm.get_model("gpt-4.1-mini")
+
+result = model.chain(
+    "Example prompt goes here",
+    tools=[view]
+).text()
+```
+
+## Development
+
+To set up this plugin locally, first checkout the code. Then create a new virtual environment:
+```bash
+cd llm-tools-readonly-fs
+python -m venv venv
+source venv/bin/activate
+```
+Now install the dependencies and test dependencies:
+```bash
+llm install -e '.[test]'
+```
+To run the tests:
+```bash
+python -m pytest
+```

llm_tools_readonly_fs.py

@@ -0,0 +1,13 @@
+import llm
+
+
+def view(input: str) -> str:
+    """
+    Description of tool goes here.
+    """
+    return f"hello {input}"
+
+
+@llm.hookimpl
+def register_tools(register):
+    register(view)

pyproject.toml

@@ -0,0 +1,28 @@
+[project]
+name = "llm-tools-readonly-fs"
+version = "0.1"
+description = "Grants LLM the ability to glob, grep, and view files within a directory"
+readme = "README.md"
+authors = [{name = "Brett Harvey"}]
+license = "Apache-2.0"
+classifiers = []
+requires-python = ">=3.9"
+dependencies = [
+    "llm>=0.26"
+]
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project.urls]
+Homepage = "https://github.com/rbharvs/llm-tools-readonly-fs"
+Changelog = "https://github.com/rbharvs/llm-tools-readonly-fs/releases"
+Issues = "https://github.com/rbharvs/llm-tools-readonly-fs/issues"
+CI = "https://github.com/rbharvs/llm-tools-readonly-fs/actions"
+
+[project.entry-points.llm]
+llm_tools_readonly_fs = "llm_tools_readonly_fs"
+
+[project.optional-dependencies]
+test = ["pytest", "llm-echo>=0.3a1"]

tests/test_llm_tools_readonly_fs.py

@@ -0,0 +1,22 @@
+import llm
+import json
+from llm_tools_readonly_fs import view
+
+
+def test_tool():
+    model = llm.get_model("echo")
+    chain_response = model.chain(
+        json.dumps(
+            {
+                "tool_calls": [
+                    {"name": "view", "arguments": {"input": "pelican"}}
+                ]
+            }
+        ),
+        tools=[view],
+    )
+    responses = list(chain_response.responses())
+    tool_results = json.loads(responses[-1].text())["tool_results"]
+    assert tool_results == [
+        {"name": "view", "output": "hello pelican", "tool_call_id": None}
+    ]