Skip to content

Configuration

user21172121683 edited this page Aug 31, 2025 · 1 revision

The config.yaml file contains a General section and individual sections for each module. Settings in the General section apply to all modules by default, but can be overridden in each module’s own section.

General:
  dry_run: true
  main_dir: flac
  username: myusername
  console_level: INFO
  file_level: DEBUG

Rymporter:
  collection_html_file: collection.html
  auto_skip: true
  field_definitions:
    album_id: RYM_ALBUMID
  fields_to_modify:
    RYM_ALBUMID: true

You can override any value in config.yaml directly from the command line using the --override argument after any modules when running main.py. Supports automatic type conversion for strings, numbers, booleans, lists, and dictionaries where valid Python literals are provided. This means that if your strings include spaces or special shell characters, you should wrap them in quotes to ensure they are parsed correctly by the shell and the application.

--override Section.key.subkey=value
  • Section is the section in your config file (e.g., General or any module name).
  • key.subkey represents nested keys within that section.
  • value is the new value you want to apply.

Example:

python main.py rymporter flagger --override General.dry_run=true Rymporter.field_definitions.album_id=RYM_ALBUMID Flagger.tags_to_check=['GENRE','RYM_ALBUMID']

Global configurable parameters:

  • dry_run: If true, simulates changes without modifying files.
  • main_dir: The root directory of your main FLAC collection.
  • username: Your RateYourMusic and MusicBrainz username (if the same).
  • console_level: Log level for terminal output. Options: DEBUG, INFO, WARNING, ERROR, CRITICAL.
  • file_level: Log level for .log files (same options as above).
Clone this wiki locally