[](LICENSE.md)
[](https://codecov.io/gh/OpenVoiceOS/ovos-config)
[](http://makeapullrequest.com)
[](https://matrix.to/#/#OpenVoiceOS-general:matrix.org)
[](https://github.com/OpenVoiceOS/OpenVoiceOS/discussions)
# OVOS-config
helper package to interact with mycroft config
## Command Line usage
A small helper tool is included to quickly show, get or set config values
<img width="1214" alt="ovos-config" src="https://user-images.githubusercontent.com/25036977/219516755-b454f28f-2a34-4caf-a91f-6182ff68049a.png">
Quick rundown (cli):
* `ovos-config get`
* Loose search (search a key or parts therof):\
\
Given an entry of
{'PHAL': {
'ovos-PHAL-plugin-system': {
'enabled': True
},
'ovos-PHAL-plugin-connectivity-events': {
'enabled': True
},
...
}
`ovos-config get -k phal` would yield **all** PHAL entries and present it to the user (and the path where they were found)
* Strict search (search keys in a distinct location):
`ovos-config get -k /PHAL/ovos-PHAL-plugin-system/enabled`
This will output only the value or exit out if no key is found (root slash indicating a strict search)
* `ovos-config set`
* Searches loosely for keys containing the query string and presents a choice to the user to define a value
`ovos-config set -k phal`
<img width="423" alt="ovos-config2" src="https://user-images.githubusercontent.com/25036977/219526126-dfc547e7-6110-461a-92ba-83e850d03c70.png">
The type is derived from the joined config and thus can be safely cast into the user conf.\
Optionally a value (`-v`) can be sent as an argument.
* `ovos-config autoconfigure`
* `ovos-config show`
* Get a full table of either the joined, user (`-u`), system (`-s`) or remote (`-r`) configuration.
This can be further refined by passing a `--section`, which can be listed with `ovos-config show -l`
Raw data
{
"_id": null,
"home_page": "https://github.com/OpenVoiceOS/ovos-config",
"name": "ovos-config",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/7a/bc/6312a372a9a8189c661276ec3c8bfed91aaad82143d31f04aaadb39ecb02/ovos-config-1.0.1.tar.gz",
"platform": null,
"description": "[](LICENSE.md) \n\n[](https://codecov.io/gh/OpenVoiceOS/ovos-config)\n[](http://makeapullrequest.com)\n[](https://matrix.to/#/#OpenVoiceOS-general:matrix.org)\n[](https://github.com/OpenVoiceOS/OpenVoiceOS/discussions)\n\n# OVOS-config\n\nhelper package to interact with mycroft config\n\n## Command Line usage\n\nA small helper tool is included to quickly show, get or set config values\n\n<img width=\"1214\" alt=\"ovos-config\" src=\"https://user-images.githubusercontent.com/25036977/219516755-b454f28f-2a34-4caf-a91f-6182ff68049a.png\">\n\nQuick rundown (cli):\n\n* `ovos-config get`\n\n * Loose search (search a key or parts therof):\\\n \\\nGiven an entry of\n\n {'PHAL': {\n 'ovos-PHAL-plugin-system': {\n 'enabled': True\n },\n 'ovos-PHAL-plugin-connectivity-events': {\n 'enabled': True\n },\n ... \n }\n\n `ovos-config get -k phal` would yield **all** PHAL entries and present it to the user (and the path where they were found)\n\n\n * Strict search (search keys in a distinct location): \n\n `ovos-config get -k /PHAL/ovos-PHAL-plugin-system/enabled` \n\n This will output only the value or exit out if no key is found (root slash indicating a strict search)\n\n* `ovos-config set` \n\n * Searches loosely for keys containing the query string and presents a choice to the user to define a value\n\n `ovos-config set -k phal`\n\n <img width=\"423\" alt=\"ovos-config2\" src=\"https://user-images.githubusercontent.com/25036977/219526126-dfc547e7-6110-461a-92ba-83e850d03c70.png\">\n\n The type is derived from the joined config and thus can be safely cast into the user conf.\\\n Optionally a value (`-v`) can be sent as an argument.\n\n\n* `ovos-config autoconfigure`\n\n\n\n\n\n\n* `ovos-config show` \n\n * Get a full table of either the joined, user (`-u`), system (`-s`) or remote (`-r`) configuration.\n This can be further refined by passing a `--section`, which can be listed with `ovos-config show -l`\n\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "ovos-core configuration module",
"version": "1.0.1",
"project_urls": {
"Homepage": "https://github.com/OpenVoiceOS/ovos-config"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bbdc2b32918e422f9c6d15a38314a83debf0a2181c59be782beda6a66b9a9530",
"md5": "253d278213183f78ee3ad5eb7af0a4f8",
"sha256": "0cf11d1ca5dec28b33473ced90b805ffbcafba1ad1d8839842a2b066458bfcc5"
},
"downloads": -1,
"filename": "ovos_config-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "253d278213183f78ee3ad5eb7af0a4f8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 61522,
"upload_time": "2024-11-23T19:40:21",
"upload_time_iso_8601": "2024-11-23T19:40:21.548464Z",
"url": "https://files.pythonhosted.org/packages/bb/dc/2b32918e422f9c6d15a38314a83debf0a2181c59be782beda6a66b9a9530/ovos_config-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7abc6312a372a9a8189c661276ec3c8bfed91aaad82143d31f04aaadb39ecb02",
"md5": "3c7009efdc756ef68b6ec2f894319e7f",
"sha256": "8bbe71cfaa098250816dea499e146ec7b7cbfe4b37ea69dad0935b0e056e7516"
},
"downloads": -1,
"filename": "ovos-config-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "3c7009efdc756ef68b6ec2f894319e7f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 23757,
"upload_time": "2024-11-23T19:40:23",
"upload_time_iso_8601": "2024-11-23T19:40:23.081914Z",
"url": "https://files.pythonhosted.org/packages/7a/bc/6312a372a9a8189c661276ec3c8bfed91aaad82143d31f04aaadb39ecb02/ovos-config-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-23 19:40:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "OpenVoiceOS",
"github_project": "ovos-config",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ovos-config"
}
JSON
