ConfigInit.cli

Contents

ConfigInit.cli#

ConfigInit.cli()[source]#

Command-line interface for initialising the config directory.

Intended to be wired up as a console_scripts entry point in the consuming package:

# in mypackage/config.py
config_init = ConfigInit(package_name="mypackage", configs={...})

def init_cli():
    config_init.cli()

# in pyproject.toml
[project.scripts]
mypackage-init = "mypackage.config:init_cli"

Flags:

  • --project use the project config directory (<cwd>/.<package_name>) instead of the user home directory

  • --path PATH write to an explicit directory (mutually exclusive with --project)

  • --overwrite overwrite files that already exist

Contents