hsom 1.0.0__tar.gz

hsom-1.0.0/.github/workflows/ci.yml

@@ -0,0 +1,71 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+    env:
+      PYTHONPATH: src:tests
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e .
+          pip install pytest
+      - name: Test
+        run: pytest -q
+
+  quality:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e '.[dev]'
+      - name: Benchmark integrity
+        run: python benchmark.py check
+      - name: Ruff
+        run: ruff check .
+      - name: Typecheck
+        run: mypy
+
+  package:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Build wheel
+        run: |
+          python -m pip install --upgrade pip
+          pip install build pip-audit
+          python -m build
+      - name: Clean-install smoke test
+        run: |
+          python -m venv /tmp/hsom-venv
+          /tmp/hsom-venv/bin/python -m pip install --upgrade pip
+          /tmp/hsom-venv/bin/pip install dist/*.whl
+          /tmp/hsom-venv/bin/python -c "import hsom; print(hsom.__version__)"
+          /tmp/hsom-venv/bin/hsom --help
+          /tmp/hsom-venv/bin/pip check
+      - name: Dependency audit
+        run: |
+          python -m pip install --target /tmp/hsom-site dist/*.whl
+          python -m pip_audit --path /tmp/hsom-site

hsom-1.0.0/.gitignore

@@ -0,0 +1,229 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# 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
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+# hsom examples: eval run artifacts (regenerate via examples/*/run_eval.sh)
+examples/*/eval-results.jsonl
+examples/benchmark-results/
+
+# Frozen benchmark workspaces include build artifacts and logs as fixtures.
+!examples/*/workspace/dist/
+!examples/*/workspace/logs/
+!examples/*/workspace/**/*.log
+
+PLAN*.md

hsom-1.0.0/.python-version

@@ -0,0 +1 @@
+3.10

hsom-1.0.0/LICENSE

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

hsom-1.0.0/PKG-INFO

