This release is a pre-release and may not be stable for production use.
OVOS Workshop
Base classes, decorators, and helpers for building skills and applications for OpenVoiceOS.
Install
pip install ovos-workshop
Runtime dependencies include ovos-yes-no-plugin and ovos-option-matcher-fuzzy-plugin, which back the ask_yesno and ask_selection skill methods.
Quick Start
from ovos_workshop.skills.ovos import OVOSSkill
from ovos_workshop.decorators import intent_handler
class HelloWorldSkill(OVOSSkill):
@intent_handler("hello.intent")
def handle_hello(self, message):
self.speak_dialog("hello.response")
def create_skill():
return HelloWorldSkill()
Register in pyproject.toml:
[project.entry-points."opm.skill"]
hello-world-skill = "hello_world_skill:HelloWorldSkill"
Configuration
Key settings a skill can accept in its settings.json:
| Key | Default | Description |
|---|---|---|
ask_yesno_plugin |
ovos-solver-yes-no-plugin |
YesNoEngine plugin used by ask_yesno() |
ask_selection_plugin |
ovos-option-matcher-fuzzy-plugin |
OptionMatcherEngine plugin used by ask_selection() |
Both keys can also be set system-wide under the skills block in mycroft.conf.
Documentation
The OVOS Technical Manual is the canonical skill-authoring guide. Repo-local reference with exact source citations is in docs/:
- Skill classes
- OVOSSkill base class
- ask_yesno / ask_selection plugin system
- Decorators
- Settings
- Resource files
- Prerelease quirks — what changed since the last stable release
License
Apache 2.0
4 maintainers
Metadata
4 maintainers
Release files for ovos-workshop 9.8.14a1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ovos_workshop-9.8.14a1.tar.gz | 122.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ovos_workshop-9.8.14a1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 270.7 kB
Release files / ovos_workshop-9.8.14a1.tar.gz
| Download URL | ovos_workshop-9.8.14a1.tar.gz |
|---|---|
| Size | 122.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
24668be23e0061f39464d729c700ba055af082b79eb7bde65b8134f902a99ce3
|
|
BLAKE2b-256 checksum How to use checksums |
c7b735dc2197e89958f10e8ad5315ac69e647152ff1555f93df36e540e83eba8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / ovos_workshop-9.8.14a1-py3-none-any.whl
| Download URL | ovos_workshop-9.8.14a1-py3-none-any.whl |
|---|---|
| Size | 148.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d941adae512235eea79102aa559e9ca31a28af60e0679836aea507294a3abc19
|
|
BLAKE2b-256 checksum How to use checksums |
48ff4a56e35a130998dd612f130d4c3b8713a0824d7ab2f32aa5cc08402dd3df
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
