Skip to main content

A library for reading / writing Missim config files

Project description

Missim Config

Configuration management for MISSIM, backed by fluxconf.

Config is stored in ~/.config/greenroom/missim.yml.

Install

pip install -e ./packages/missim_config

Usage

Reading config

from missim_config import config_io

config = config_io.read()

Writing config

from missim_config import config_io, MissimConfig

config = MissimConfig()
config_io.write(config)

Getting the config path

from missim_config import config_io

path = config_io.get_path()

Generating schemas

After changing the dataclasses, you can generate the schemas with:

python3 -m missim_config.generate_schemas

Migrations

Schema migrations live in missim_config/migrations/. To add a migration:

  1. Create a file named N_description.py (e.g. 1_add_new_field.py)
  2. Define a migrate(data: dict) -> dict function that transforms the raw config dict
  3. The version field is managed automatically by fluxconf

Project details


Download files

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

Source Distribution

missim_config-3.1.3.tar.gz (9.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

missim_config-3.1.3-py3-none-any.whl (11.4 kB view details)

Uploaded Python 3

File details

Details for the file missim_config-3.1.3.tar.gz.

File metadata

  • Download URL: missim_config-3.1.3.tar.gz
  • Upload date:
  • Size: 9.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.19

File hashes

Hashes for missim_config-3.1.3.tar.gz
Algorithm Hash digest
SHA256 a148daa9c3e6fd03514ca56441cc112b41c37853dd01a802f941a53202aec76f
MD5 1cf806d22e74f0012911676a92d0fa74
BLAKE2b-256 6537903b62853fe7d093f275db8b6f6fc7febc426917e7a35d5c5960268b0008

See more details on using hashes here.

File details

Details for the file missim_config-3.1.3-py3-none-any.whl.

File metadata

  • Download URL: missim_config-3.1.3-py3-none-any.whl
  • Upload date:
  • Size: 11.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.19

File hashes

Hashes for missim_config-3.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 35900293f83a73200a56e9ca79d5e8b2b7f3b9d3312257a384be11c0743f794e
MD5 b549acc8d4b29c74e7a8183dd7926363
BLAKE2b-256 bf7684dbe1dae4f022c62871208a3839273e7615380e22699269136b853f979b

See more details on using hashes here.

Supported by

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