Skip to content

2.7.0

Choose a tag to compare

@jmtts jmtts released this 21 Sep 18:09
· 1405 commits to main since this release
e3ae4b6

2.7.0

42 commits since 2.6.0. Published to PyPI as werk24==2.7.0.

New in the models

  • AskDocumentProfile — a new ask answered from the file's shape before any
    interpretation begins, so it arrives ahead of the other responses.
    ResponseDocumentProfile carries the document type, page count, paper size and
    an expected processing time. The per-page assessment was later split out, so a
    page can say what it is in its own right.
  • Identifier taxonomy widened on both v1 and v2, with every member documented.
  • Material alternatives now record where each one was read.
  • BoundingDimensions gained annotation-completeness fields.
  • paper_size is an enum rather than a bare string, and the profile enums are
    forward-compatible against a server that learns a new member first.
  • REAR_EARTHS → RARE_EARTHS on MaterialCategory2 (v2) and
    W24MaterialCategory2 (v1). A _missing_ hook still accepts the old spelling,
    so payloads produced before the rename keep validating.

Transport and reliability

  • The drawing is encrypted to an X25519 key when the server offers one;
    encrypt_with_public_key / decrypt_with_private_key handle both key formats.
  • AskUnion is discriminated on ask_type instead of trying its members in
    order, so an ask comes back out as the class that went in.
  • One HTTPS session per client, and downloads moved off the receive loop.
  • Reads are bounded, configured retries are actually wired up, and the deadline
    actually bounds. A held-back message is delivered rather than cancelled.
  • Every response is released and the session is closed on the standalone paths.
  • A priority refusal is recognised in the envelope the API really sends, and an
    S3 upload refusal now says why.
  • Import cost cut: the websocket client and pint's unit registry are built on
    first use rather than at import.

Testing and CI

  • A callback end-to-end check runs a receiver behind a Cloudflare quick tunnel
    and holds every delivered callback against an explicit contract; it runs daily
    rather than in the default suite because it costs one billable read.
  • Workflows moved off the deprecated Node 20 action runtime.
  • Pinned dependencies refreshed against what a user actually installs.
  • Python 3.14 compatibility tests fixed; four tests no longer need a license.

Full changelog: 2.6.0...e3ae4b6