Open source

MIT-licensed, and readable end to end

A supervisor you cannot inspect is another thing to take on trust. The whole boundary is in the repository: the sandbox profiles, the policy engine, the re-verification step and the tests that pin them.

Licence

MIT

Use it, change it and ship it, for personal or commercial work. The text is in LICENSE.

One exception, and it concerns this website only: four text-animation components in the site’s source come from React Bits under MIT with the Commons Clause. They are not part of the skep package and are not covered by skep’s licence; see NOTICE.

Contribute

Set up a checkout

Python 3.12 or newer and uv. The default test suite needs no model, no credentials, no network and no Docker.

1 Development setup
$ git clone https://github.com/Anmolnoor/skep.git
$ cd skep
$ uv sync --frozen
$ make all

make all runs lint, type checking and the default test suite. If make is not installed, run the commands in step 2 directly.

Gates

What a pull request has to pass

CI runs these on Linux and macOS. Run them locally first: all six green.

2 The six gates
$ TMPDIR=$HOME/.cache/skep-test-tmp uv run --with pytest-xdist --with pytest-cov pytest -q -n auto --cov=skep --cov-report=xml
$ uvx diff-cover coverage.xml --compare-branch=origin/main --fail-under=90
$ uv run ruff check .
$ uv run ruff format --check src/skep tests scripts
$ uv run mypy
$ TMPDIR=$HOME/.cache/skep-test-tmp uv run python scripts/scorecard.py
  • The suite has no known failures. A red test is yours, not a pre-existing one.
  • Diff coverage, 90%. The lines your change adds have to be run by a test. make all does not check this; CI does.
  • TMPDIR outside /tmp on Linux. The sandbox tests hide /tmp, so tests that keep their files there fail.
  • A hygiene scan in CI. A secrets scanner (gitleaks) runs on the Linux leg. A credential-shaped string in a test fixture turns the pull request red.
  • The macOS leg is narrower. It runs lint, types, unit tests and the smoke test; coverage, the sandbox smoke and the hygiene scan run on Linux only.
  • The website has its own checks. A change under site/ is built and link-checked by a separate workflow; see site/README.md.

What a change needs

Keep the safety model intact

From CONTRIBUTING.md. A change to worker execution, approval, sandboxing or re-verification comes with a test that proves the failure path.

Failure paths to prove

  • With no usable sandbox, a sandbox-mode worker does not start.
  • An unconfirmed re-verification blocks auto-landing.
  • A denied approval grants nothing.
  • A worker does not change your checkout or your default branch.

In the pull request

  • What changed, and how you verified it.
  • Any safety boundary it touches.
  • Known limits and follow-up work.
  • Docs that say what is enforced, what is policy and what is planned.

Repository

Current state

Read from GitHub and PyPI when the page loads.

Latest release
v1.6.0 on PyPI
Last push
see GitHub
Open issues and pull requests
see GitHub
Licence
MIT

GitHub counts open pull requests in that number. If the request fails, the values above are the ones the page was built with.