ovos-spec-tools

Reference implementation of the OVOS formal specifications — the low-level, dependency-light primitives those specifications describe.

OVOS components reimplement template expansion, resource loading, and language matching in several places, and the copies drift. This package is the single conformant implementation those components — and any third-party tool — can depend on.

Status

Tool	Spec	Code
Sentence template expander	OVOS-INTENT-1 v2	`expansion.py`
Locale resource loader	OVOS-INTENT-2	`resources.py`
Dialog renderer	OVOS-INTENT-2 §4.2	`dialog.py`
Prompt renderer	OVOS-INTENT-2 §4.4	`prompt.py`
Language-tag matching	OVOS-INTENT-2 §2.2	`language.py`
Bus message envelope	OVOS-MSG-1	`message.py`
`ovos-spec-lint` locale linter	OVOS-INTENT-1 / -2	`lint.py`

Install

pip install ovos-spec-tools            # core — no dependencies
pip install ovos-spec-tools[langcodes] # adds the smart language fallback

Requires Python 3.10+.

Quick taste

from ovos_spec_tools import (expand, LocaleResources, render, render_prompt,
                             closest_lang, Message)

expand("(turn|switch) [the] light")          # all 4 sentences it denotes
res = LocaleResources("my-skill/locale")
res.load_intent("play", "en-US")             # a skill's intent samples
render(res.load_dialog("weather", "en-US"),  # a spoken response
       slots={"temperature": 21})
render_prompt(res.load_prompt("system", "en-US"),  # a language-model prompt
              slots={"query": "what time is it"})
closest_lang("en-AU", ["pt-BR", "en-US"])    # 'en-US'

# OVOS-MSG-1 envelope: a bus message and its 'send back to the asker' reply
m = Message("ovos.intent.list", {}, {"source": "skill.id"})
res = m.response({"intents": ["..."]})       # 'ovos.intent.list.response'
res.serialize()                              # single UTF-8 JSON object

ovos-spec-lint my-skill/locale               # validate a locale folder

Documentation

A zero-to-hero guide lives in docs/:

Getting started — install, and a first taste of every tool.
Sentence templates — the grammar: alternatives, optionals, slots, vocabulary references, malformed forms.
Locale resources — the locale/ folder, the six file roles, loading across languages, override precedence.
Dialog — choosing and filling a spoken response, and rendering language-model prompts.
Language matching — tag standardization, distance, and closest-match resolution.
Bus messages — the on-the-wire envelope, the forward / reply / response derivations, and the session carrier.
Linting — validating a locale folder, on the CLI or in CI.
API reference — every public name, in brief.

Runnable example scripts are in examples/.

Credits

Developed by TigreGótico for OpenVoiceOS.

This project was funded through the NGI0 Commons Fund, a fund established by NLnet with financial support from the European Commission's Next Generation Internet programme, under the aegis of DG Communications Networks, Content and Technology under grant agreement No 101135429.

License

Apache 2.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ovos_spec_tools-0.12.0a1.tar.gz (68.2 kB view details)

Uploaded Jun 26, 2026 Source

Built Distribution

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

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

ovos_spec_tools-0.12.0a1-py3-none-any.whl (48.7 kB view details)

Uploaded Jun 26, 2026 Python 3

File details

Details for the file ovos_spec_tools-0.12.0a1.tar.gz.

File metadata

Download URL: ovos_spec_tools-0.12.0a1.tar.gz
Upload date: Jun 26, 2026
Size: 68.2 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for ovos_spec_tools-0.12.0a1.tar.gz
Algorithm	Hash digest
SHA256	`02f8a463df21e7a573445dbb5dac6aa690b55fb72685fbec86b0d3773ce7c8ef`
MD5	`67b72afd34f9c167beb35eec47952f99`
BLAKE2b-256	`cb701741ec30d61ef7789a3adea797d0f234955221426beb33eda8ee2eaab8f7`

See more details on using hashes here.

File details

Details for the file ovos_spec_tools-0.12.0a1-py3-none-any.whl.

File metadata

Download URL: ovos_spec_tools-0.12.0a1-py3-none-any.whl
Upload date: Jun 26, 2026
Size: 48.7 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for ovos_spec_tools-0.12.0a1-py3-none-any.whl
Algorithm	Hash digest
SHA256	`1cc81d2d9e7eed851aa64cb20a838bd7042b16e1d4afd5d081aa23eab0744eb2`
MD5	`c746354027151ba21cfa1837473e3dcb`
BLAKE2b-256	`9d69390d1f464a378ded93a20813a96c28a1e0e7e05713f144d711865c9454f5`