glean-agent-toolkit 0.2.0__tar.gz → 0.4.0__tar.gz

glean_agent_toolkit-0.4.0/.cz.toml

@@ -0,0 +1,8 @@
+[tool.commitizen]
+name = "cz_conventional_commits"
+version = "0.4.0"
+tag_format = "$version"
+version_files = [
+  "pyproject.toml:version",
+  "glean/toolkit/__init__.py:__version__",
+]

glean_agent_toolkit-0.4.0/.env.template

@@ -0,0 +1,6 @@
+# Glean API configuration
+GLEAN_SERVER_URL=https://your-company-be.glean.com
+GLEAN_API_TOKEN=
+
+# Deprecated: GLEAN_INSTANCE is legacy — still supported as fallback
+# GLEAN_INSTANCE=your-company

{glean_agent_toolkit-0.2.0 → glean_agent_toolkit-0.4.0}/.github/workflows/ci.yml

@@ -22,13 +22,13 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Setup development environment
-        run: task setup
+        run: mise run setup
 
       - name: Run linters
-        run: task lint
+        run: mise run lint
 
       - name: Build package
-        run: task build
+        run: mise run build
 
   test:
     name: Test Python ${{ matrix.python-version }}
@@ -44,23 +44,21 @@ jobs:
         uses: jdx/mise-action@v2
         with:
           cache: true
-          mise_toml: |
-            [tools]
-            python = "${{ matrix.python-version }}"
-            task = "latest"
-            uv = "latest"
 
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Setup development environment
-        run: task setup
+        run: mise use -g python@${{ matrix.python-version }} uv@latest && mise install
+
+      - name: Initialize dev environment
+        run: mise run setup
 
       - name: Run tests
-        run: task test
+        run: mise run test
 
       - name: Test package installation
         run: |
