Installation
August 1, 2026 · View on GitHub
Requirements
- Python 3.9 or later
- No native extensions; pure Python
Stable release (PyPI)
pip install palavreado
This installs the core library only (IntentContainer, IntentCreator, normalisation utilities). It does not install the OVOS pipeline plugin or its bus-client dependencies.
With the OVOS pipeline plugin
pip install "palavreado[ovos]"
Pulls in the extra dependencies required by PalavreadoPipeline:
| Package | Purpose |
|---|---|
ovos-bus-client | Message-bus client and Message type |
ovos-config | Reads mycroft.conf / ovos.conf |
ovos-plugin-manager | ConfidenceMatcherPipeline base class |
| Package | Purpose |
|---|---|
ovos-utils | FakeBus, flatten_list, logging |
langcodes | BCP-47 language tag resolution |
From source
git clone https://github.com/TigreGotico/palavreado
cd palavreado
pip install -e .
# or with OVOS extras:
pip install -e ".[ovos]"
setuptools-scm is used for versioning; working from a git checkout gives an accurate version string.
Development dependencies
pip install "palavreado[dev]"
Installs pytest and pytest-cov for running the test suite.
Verifying the install
from palavreado import IntentContainer, IntentCreator
c = IntentContainer()
intent = IntentCreator("hello").require("greeting", ["hello", "hi"])
c.add_intent(intent)
print(c.calc_intent("hello world"))
# {'name': 'hello', 'conf': 0.8, 'keywords': {'greeting': ['hello']}, ...}
Core runtime dependencies
Installed automatically with pip install palavreado:
| Package | Purpose |
|---|---|
simplematch | Pattern-to-regex conversion for autoregex slots (palavreado/builder.py:14) |
quebra_frases | Tokenisation and chunk matching (palavreado/__init__.py:14) |