@@ -0,0 +1,245 @@
+Metadata-Version: 2.5
+Name: hsom
+Version: 1.0.0
+Summary: Harness for System One Models. | Connects Jev to your shell
+Project-URL: Homepage, https://github.com/gi-dellav/hsom
+Project-URL: Repository, https://github.com/gi-dellav/hsom
+Author: Giuseppe Della Vedova
+License: MIT
+License-File: LICENSE
+Keywords: agent-harness,cli,jev,shell,system-one,typesafe
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: System :: Shells
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+Requires-Dist: tomli>=2.0; python_version < '3.11'
+Requires-Dist: typesafe-sdk>=0.7.0
+Provides-Extra: benchmark
+Requires-Dist: litellm>=1.82; extra == 'benchmark'
+Provides-Extra: dev
+Requires-Dist: build>=1.2; extra == 'dev'
+Requires-Dist: mypy>=1.19; extra == 'dev'
+Requires-Dist: pip-audit>=2.9; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.15; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# hsom
+
+*Harness for System One Models. Runs allowlisted shell commands using decision trees.*
+
+*hsom* is a strict-allowlist harness. `environment.toml` defines which shell commands Jev (the TypeSafe System One classifier) may select. In one step, Jev picks: command → subcommand → flags (boolean or valued) → path slots; this works by navigating the decision tree as defined by the TOML file.
+
+- `read` actions run directly.
+- `write` and `destructive` actions ask for confirmation (`y/N`, default N; non-tty declines).
+- `--dry-run` previews without executing or prompting.
+
+*hsom* is usable both as a CLI tool for shell-based harnesses and as a Python library for building custom harnesses.
+
+(*note*: I'm currently working on a research paper on the inner workings and theoritical aspects of the algorithm implemented by *hsom*.)
+
+## Benchmark
+
+Strict pass rate (all repeats passed) on the bundled suites; structured and
+logprob baselines use `openai/gpt-6-luna`. Full results:
+[`examples/benchmark-results/final-gpt6/report.md`](examples/benchmark-results/final-gpt6/report.md).
+
+| Suite | Label | Jev | Structured | Logprobs |
+| --- | --- | --- | --- | --- |
+| git-workflow | regression | 95.3% | 58.7% | 66.7% |
+| python-qa | regression | 96.2% | 43.1% | 45.1% |
+| container-ops | heldout | **92.0%** | 62.0% | 68.0% |
+
+## Setup
+
+```bash
+pip install -e .
+export TYPESAFE_API_KEY=...   # from https://console.typesafe.ai/keys
+cp environment.toml.example environment.toml
+```
+
+Or with [uv](https://docs.astral.sh/uv/):
+
+```bash
+uv venv                          # creates .venv
+source .venv/bin/activate
+uv pip install -e .
+export TYPESAFE_API_KEY=...      # from https://console.typesafe.ai/keys
+cp environment.toml.example environment.toml
+```
+
+### OpenRouter
+
+hsom can call Jev through [OpenRouter's System One API](https://openrouter.ai/docs/guides/community/typesafe-sdk) (billed to your OpenRouter account) instead of TypeSafe Cloud. Pick one provider:
+
+```toml
+# environment.toml
+[meta]
+provider = "openrouter"   # default base_url: https://openrouter.ai/api
+```
+
+```bash
+export OPENROUTER_API_KEY=...   # from https://openrouter.ai/settings/keys
+```
+
+Endpoint precedence (highest first): `--base-url` > `[meta] base_url` > `TYPESAFE_BASE_URL` > provider default.
+
+Key precedence: `TYPESAFE_API_KEY` > `OPENROUTER_API_KEY`. The SDK itself reads only `TYPESAFE_API_KEY`, so hsom forwards `OPENROUTER_API_KEY` explicitly.
+
+- `TYPESAFE_BASE_URL=https://openrouter.ai/api` also works and keeps `provider = "typesafe"`.
+- Bare model IDs (`jev-latest`) and prefixed IDs (`typesafe/jev-1.13`) are both passed through.
+- Model listing via the SDK is not supported by OpenRouter. Browse https://openrouter.ai/typesafe instead.
+
+## Configuration
+
+`environment.toml` holds one `[meta]` section and one `[[command]]` table per allowed command.
+
+### `[meta]` settings
+
+```toml
+[meta]
+model = "jev-latest"
+min_confidence = 0.5
+timeout = 60
+default_risk = "read"     # read | write | destructive
+max_steps = 1             # 1..10 upper bound; >1 lets Jev decide to continue
+max_history = 5           # optional; cap history entries sent back to Jev
+continue_threshold = 0.5  # optional; Noul bar for the __continue__ chaining gate
+continue_question = "..." # optional; override the __continue__ gate instructions
+temperature = 0.0         # optional; extra_body passthrough (provider-dependent)
+command_question = "What shell task is the user asking for?"
+
+  [meta.risk_thresholds]
+  read = 0.5
+  write = 0.7
+  destructive = 0.9
+```
+
+`temperature` is forwarded through the SDK's `extra_body`. The OpenRouter
+System One schema does not document a temperature parameter, so treat it as
+provider-dependent and not as a determinism guarantee. The benchmark configs
+set it explicitly to `0.0`, and run logs record the value used
+(`temperature` in `plan`/`eval` events).
+
+### Commands, subcommands, flags, and paths
+
+```toml
+[[command]]
+name = "git"
+description = "version control operations"
+risk = "read"
+instructions_subcommand = "Which git subcommand does the request need?"
+
+  [[command.subcommand]]
+  name = "log"
+  description = "show commit history"
+  argv = ["git", "log"]
+
+    [[command.subcommand.flag]]          # boolean flag
+    name = "--oneline"
+    description = "compact one-line-per-commit history"
+    argv_fragment = ["--oneline"]
+    question = "Does the user want compact one-line history?"  # optional
+
+    [[command.subcommand.flag]]          # valued flag
+    name = "--format"
+    description = "history output format"
+    argv_fragment = ["--format={value}"]
+    values = ["json", "plain"]
+    [command.subcommand.flag.value_descriptions]
+    json = "one JSON object per commit"
+
+  [[command.subcommand]]
+  name = "add"
+  description = "stage a file for commit"
+  argv = ["git", "add", "{path:src}"]   # named slot; legacy "{path}" also works
+  risk = "write"                        # prompts for confirmation
+
+    [[command.subcommand.path]]
+    name = "src"
+    kind = "files"          # files | dirs | both
+    optional = false
+    description = "file to stage"
+    base = "."              # relative root inside --cwd
+    depth = 3               # 1 = top level only
+    glob = "*.py"           # optional fnmatch
+    include_dotfiles = false
+    max_results = 200
+    question = "Which Python file does the request want to stage?"
+```
+
+`stated_question` is an optional yes/no gate for **optional** slots: when
+Jev says the request names no specific path, the slot is omitted. A
+missing, malformed, or non-Noul gate answer is fail-closed and also omits
+the slot. It has no effect on required slots.
+
+## Usage
+
+Run `hsom` with a natural-language request:
+
+```bash
+hsom "show git status" --dry-run --show-probs
+hsom "brief git history"              # -> git log --oneline
+hsom "stage main.py"                  # -> git add main.py (asks [y/N], risk write)
+hsom "copy readme into examples"      # -> cp README.md examples
+hsom "run tests" --max-steps 3        # dynamic chaining: Jev decides each step
+hsom "run tests" --max-steps 1        # single shot (never asks to continue)
+hsom "run tests" --max-history 2      # send back at most 2 prior steps
+hsom "run tests" --continue-threshold 0.3  # lower the __continue__ chaining bar (CLI wins)
+hsom "run tests" --temperature 0.2    # sampling temperature (extra_body)
+hsom "run tests" --log run.jsonl      # opt-in structured JSONL run log
+hsom "run tests" --min-confidence 0.8 # CLI flag wins over all config
+hsom "run tests" --provider openrouter --dry-run  # one-shot OpenRouter routing
+hsom --eval eval.toml.example         # eval harness: plans only, never runs
+```
+
+## Python library
+
+`hsom` is also an importable library built around the `Harness` class
+(sync-only). The CLI shares the same dispatcher/executor machinery.
+
+```bash
+pip install -e .
+```
+
+```python
+from hsom import Harness
+
+# Config: environment.toml path, EnvConfig, or TOML-shaped dict.
+h = Harness(env="environment.toml")
+h = Harness(env={"meta": {"model": "jev-latest"},
+                 "command": [{"name": "pytest", "description": "run tests",
+                               "argv": ["pytest", "-q"]}]})
+
+# Single-shot plan (max_steps=1) -> PlanOutcome(ok, action, reason, ...).
+outcome = h.plan("brief git history")
+if outcome.ok:
+    print(h.resolve(outcome.action))   # argv from the toml template only
+
+# Chained run -> RunResult(steps, stop_reason, ok, declined).
+result = h.run("run tests", max_steps=3, dry_run=True)
+print(result.stop_reason, [s.argv for s in result.steps])
+
+# Write/destructive steps never prompt on stdin here. Pass on_confirm
+# (default None = fail-closed auto-decline, like the CLI off-tty):
+result = h.run("stage main.py", on_confirm=lambda action, argv: True)
+
+# Dynamic working directory: subclass, pass get_cwd=..., assign
+# h.get_cwd = lambda: ..., or h.set_cwd_fn(...) / h.set_cwd(...).
+# A per-call cwd=... always wins over get_cwd().
+h.set_cwd_fn(lambda: "/path/to/project")
+result = h.run("run tests", cwd="/override", dry_run=True)
+
+# Eval harness (plans only, never executes) -> EvalSummary.
+summary = h.eval("eval.toml.example")
+print(f"{summary.passed}/{summary.total} passed")
+```