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.0.tar.gz (23.8 kB view details)

Uploaded Source

Built Distribution

ovos_config-1.0.0-py3-none-any.whl (61.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ovos-config-1.0.0.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.0.tar.gz
Algorithm Hash digest
SHA256 d95ca9c2eef639c7bf3ecebcf6ac7a452eb9645a8e2917d6464c80162a9c3575
MD5 330559042523c204d83f44891bb92011
BLAKE2b-256 9f3935445445fa83d12add17c49d69c95d612cee741a29c215de4fc202e2a428

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ovos_config-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 61.4 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 011566f572e47be759a25a0431ff4ad8e6006e4eae12471a2d86222d96a23f2e
MD5 ffb3a2ead65cae3b18e9a08cd09c50f2
BLAKE2b-256 8d9575909a9cf65b7804254cc208668443770ada08e70320996e2db06c695f36

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 Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page