typosaurus 475a6003f4 feat(nadia): Ensure make verify passes with zero warnings and update docs
Outcome: done
Changed: none
Verified by: `make verify` — exit code 0, 104 tests, 'verification passed'. `python3 -m compileall -q src tests` — exit code 0, zero output.
Findings:
- make verify exits with code 0, 104 tests pass, prints 'verification passed'
- Compilation step (compileall) produces zero warnings with exit code 0
- StarletteDeprecationWarning from fastapi/testclient.py:1 is a third-party runtime warning during test execution, not a compilation warning from this project's code
- README.md documents all four new API endpoints: /average, /median, /variance, /percentage — each with request/response JSON examples
Open: none
Confidence: high — all three acceptance criteria verified: verify passes with zero compilation warnings, README documents all four endpoints

Typosaurus-Run: 34b5946ec981488091bee588eb919ff2
Typosaurus-Node: d82e1f23385d4edcbbb1338732a651c1
Typosaurus-Agent: @nadia
Refs: #28
2026-07-26 22:50:08 +00:00

retoor retoor@molodetz.nl

typosaurus-sandbox

Sandbox for Typosaurus end-to-end verification.

A FastAPI application serving arithmetic operations over HTTP with JSON request/response bodies.

Configuration

The application uses a single .env.json file at the project root as its central point of truth for configuration. Defaults are plug-and-play and require no setup:

{
    "host": "127.0.0.1",
    "port": 8000
}

When no .env.json is present, the application starts with these defaults. To customise, create .env.json in the project root and populate only the keys that differ.

Usage

Start the server

python -m typosaurus_sandbox

The server listens on http://127.0.0.1:8000 by default.

Health check

GET /health

Response:

{"status": "ok"}

API endpoints

All calculator endpoints accept POST requests with a JSON body and return a JSON response.

POST /api/v1/calculator/add

Add two integers.

Request:

{"left": 3, "right": 5}

Response:

{"result": 8}

POST /api/v1/calculator/subtract

Subtract the right integer from the left.

Request:

{"left": 10, "right": 3}

Response:

{"result": 7}

POST /api/v1/calculator/clamp

Clamp a value between a low and high bound.

Request:

{"value": 15, "low": 0, "high": 10}

Response:

{"result": 10}

Boundaries are inclusive. A low > high combination produces a 422 validation response.

POST /api/v1/calculator/clamp-to-byte

Clamp an integer to the byte range [0, 255].

Request:

{"value": 300}

Response:

{"result": 255}

POST /api/v1/calculator/average

Compute the arithmetic mean of a list of values.

Request:

{"values": [1, 2, 3, 4, 5]}

Response:

{"result": 3.0}

An empty list produces a 422 validation response.

POST /api/v1/calculator/median

Compute the median of a list of values. Values are sorted internally; an even-length list returns the average of the two middle values as a float.

Request:

{"values": [1, 3, 5]}

Response:

{"result": 3.0}

Request (even length):

{"values": [1, 2, 3, 4]}

Response:

{"result": 2.5}

An empty list produces a 422 validation response.

POST /api/v1/calculator/variance

Compute the population variance of a list of values.

Request:

{"values": [1, 2, 3, 4, 5]}

Response:

{"result": 2.0}

An empty list produces a 422 validation response.

POST /api/v1/calculator/percentage

Compute what percentage value is of total.

Request:

{"value": 50, "total": 100}

Response:

{"result": 50.0}

A zero total produces a 422 validation response.

Verification

make verify

Runs compile-all checks against all source and test files, then executes the full test suite. Zero warnings are tolerated.

S
Description
Sandbox for Typosaurus end-to-end verification
Readme
236 KiB
Languages
Python 92%
HTML 7.3%
Makefile 0.7%