{ } Raw JSON

bundles / astropy latest / astropy / config / configuration / create_config_file

function

astropy.config.configuration:create_config_file

source: /astropy/config/configuration.py :767

Signature

def   create_config_file ( pkg rootname = astropy overwrite = False )

Summary

Create the default configuration file for the specified package. If the file already exists, it is updated only if it has not been modified. Otherwise the overwrite flag is needed to overwrite it.

Parameters

pkg : str

The package to be updated.

rootname : str

Name of the root configuration directory.

overwrite : bool

Force updating the file if it already exists.

Returns

updated : bool

If the profile was updated, True, otherwise False.

Aliases

  • astropy.config.create_config_file