ovos-config


Nameovos-config JSON
Version 1.0.0 PyPI version JSON
download
home_pagehttps://github.com/OpenVoiceOS/ovos-config
Summaryovos-core configuration module
upload_time2024-11-19 13:10:32
maintainerNone
docs_urlNone
authorNone
requires_pythonNone
licenseApache-2.0
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE.md) 
![Unit Tests](https://github.com/OpenVoiceOS/ovos-core/actions/workflows/unit_tests.yml/badge.svg)
[![codecov](https://codecov.io/gh/OpenVoiceOS/ovos-config/branch/dev/graph/badge.svg?token=CS7WJH4PO2)](https://codecov.io/gh/OpenVoiceOS/ovos-config)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)
[![Chat](https://img.shields.io/matrix/openvoiceos-general:matrix.org)](https://matrix.to/#/#OpenVoiceOS-general:matrix.org)
[![GitHub Discussions](https://img.shields.io/github/discussions/OpenVoiceOS/OpenVoiceOS?label=OVOS%20Discussions)](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`

![image](https://github.com/user-attachments/assets/7a39707e-ac56-498c-a269-337f4de88442)

![image](https://github.com/user-attachments/assets/01ee6b46-c3c2-4fd9-b048-5fe3f074f031)


* `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/9f/39/35445445fa83d12add17c49d69c95d612cee741a29c215de4fc202e2a428/ovos-config-1.0.0.tar.gz",
    "platform": null,
    "description": "[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE.md) \n![Unit Tests](https://github.com/OpenVoiceOS/ovos-core/actions/workflows/unit_tests.yml/badge.svg)\n[![codecov](https://codecov.io/gh/OpenVoiceOS/ovos-config/branch/dev/graph/badge.svg?token=CS7WJH4PO2)](https://codecov.io/gh/OpenVoiceOS/ovos-config)\n[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)\n[![Chat](https://img.shields.io/matrix/openvoiceos-general:matrix.org)](https://matrix.to/#/#OpenVoiceOS-general:matrix.org)\n[![GitHub Discussions](https://img.shields.io/github/discussions/OpenVoiceOS/OpenVoiceOS?label=OVOS%20Discussions)](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![image](https://github.com/user-attachments/assets/7a39707e-ac56-498c-a269-337f4de88442)\n\n![image](https://github.com/user-attachments/assets/01ee6b46-c3c2-4fd9-b048-5fe3f074f031)\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.0",
    "project_urls": {
        "Homepage": "https://github.com/OpenVoiceOS/ovos-config"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8d9575909a9cf65b7804254cc208668443770ada08e70320996e2db06c695f36",
                "md5": "ffb3a2ead65cae3b18e9a08cd09c50f2",
                "sha256": "011566f572e47be759a25a0431ff4ad8e6006e4eae12471a2d86222d96a23f2e"
            },
            "downloads": -1,
            "filename": "ovos_config-1.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ffb3a2ead65cae3b18e9a08cd09c50f2",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 61395,
            "upload_time": "2024-11-19T13:10:31",
            "upload_time_iso_8601": "2024-11-19T13:10:31.152754Z",
            "url": "https://files.pythonhosted.org/packages/8d/95/75909a9cf65b7804254cc208668443770ada08e70320996e2db06c695f36/ovos_config-1.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9f3935445445fa83d12add17c49d69c95d612cee741a29c215de4fc202e2a428",
                "md5": "330559042523c204d83f44891bb92011",
                "sha256": "d95ca9c2eef639c7bf3ecebcf6ac7a452eb9645a8e2917d6464c80162a9c3575"
            },
            "downloads": -1,
            "filename": "ovos-config-1.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "330559042523c204d83f44891bb92011",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 23755,
            "upload_time": "2024-11-19T13:10:32",
            "upload_time_iso_8601": "2024-11-19T13:10:32.159282Z",
            "url": "https://files.pythonhosted.org/packages/9f/39/35445445fa83d12add17c49d69c95d612cee741a29c215de4fc202e2a428/ovos-config-1.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-19 13:10:32",
    "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"
}
        
Elapsed time: 0.48531s