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

Uploaded Source

Built Distribution

ovos_config-2.0.0-py3-none-any.whl (65.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ovos-config-2.0.0.tar.gz
  • Upload date:
  • Size: 38.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.23

File hashes

Hashes for ovos-config-2.0.0.tar.gz
Algorithm Hash digest
SHA256 98ae81373fd65c2cbd3945a26b17f3522c546333a3e8d7b41fa7912a76c71bf2
MD5 3705b5bf0081ff9cc002918612487bab
BLAKE2b-256 b3ca6a35cb5b176697270ba5544113585b76f2219dc3eca4fdc2b390fa1f2f5c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ovos_config-2.0.0-py3-none-any.whl
  • Upload date:
  • Size: 65.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.23

File hashes

Hashes for ovos_config-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ab6e4b5a50930627e7ecec2e86ba7c961a52058a0ab9aabfcc10cb4a52fcaf69
MD5 ec25fbd11c4761c6b8bfc62cde9c98a8
BLAKE2b-256 5799c779617953765b57d08c0164835b892e52bef83ba62fde938498164843a0

See more details on using hashes here.

Supported by

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