Skip to main content

Protocol specifications as Python code

Project description

Wunderspec

Wunderspec

PyPI Lint Build Run Examples Convert to TLA+

Wunderspec is a Python DSL for writing and checking executable specifications.

Distributed systems often fail due to unforeseen issues: message reordering, race condition, stale observations, retry behavior, crashes and restarts, network outages, vibe code. Adding more example tests is often not enough to find these bugs before they make it to production. Specifications written in Wunderspec surface these issues early, so that teams find design flaws before they become production incidents.

This is the open-core distribution.

:clipboard: Wunderspec in 5 minutes: the Wunderspec in Five Minutes gives you a quick overview of the core concepts.

:clipboard: Cheatsheet: the Wunderspec cheatsheet summarizes the DSL and CLI in a few pages — keep it open while you work.

:bulb: Using Quint? Try this command:

uv tool install wunderspec
wunderspec convert --from=spec.qnt --to=spec.py --main=main
Wunderspec Flower

1. Wunderspec in Action

Follow Bob in his Wunderspec adventure. There, Bob writes a specification of a write-ahead log, finds a bug, replays the counterexample and fixes the specification.

2. Installation

Using uv:

uv tool install wunderspec

After installation, the CLI is available:

wunderspec --help

If you want to add Wunderspec as a dependency, just type:

uv add wunderspec
uv sync

3. Features

This open-core package includes the features marked ✅ in the Open Core column. Premium-only command names stay visible for discoverability, but those commands are not included in this package.

Feature Open Core Premium
Symbolic expression evaluator
wunderspec lint
wunderspec run
wunderspec replay
wunderspec convert
wunderspec check
wunderspec with-tlc
wunderspec with-apalache
wunderspec fuzz
wunderspec rust
wunderspec lean

4. Release Provenance

  • Release tag: v0.136.4
  • Source commit: 7beedd2736b068f1c371f59fd8ed619a1d9e75a5

See tests/README.md for the development test log captured at release time.

5. Latest Release Notes

Changes since public release v0.136.1.

  • Add an inductive invariant in examples/tendermint_single_indinv.py.

6. License

Wunderspec is distributed under the Functional Source License, Version 1.1, with an Apache 2.0 future license (FSL-1.1-ALv2). See LICENSE.

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

wunderspec-0.136.4.tar.gz (4.2 MB view details)

Uploaded Source

Built Distribution

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

wunderspec-0.136.4-py3-none-any.whl (269.8 kB view details)

Uploaded Python 3

File details

Details for the file wunderspec-0.136.4.tar.gz.

File metadata

  • Download URL: wunderspec-0.136.4.tar.gz
  • Upload date:
  • Size: 4.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for wunderspec-0.136.4.tar.gz
Algorithm Hash digest
SHA256 9934f614ce3fb39180f7b348938fce29afed3d3cd214f3f22d69b7b45896500c
MD5 5b6c73e3af26b278d1c0d7a2a7e25fa3
BLAKE2b-256 812c6d0b011cdac9d0b1dc79ca83746e71089bf9eea6df45affe04daec9affad

See more details on using hashes here.

Provenance

The following attestation bundles were made for wunderspec-0.136.4.tar.gz:

Publisher: publish.yml on wunderspec/wunderspec

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file wunderspec-0.136.4-py3-none-any.whl.

File metadata

  • Download URL: wunderspec-0.136.4-py3-none-any.whl
  • Upload date:
  • Size: 269.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for wunderspec-0.136.4-py3-none-any.whl
Algorithm Hash digest
SHA256 b16a21e9ee7f9ddba0f1d73239f66cf11bb58b1f67fd11e2d61a6e86f75b0e3f
MD5 f3fb05cc5bcbaf3bacba59743fe9af0f
BLAKE2b-256 04fb7d2be2361a5258b6b4343d074329831e593ef6e8d340c44b19bac75bc8d8

See more details on using hashes here.

Provenance

The following attestation bundles were made for wunderspec-0.136.4-py3-none-any.whl:

Publisher: publish.yml on wunderspec/wunderspec

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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