Welcome to clack’s documentation!

command-line application configuration kit (CLACK)… A wrapper around the argparse library that aims to handle _all_ application configuration.

Table of Contents

• API Reference
  • clack package
    • Config
      • Config.config_file
      • Config.from_cli_args()
      • Config.logs
      • Config.model_computed_fields
      • Config.model_config
      • Config.model_fields
      • Config.settings_customise_sources()
      • Config.verbose
    • Parser()
    • YAMLConfigFile
      • YAMLConfigFile.extensions
      • YAMLConfigFile.get()
      • YAMLConfigFile.new()
      • YAMLConfigFile.set()
      • YAMLConfigFile.to_dict()
    • clack_envvars_set()
    • comma_list_or_file
      • comma_list_or_file.help()
      • comma_list_or_file.parse()
    • filter_cli_args()
    • get_config()
    • main_factory()
    • new_command_factory()
    • register_runner_factory()
    • Submodules
      • clack.pytest_plugin module
        • MakeConfigFile
        • make_config_file_fixture()
      • clack.types module
        • ClackConfig
          • ClackConfig.dict()
          • ClackConfig.from_cli_args()
        • ClackConfigFile
          • ClackConfigFile.extensions
          • ClackConfigFile.get()
          • ClackConfigFile.new()
          • ClackConfigFile.path
          • ClackConfigFile.set()
          • ClackConfigFile.to_dict()
        • ClackMain
        • ClackNewCommand
      • clack.xdg module
        • get_base_dir()
        • get_full_dir()
        • init_full_dir()
• Changelog
  • Unreleased
  • 0.3.12 - 2024-04-05
    • Changed
  • 0.3.11 - 2024-04-04
    • Fixed
  • 0.3.10 - 2024-03-31
    • Changed
  • 0.3.9 - 2024-03-07
    • Added
  • 0.3.8 - 2024-03-07
    • Added
    • Changed
  • 0.3.7 - 2024-03-06
    • Changed
    • Miscellaneous
  • 0.3.6 - 2024-03-05
    • Fixed
  • 0.3.5 - 2024-03-05
    • Fixed
  • 0.3.4 - 2022-05-09
    • Fixed
  • 0.3.3 - 2022-05-06
    • Added
  • 0.3.2 - 2022-01-14
    • Miscellaneous
  • 0.3.1 - 2022-01-09
    • Added
    • Changed
  • 0.3.0 - 2022-01-08
    • Changed
    • Fixed
  • 0.2.9 - 2022-01-08
    • Fixed
  • 0.2.8 - 2022-01-08
    • Fixed
  • 0.2.7 - 2022-01-08
    • Miscellaneous
  • 0.2.6 - 2022-01-08
    • Added
  • 0.2.5 - 2022-01-08
    • Changed
  • 0.2.4 - 2022-01-08
    • Fixed
  • 0.2.3 - 2022-01-08
    • Added
  • 0.2.2 - 2022-01-06
    • Fixed
  • 0.2.1 - 2022-01-06
    • Fixed
  • 0.2.0 - 2022-01-04
    • Added
    • Changed
    • Miscellaneous
  • 0.1.3 - 2021-12-26
    • Added
  • 0.1.2 - 2021-12-25
    • Added
  • 0.1.1 - 2021-12-24
    • Fixed
  • 0.1.0 - 2021-12-23
    • Miscellaneous
• Development Guide
  • How to submit feedback?
  • Developer’s Guide
    • Basic Usage 🔢
    • How do I … ❓
    • Badges 📛
  • New Releases
• README
  • Installation 🗹
  • Useful Links 🔗

Indices and Tables

• Index

• Module Index