Skip to content

docs: add terminal demo GIF to the top of the README - #10

Merged
godhiraj-code merged 1 commit into
mainfrom
docs/readme-demo-gif
Oct 20, 2026
Merged

godhiraj-code merged 1 commit into
mainfrom
docs/readme-demo-gif

Conversation

@godhiraj-code

Copy link
Copy Markdown
Owner

Adds a 29-second terminal demo (docs/demo.gif, 433 KB, 1158x676) under the one-line problem statement in the README.

What it shows, all real output from pytest-mockllm 0.4.0:

  1. A test using mock_openai passes in about 0.6s with OPENAI_API_KEY unset.
  2. A test using llm_recorder runs with --llm-record=once, writes a cassette, and the cassette shows the authorization header as '[REDACTED]'.
  3. The local server is stopped and the key unset, and the same test replays from the cassette and passes.

The recording run talks to a small local OpenAI-compatible server because the demo machine has no real key. The README says so in a one-line caption under the GIF. The image uses an absolute raw.githubusercontent.com URL on main so it also renders on PyPI after the next release.

tests/test_readme.py and tests/test_package.py pass locally. Not merged; for review.

@godhiraj-code
godhiraj-code merged commit c15a844 into main Oct 20, 2026
22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant