Skip to main content

ovos-core configuration module

Project description

License Unit Tests codecov PRs Welcome Chat GitHub 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

ovos-config

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

      ovos-config2

      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

image

  • 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

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ovos-config-1.0.1.tar.gz (23.8 kB view details)

Uploaded Source

Built Distribution

ovos_config-1.0.1-py3-none-any.whl (61.5 kB view details)

Uploaded Python 3

File details

Details for the file ovos-config-1.0.1.tar.gz.

File metadata

  • Download URL: ovos-config-1.0.1.tar.gz
  • Upload date:
  • Size: 23.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for ovos-config-1.0.1.tar.gz
Algorithm Hash digest
SHA256 8bbe71cfaa098250816dea499e146ec7b7cbfe4b37ea69dad0935b0e056e7516
MD5 3c7009efdc756ef68b6ec2f894319e7f
BLAKE2b-256 7abc6312a372a9a8189c661276ec3c8bfed91aaad82143d31f04aaadb39ecb02

See more details on using hashes here.

File details

Details for the file ovos_config-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: ovos_config-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 61.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for ovos_config-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0cf11d1ca5dec28b33473ced90b805ffbcafba1ad1d8839842a2b066458bfcc5
MD5 253d278213183f78ee3ad5eb7af0a4f8
BLAKE2b-256 bbdc2b32918e422f9c6d15a38314a83debf0a2181c59be782beda6a66b9a9530

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page