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.skills"]
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
Full reference is in docs/:
- Skill classes
- OVOSSkill base class
- ask_yesno / ask_selection plugin system
- Decorators
- Settings
- Resource files
License
Apache 2.0
4 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ovos_workshop-9.2.4a1.tar.gz.
File metadata
- Download URL: ovos_workshop-9.2.4a1.tar.gz
- Upload date:
- Size: 90.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
bd209c2cd4b617b207bc3a6d6019c622b720ece799c2e97400e4c03dd44c33ef
|
|
| MD5 |
3db3727a87fb4d6b44185cdc26dec458
|
|
| BLAKE2b-256 |
f9a98df0f9095c53ce80afc325cea79cce03d771c45a95ad3b48c5b5e2ceafc0
|
File details
Details for the file ovos_workshop-9.2.4a1-py3-none-any.whl.
File metadata
- Download URL: ovos_workshop-9.2.4a1-py3-none-any.whl
- Upload date:
- Size: 103.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d43c651467b79168009c65ac0a8d3ca9c447c7a488c1750833ba87b878b81b44
|
|
| MD5 |
8edfc8d59e1f3fb45858c59eca8513cc
|
|
| BLAKE2b-256 |
4d61d48035acb512d842b74d48946faae0d4fcbfdd6389806865f6666a69e7a7
|
