Skip to main content

Model tournament knockout stages in JSON format and render the schedule in SVG or html table format

Project description

matamata

PyPI Python versions CI Docs License: MIT

Model a tournament knockout stage in a small JSON "language" and render the schedule in SVG or HTML table format.

matamata also lets a host system map documents representing championship knockout stages onto its own business objects (e.g. a Championship or Cup entity) and persist them apart from any presentation concern — updating results means editing a document, never the code.

Example rendered from examples/libertadores-2026.json:

Copa Libertadores 2026 knockout stage

Quickstart

Requires Python ≥ 3.10. No runtime dependencies. Install from PyPI:

pip install matamata

Render a knockout stage document — plain JSON following the format — to an SVG file, or to an HTML table for small screens:

# the installed command
matamata stage.json -o schedule.svg

# or via the module, writing to stdout
python -m matamata stage.json > schedule.svg

# or as an HTML table
matamata stage.json -o schedule.html

Open the result in a browser to view the schedule. From Python:

from matamata import load_stage, render_svg

svg = render_svg(load_stage("stage.json"))

Ready-to-render worked examples live in examples/. For the latest unreleased commit use pip install git+https://github.com/anibalpacheco/matamata.git; to work on matamata itself, clone the repo and pip install -e ..

Examples

Both examples are rendered from the JSON files in examples/.

The Copa Libertadores example above shows two-legged ties — each leg's goals are shown, shootouts appear in parentheses, and the winner of each tie is emphasized. The first quarterfinal is host-resolved: its legs carry only a ref, so its teams and scores come from get_match (see examples/libertadores_host.py) rather than from the document. Played ties take their team names from the legs; the final is a single match — one leg, so just one goal figure per side — with its winnerof links wiring the advancement tree.

Single matches (knockout-8.json) — one goal figure per side, with shootouts in parentheses. Sides that have not been resolved yet fall back to placeholders such as "Winner SF2":

World Cup knockout stage

The format

The document is plain JSON, so any system can store and exchange it natively, and the language is designed so a match can evolve from a placeholder (e.g. "winner of QF1") into a reference to a real match entity — each leg can carry a ref to the real game, resolved dynamically by the host — without changing the language. The advancement tree is laid out deterministically: coordinates are computed directly and the SVG is emitted as a string, with no layout engine and no heavy dependencies.

See the format specification and its JSON Schema. Worked examples live in examples/.

Minimal example:

{
  "tournament": "Copa Libertadores",
  "season": "2026",
  "rounds": [
    {
      "name": "Final",
      "matches": [
        {
          "id": "final",
          "legs": [
            { "team1": "Flamengo", "goals1": 1, "team2": "Nacional", "goals2": 2 }
          ],
          "winner": 2
        }
      ]
    }
  ]
}

Documentation

The manual covers rendering from the CLI and from Python (e.g. a Django view), feeding live data from your own database through KnockoutStage, updating the stored document with apply_results — including a before/after walkthrough of one call — and running the test suite.

Status

Working: the language spec, JSON Schema, Python renderer, CLI and tests are in place, and the package is installable from GitHub.

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

matamata-0.0.5.tar.gz (740.3 kB view details)

Uploaded Source

Built Distribution

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

matamata-0.0.5-py3-none-any.whl (21.8 kB view details)

Uploaded Python 3

File details

Details for the file matamata-0.0.5.tar.gz.

File metadata

  • Download URL: matamata-0.0.5.tar.gz
  • Upload date:
  • Size: 740.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for matamata-0.0.5.tar.gz
Algorithm Hash digest
SHA256 97b3168b7cfc7e04ff2bbb7bef78fe639ae5a9ac4db699cac2e7fb9b9ad67bf7
MD5 571a73ed3aa95681694fb870fa14b39f
BLAKE2b-256 03c7affd89f11178ec22d8071c6a6efea4318bba1a77ee82a7dbfcd5083bf6f4

See more details on using hashes here.

Provenance

The following attestation bundles were made for matamata-0.0.5.tar.gz:

Publisher: release.yml on anibalpacheco/matamata

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

File details

Details for the file matamata-0.0.5-py3-none-any.whl.

File metadata

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

File hashes

Hashes for matamata-0.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 f6a7bcf8c3f172013cae0b7ea2ef734a28e5cf34c5c21b21b9ea72ea99dc2352
MD5 e71556e3a0e3ffb456f07d4f4502155e
BLAKE2b-256 190207a0381b16e6d168552ea575b63d935b7c3eed206bbcffed48f6a7a9024a

See more details on using hashes here.

Provenance

The following attestation bundles were made for matamata-0.0.5-py3-none-any.whl:

Publisher: release.yml on anibalpacheco/matamata

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