Skip to main content

Test your package through the eyes of a newbie agent — a fresh AI agent reads only your docs/skills and tries to use your package.

Project description

newb

Test your package through the eyes of a newbie agent.

A fresh AI agent reads only your _skills/ (or equivalent docs) and tries to use your package. If it succeeds — your docs work. If it fails — your CI tells you why.

Install

pip install newb

Use

newb verify ./src/mypkg/_skills/mypkg
newb verify ./_skills --format markdown >> README.md

newb verify spins up a clean docker container with only your skills mounted (no host ~/.claude leak), then asks a fresh Claude agent four canonical questions:

  1. Identity — "What is this package for?" / "What problems does it solve?"
  2. Usage — "Show a working example" / "When should I NOT use this?"
  3. Boundary — author-supplied red tests in _red_tests.yaml ("Can this do ?" → must redirect, not hallucinate)

Output: JSON (for CI) or markdown (for README injection).

Requirements

  • Docker on PATH (for the agent sandbox).
  • ANTHROPIC_API_KEY in env (used inside the container).
  • Python 3.10+.

Library API

from pathlib import Path
import newb

result = newb.self_explain(Path("./src/mypkg/_skills/mypkg"))
print(newb.render_markdown(result))

Aliases

Also available as pip install newbie-test and pip install agentic-test (same package, defensive name reservations that depend on newb).

Heritage

newb was extracted from scitex-dev where the canonical integration still lives:

scitex-dev skills self-explain <package-name>

License

AGPL-3.0-only. Same as the SciTeX ecosystem from which newb was extracted.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

newb-0.1.0.tar.gz (10.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

newb-0.1.0-py3-none-any.whl (9.3 kB view details)

Uploaded Python 3

File details

Details for the file newb-0.1.0.tar.gz.

File metadata

  • Download URL: newb-0.1.0.tar.gz
  • Upload date:
  • Size: 10.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.0rc1

File hashes

Hashes for newb-0.1.0.tar.gz
Algorithm Hash digest
SHA256 5054df627279561e8514551a426df8a6e90fdc216322a48d0fae05f1f3cecc87
MD5 727cc8dd2b1dd62e1e5da55ff6ce2324
BLAKE2b-256 8017e81648651122920af671399ae774fe04722c2414fdb95c4d4ae9836c1665

See more details on using hashes here.

File details

Details for the file newb-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: newb-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 9.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.0rc1

File hashes

Hashes for newb-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e7ca3a243babe6a1e9d179fa42aaed3080e0ecdec5b06d99e1dffe3d0a8ca072
MD5 390553c23f80c64fa644564f841304ab
BLAKE2b-256 2e1649fb6ade9a3bff9f9ac4d4118a0913a31d41892e8e9dfbf94b708ca329f5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page