geovista.config

Provide geovista resource configuration.

The resources dictionary defines the options used to configure the location of various geovista resources.

The following resources dictionary keys are defined:

• cache_dir - The directory used to store geovista.cache assets. The default configuration is based on the XDG Base Directory Specification i.e., ${XDG_CACHE_HOME}/geovista. Otherwise, the default is the geovista directory under platformdirs.user_cache_dir().

The resources dictionary cache_dir may be overridden at a package system or environment level by creating a siteconfig.py file in the geovista package installation root directory and defining an update_config function that updates the resources dictionary. For example:

def update_config(resources: dict[str, str]) -> None:
    resources["cache_dir"] = "/var/cache/geovista"

The user may override both the default and package level configuration by defining an update_config function within a geovistaconfig user site-packages module.

ノート

Added in version 0.1.0.

属性

GEOVISTA_DISABLE_PLOT_THEME	Environment variable to control plot theme override.
GEOVISTA_IMAGE_TESTING	Developer environment variable to control image testing render and theme.
resources	Resources configuration dictionary.

モジュール内容

geovista.config.GEOVISTA_DISABLE_PLOT_THEME: bool

Environment variable to control plot theme override.

geovista.config.GEOVISTA_IMAGE_TESTING: bool

Developer environment variable to control image testing render and theme.

geovista.config.resources: dict[str, pathlib.Path]

Resources configuration dictionary.