00dani/mpd-now-playable
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Add field descriptions to the config schema :)

Browse source
This commit is contained in:
Danielle McLean 2024-06-22 20:12:23 +10:00
parent 2def2aece5
commit 3cb5db7528
Signed by: 00dani
GPG key ID: 6854781A0488421C
6 changed files with 84 additions and 23 deletions
Download patch file Download diff file Expand all files Collapse all files

9
src/mpd_now_playable/config/model.py
View file

@ -11,8 +11,14 @@ __all__ = ("MpdConfig", "Config")
@dataclass(frozen=True)
class MpdConfig:
#: The password required to connect to your MPD instance, if you need one.
password: Optional[str] = optional()
#: The hostname or IP address of your MPD server. If you're running MPD
#: on your local machine, you don't need to configure this.
host: Host = Host("127.0.0.1")
#: The port on which to connect to MPD. Unless you're managing multiple MPD
#: servers on one machine for some reason, you probably haven't changed this
#: from the default port, 6600.
port: Port = Port(6600)
@ -22,5 +28,8 @@ class Config:
default=URL("https://cdn.00dani.me/m/schemata/mpd-now-playable/config-v1.json"),
metadata=alias("$schema"),
)
#: A URL describing a cache service for mpd-now-playable to use. Supported
#: protocols are memory://, redis://, and memcached://.
cache: Optional[URL] = optional()
mpd: MpdConfig = field(default_factory=MpdConfig)