{ } Raw JSON

bundles / astropy latest / astropy / config / paths / get_config_dir_path

function

astropy.config.paths:get_config_dir_path

source: /astropy/config/paths.py :46

Signature

def   get_config_dir_path ( rootname : str = astropy )  →  Path

Summary

Determines the package configuration directory name and creates the directory if it doesn't exist.

Extended Summary

This directory is typically $HOME/.astropy/config, but if the XDG_CONFIG_HOME environment variable is set and the $XDG_CONFIG_HOME/astropy directory exists, it will be that directory. If neither exists, the former will be created and symlinked to the latter.

Parameters

rootname : str

Name of the root configuration directory. For example, if rootname = 'pkgname', the configuration directory would be <home>/.pkgname/ rather than <home>/.astropy (depending on platform).

Returns

configdir : Path

The absolute path to the configuration directory.

Aliases

  • astropy.config.get_config_dir_path