-          task build
+          mise run build
           uv run pip install dist/*.whl
           uv run python -c "import glean.agent_toolkit; print('Package installed successfully')"

{glean_agent_toolkit-0.2.0 → glean_agent_toolkit-0.4.0}/.github/workflows/publish.yml

@@ -3,7 +3,7 @@ name: Publish to PyPI
 on:
   push:
     tags:
-      - 'v*.*.*'
+      - '*.*.*'
   workflow_dispatch:
 
 jobs:

glean_agent_toolkit-0.4.0/.markdown-coderc.json

@@ -0,0 +1,14 @@
+{
+  "snippetRoot": "./snippets",
+  "markdownGlob": "README.md",
+  "excludeGlob": [
+    "node_modules/**",
+    ".git/**",
+    "dist/**",
+    "build/**",
+    "coverage/**",
+    "target/**",
+    "vendor/**"
+  ],
+  "includeExtensions": [".py", ".bash", ".sh"]
+}

glean_agent_toolkit-0.4.0/.pre-commit-config.yaml

@@ -0,0 +1,23 @@
+repos:
+  - repo: https://github.com/commitizen-tools/commitizen
+    rev: v4.4.1
+    hooks:
+      - id: commitizen
+        stages: [commit-msg]
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+      - id: check-merge-conflict
+      - id: debug-statements
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.5.0
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format

glean_agent_toolkit-0.4.0/AGENTS.md

@@ -0,0 +1,55 @@
+# Agent Guidelines
+
+This project contains the **Glean Agent Toolkit**, a Python package used to integrate Glean's search and discovery tools with various agent frameworks.
+
+## Setup
+
+1. Install the prerequisites:
+   - [uv](https://github.com/astral-sh/uv)
+   - [mise](https://mise.jdx.dev/)
+ 2. Run `mise run setup` to create the `.venv` and install all development, test, lint and typing dependencies via `uv`.
+
+Environment variables `GLEAN_API_TOKEN` and `GLEAN_SERVER_URL` (or deprecated `GLEAN_INSTANCE`) must be set to interact with Glean or regenerate VCR cassettes.
+
+## Development Tasks
+
+The repository uses **mise**. Key commands include:
+
+| Task | Description |
+|------|-------------|
+| `mise run test` | Run unit tests |
+| `mise run test:watch` | Run tests in watch mode |
+| `mise run test:cov` | Run tests with coverage |
+| `mise run test:all` | Run tests, apply lint fixes, and run pyright |
+| `mise run lint` | Run Ruff, formatting checks and pyright |
+| `mise run lint:diff` | Lint only changed files |
+| `mise run lint:fix` | Apply Ruff fixes and formatting |
+| `mise run format` | Format code using Ruff formatter |
+| `mise run spell:check` | Check spelling |
+| `mise run clean` | Remove build artifacts |
+| `mise run build` | Build the package |
+| `mise run release` | Bump version and generate the changelog |
+
+Special tasks exist to manage VCR cassettes used in tests:
+
+- `mise run test:vcr:regenerate` – Re-record all HTTP interactions (requires `GLEAN_API_TOKEN` and `GLEAN_SERVER_URL`; deprecated `GLEAN_INSTANCE` is still accepted as fallback).
+- `mise run test:vcr:clean` – Delete cassettes so the next test run regenerates them.
+
+## Coding Guidelines
+
+- Python **>=3.10** is required. The project enforces formatting with Ruff. Line length is limited to **100** characters and double quotes are used by default.
+- Docstrings follow the **Google** style as configured in `pyproject.toml`.
+- Type checking is performed with **pyright**.
+- Tools should be implemented using the `@tool_spec` decorator found in `glean.agent_toolkit.decorators`. See existing tools under `src/glean/agent_toolkit/tools` for examples.
+
+## Contribution Process
+
+1. Fork the repository and create a branch from `main`.
+2. Make your changes and ensure all tasks run cleanly (`mise run test` and `mise run lint`).
+3. Update or add documentation when necessary.
+4. Submit a pull request.
+5. Be respectful and follow the project's code of conduct.
+
+## Additional Notes
+
+Check the [README](README.md) for feature descriptions and basic usage. The package is released under the [MIT License](LICENSE).

glean_agent_toolkit-0.4.0/CHANGELOG.md

@@ -0,0 +1,16 @@
+## 0.3.0 (2025-07-21)
+
+### Feat
+
+- Add enhanced parameter schemas with Field metadata support
+
+### Fix
+
+- Adds newline to .cz.toml
+- Fixes type errors during task:lint
+
+## 0.2.0 (2025-06-05)
+
+### Feat
+
+- Implements Agent Builder tools as defaults

glean_agent_toolkit-0.4.0/COMMIT_LINTING.md

@@ -0,0 +1,166 @@
+# Commit Linting Setup
+
+This project uses conventional commits with pre-commit hooks to ensure all commits follow the proper format.
+
+## What is Conventional Commits?
+
+Conventional Commits is a specification for commit messages that provides a standardized way to write commit messages. This makes it easier to:
+
+- Automatically generate changelogs
+- Determine semantic version bumps
+- Communicate the nature of changes to teammates
+
+Format: `<type>(<scope>): <description>`
+
+Examples:
+
+- `feat: add new search functionality`
+- `fix(auth): resolve login issue`
+- `docs: update README with new examples`
+- `refactor(api): simplify response handling`
+
+## Setup
+
+### 1. Install Dependencies
+
+```bash
+# Install all dependencies including pre-commit
+mise run setup
+```
+
+This will:
+
+- Install Python dependencies with `uv`
+- Install pre-commit hooks automatically
+
+### 2. Manual Pre-commit Setup (if needed)
+
+```bash
+# Install pre-commit hooks
+mise run pre-commit:install
+```
+
+## Available Tools
+
+### Pre-commit Hooks
+
+Pre-commit hooks run automatically before each commit and will:
+
+- Validate commit message format using Commitizen
+- Run code formatting and linting with Ruff
+- Check for common issues (trailing whitespace, merge conflicts, etc.)
+
+**Commands:**
+
+```bash
+# Run pre-commit hooks on all files
+mise run pre-commit:run
+
+# Run pre-commit hooks on changed files only
+mise run pre-commit:run:diff
+
+# Update pre-commit hooks to latest versions
+mise run pre-commit:update
+```
+
+## Making Commits
+
+### Option 1: Use Commitizen (Recommended)
+
+```bash
+# Interactive commit creation
+uv run python -m commitizen commit
+
+# Or use the shorthand
+uv run cz commit
+```
+
+This will guide you through creating a conventional commit interactively.
+
+### Option 2: Manual Commits
+
+You can write commits manually, but they must follow the conventional commit format:
+
+```bash
+git commit -m "feat: add new feature"
+git commit -m "fix(auth): resolve login issue"
+git commit -m "docs: update API documentation"
+```
+
+### Option 3: Use Pre-commit with Conventional Commits
+
+```bash
+# Write your commit message
+git add .
+git commit -m "your message here"
+
+# Pre-commit will validate and potentially fix issues
+```
+
+**Note:** Pre-commit hooks will automatically run and validate your commit message format.
+
+## Commit Types
+
+- `feat`: A new feature
+- `fix`: A bug fix
+- `docs`: Documentation only changes
+- `style`: Changes that do not affect the meaning of the code
+- `refactor`: A code change that neither fixes a bug nor adds a feature
+- `perf`: A code change that improves performance
+- `test`: Adding missing tests or correcting existing tests
+- `build`: Changes that affect the build system or external dependencies
+- `ci`: Changes to CI configuration files and scripts
+- `chore`: Other changes that don't modify src or test files
+- `revert`: Reverts a previous commit
+
+## Troubleshooting
+
+### Pre-commit Hook Not Running
+
+```bash
+# Reinstall pre-commit hooks
+task pre-commit:install
+```
+
+### Commit Message Validation Failing
+
+1. Use Commitizen for interactive commit creation:
+
+   ```bash
+   uv run python -m commitizen commit
+   ```
+
+2. Check the conventional commit format:
+
+   - Must start with a type: `feat`, `fix`, `docs`, etc.
+   - Optional scope in parentheses: `(auth)`, `(api)`, etc.
+   - Colon and space: `: `
+   - Description: `add new feature`
+
+3. Examples of valid commits:
+   ```bash
+   git commit -m "feat: add new search functionality"
+   git commit -m "fix(auth): resolve login timeout issue"
+   git commit -m "docs: update installation instructions"
+   ```
+
+### Skipping Validation (Emergency Only)
+
+```bash
+# Skip pre-commit hooks (not recommended)
+git commit -m "your message" --no-verify
+```
+
+## Configuration Files
+
+- `.pre-commit-config.yaml`: Pre-commit hooks configuration
+- `.cz.toml`: Commitizen configuration
+- `pyproject.toml`: Project dependencies including pre-commit
+
+## Benefits
+
+1. **Consistent History**: All commits follow the same format
+2. **Automated Changelogs**: Commitizen can generate changelogs automatically
+3. **Semantic Versioning**: Automatic version bumping based on commit types
+4. **Better Collaboration**: Clear communication about what each commit does
+5. **Local Validation**: Immediate feedback before commits are made

glean_agent_toolkit-0.4.0/CONTRIBUTING.md

@@ -0,0 +1,94 @@
+# Contributing to Glean Agent Toolkit
+
+Thank you for your interest in contributing to the Glean Agent Toolkit! This guide will help you understand the project structure, development workflow, and how to add new tools.
+
+## Project Structure
+
+```sh
+src/
+├─ glean/
+│  ├─ __init__.py
+│  └─ agent_toolkit/     # exposes `glean.agent_toolkit`
+│     ├─ __init__.py
+│     ├─ decorators.py
+│     ├─ registry.py
+│     ├─ spec.py
+│     ├─ adapters/
+│     ├─ tools/
+│     └─ cli.py
+├─ tests/
+└─ docs/
+```
+
+## Development environment
+
+The repository relies on [uv](https://github.com/astral-sh/uv) and [mise](https://mise.jdx.dev/) for reproducible workflows and task orchestration.
+
+### Prerequisites
+
+1. uv
+
+   ```bash
+   pip install uv
+   ```
+
+2. mise
+
+   ```bash
+   brew install mise
+   ```
+
+### One-time setup
+
+```bash
+mise run setup
+```
+
+The command creates `.venv/` and installs all dev/test dependencies via uv.
+
+## Development Tasks
+
+The project uses `mise` to manage development tasks. Here are the available tasks:
+
+### Testing
+
+| Task                  | Description                  |
+| --------------------- | ---------------------------- |
+| `mise run test`       | Run unit tests               |
+| `mise run test:watch` | Run tests in watch mode      |
+| `mise run test:cov`   | Run tests with coverage      |
+| `mise run test:all`   | Run all tests and lint fixes |
+
+### Linting and formatting
+
+| Task                    | Description                             |
+| ----------------------- | --------------------------------------- |
+| `mise run lint`         | Run Ruff, pyright and formatting checks |
+| `mise run lint:diff`    | Same as above but only on changed files |
+| `mise run lint:package` | Lint only `glean/toolkit`               |
+| `mise run lint:tests`   | Lint only `tests`                       |
+| `mise run lint:fix`     | Autofix style issues                    |
+| `mise run format`       | Apply Ruff formatter                    |
+| `mise run format:diff`  | Format only changed files               |
+
+### Examples and Utilities
+
+| Task                   | Description                                     |
+| ---------------------- | ----------------------------------------------- |
+| `mise run spell:check` | Check spelling                                  |
+| `mise run spell:fix`   | Fix spelling                                    |
+| `mise run clean`       | Clean build artifacts                           |
+| `mise run build`       | Build the package                               |
+| `mise run release`     | Create a new release (version bump + changelog) |
+| `mise run security:audit` | Run dependency vulnerability audit (pip-audit) |
+
+## Pull Request Process
+
+1. Fork the repository and create your branch from `main`.
+2. Make your changes and ensure that all tests pass.
+3. Update the documentation to reflect any changes.
+4. Submit a pull request.
+
+## Code of Conduct
+
+Please be respectful and considerate of others when contributing to this project.