chumicro-config

Runtime config from one shared dotted-key shape (wifi.ssid, mqtt.broker.host).

Each library exposes a <Name>Config.from_config() factory that reads its own dotted-prefix section from a shared dict (wifi.*, mqtt.broker.*, etc.) and returns typed configuration. Apps load one runtime_config.msgpack at boot; libraries pull their slice out. No global registry, no hand-written if "key" in config: walls.

Part of the ChuMicro family: small, focused Python libraries for microcontrollers and laptops. Browse all libraries.

Install

# CircuitPython (after `circup bundle-add ChuMicro/ChuMicro-Bundle-Experimental`)
circup install chumicro_config

# MicroPython
mpremote mip install github:ChuMicro/ChuMicro-Bundle-Experimental/chumicro_config

# CPython
pip install chumicro-config-experimental

For bundle setup, pre-compiled .mpy bundles, the experimental channel, and details on PyPI naming, see the chumicro INSTALL guide.

Quick example

User-app pattern (the 2-line bring-up):

from chumicro_config import load_runtime_config
from chumicro_wifi import WifiConfig, WifiService

config = load_runtime_config()                          # reads /runtime_config.msgpack
wifi = WifiService(WifiConfig.from_config(config))      # reads + types the wifi.* keys

Library-side pattern (load_section builds a typed config from the flat-key payload, used today by chumicro-wifi):

from chumicro_config import load_section

class WifiConfig:
    def __init__(self, ssid, password, hostname=None, connect_timeout_ms=15_000): ...

    @classmethod
    def from_config(cls, config):
        return load_section(
            cls, config,
            prefix="wifi",
            required=("ssid", "password"),
            optional={"hostname": None, "connect_timeout_ms": 15_000},
        )

What's included

Symbol	What it does
`load_runtime_config(path=…)`	Read + decode `/runtime_config.msgpack` into a flat-key `RuntimeConfig` (dict-shaped)
`config`	Lazily-loaded module attribute: the deployed `RuntimeConfig`, or `None` when the file is absent. First attribute access reads the file once and caches the result
`RuntimeConfig`	Lookup wrapper over the flat-key payload: `get(key[, default])`, `[key]` / `require(key)`, `in` check
`load_section(cls, config, *, prefix, required=…, optional=…)`	Build `cls(**kwargs)` by reading flat-prefix keys. Used today by `chumicro-wifi`'s `WifiConfig.from_config`; available to any library whose constructor signature maps 1:1 to its config subkeys
`try_load_section(...)`	Soft variant: returns `None` instead of raising when `config` is `None`, the wrong type, or missing a required key
`MissingConfigKey` / `InvalidConfigType` / `ConfigError`	Targeted exceptions: single-inheritance from `ConfigError` (MicroPython forbids multi-parent layouts)

Where this fits

Depends on chumicro-msgpack for decode. Most ChuMicro libraries with a <Name>Config.from_config() factory read their slice off the shared RuntimeConfig via config.get(...); chumicro-wifi additionally uses the load_section helper here. Other consumers: chumicro-mqtt, chumicro-ntp, chumicro-requests, chumicro-websockets, chumicro-http_server.

Platform support

Works on CPython, MicroPython, and CircuitPython.

Examples

examples/end_to_end.py shows the full read → load_section → typed-config flow on CPython; see any consumer library (starting with chumicro-wifi) for the integrated usage shape.

Contributing

Issues, bug reports, and pull requests are welcome, and so is "I ran it on this board and here's what happened", some of the most useful feedback a hardware project can get. Development happens in the ChuMicro repository, whose contributing guide covers setup and the test workflow.

Docs

📖 Stable docs · Experimental docs

Find this library

PyPI: chumicro-config
Bundle: ChuMicro-Bundle (CircuitPython & MicroPython)
Experimental bundle: ChuMicro-Bundle-Experimental
Source: libraries/config

License

MIT

Download files

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

Source Distribution

chumicro_config_experimental-0.7.7.tar.gz (15.9 kB view details)

Uploaded Aug 18, 2026 Source

Built Distribution

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

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

chumicro_config_experimental-0.7.7-py3-none-any.whl (7.5 kB view details)

Uploaded Aug 18, 2026 Python 3

File details

Details for the file chumicro_config_experimental-0.7.7.tar.gz.

File metadata

Download URL: chumicro_config_experimental-0.7.7.tar.gz
Upload date: Aug 18, 2026
Size: 15.9 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for chumicro_config_experimental-0.7.7.tar.gz
Algorithm	Hash digest
SHA256	`e17f10dde6237e3b01ab387f66fdbaf35d2ce1ab89de2e7dcccae6cec6e3309c`
MD5	`e56f7d35787009795a069ca9d8b3c7c3`
BLAKE2b-256	`8d481651c52329f6b6a7aa25926e7f49f8d56e9b6a16a770668555c48d753a1d`

See more details on using hashes here.

Provenance

The following attestation bundles were made for chumicro_config_experimental-0.7.7.tar.gz:

Publisher: release.yml on ChuMicro/ChuMicro

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: chumicro_config_experimental-0.7.7.tar.gz
- Subject digest: e17f10dde6237e3b01ab387f66fdbaf35d2ce1ab89de2e7dcccae6cec6e3309c
- Sigstore transparency entry: 2502848162
- Sigstore integration time: Aug 18, 2026
Source repository:
- Permalink: ChuMicro/ChuMicro@9f28b5d2e2da3c8df5f39268fedb5be98f6af723
- Branch / Tag: refs/heads/main
- Owner: https://github.com/ChuMicro
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yml@9f28b5d2e2da3c8df5f39268fedb5be98f6af723
- Trigger Event: push