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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: ovos-config-1.0.0a1.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.0a1.tar.gz
Algorithm Hash digest
SHA256 f300ec529938baf37a514ca3db08f1ca9873cd6729d241735722d637cc8da46d
MD5 40cd999c5cc16f7b7329a329c9e588c5
BLAKE2b-256 8cf4581af95769bf0f6e699252202e44dcff5f4d67c64a6c09a086ea951bb615

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ovos_config-1.0.0a1-py3-none-any.whl
Algorithm Hash digest
SHA256 b1fdd27f1354930a5e57f82d2a2022a73c22e4878dd67b091786ea6e39b12c1b
MD5 42b5c10054986126b072dc0d984df586
BLAKE2b-256 4dcad42256e984ba29fd67189aac13e7ffb9840f9c3d1d40aa28c39f229f7162

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