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
Release files for ovos-workshop 9.8.0a1
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.0a1.tar.gz | 112.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ovos_workshop-9.8.0a1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 236.1 kB
Release files / ovos_workshop-9.8.0a1.tar.gz
| Download URL | ovos_workshop-9.8.0a1.tar.gz |
|---|---|
| Size | 112.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a48afe837622747b20278982ca01e7959e395a897b579b419b20c19805fe5a66
|
|
BLAKE2b-256 checksum How to use checksums |
d9cc120a89e90c20a0946d22a0e5f157ddaa4b62b2a625136b152cd2dd96abca
|
| 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.0a1-py3-none-any.whl
| Download URL | ovos_workshop-9.8.0a1-py3-none-any.whl |
|---|---|
| Size | 124.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
37783d5564ddf972faebc5f48e481a68e7803bc0932782133e4c6f090404d421
|
|
BLAKE2b-256 checksum How to use checksums |
58c68551af18690b73716f9993036e5e6be8cc688704eb43ef9eba1e83742dfe
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
