bibcat.core package#

Submodules#

bibcat.core.config module#

class bibcat.core.config.ddict(*args: Any, **kwargs: Any)[source]#

Bases: Dict[str, Any]

Create a dottable dictionary

This allows for dictionary keys to be accessed like class attributes. For example, in x = {‘a’: 1, ‘b’: 2}, one can access x[‘a’] or x.a

override init

bibcat.core.config.get_config() → ddict[source]#

Read in the bibcat configuration

Reads in the bibcat configuration from a yaml file. The default config is in etc/bibcat_config.yaml. It looks for an optional user configuration for bibcat, and merges it with the default. All user configs take precedence and override any default configs.

Returns:: the bibcat config object
Return type:: dict

bibcat.core.config.get_custom_config() → dict | None[source]#

Look up and read in any custom configuration

Looks for a user custom configuration for bibcat and reads it in if found. Looks for a “bibcat_config.yaml” file in a user environment variable directory, $BIBCAT_CONFIG_DIR, or the user’s home directory.

Returns:: the custom yaml configuration
Return type:: dict | None

bibcat.core.config.get_default_config() → ddict[source]#

Read in the bibcat default configuration

Reads in the bibcat configuration from a yaml file. The default config is in etc/bibcat_config.yaml.

Returns:: the bibcat config object
Return type:: dict

bibcat.core.config.read_yaml(filename: Path) → dict[source]#

Read a yaml configuration file

Expands any environment variables in the yaml file

Parameters:: filename (str) – the filepath to the configuration
Returns:: the yaml configuration
Return type:: dict

bibcat.core.config.tuple_constructor(loader: SafeLoader, node: SequenceNode) → tuple[source]#

bibcat.core package

Contents

bibcat.core package#

Submodules#

bibcat.core.config module#

bibcat.core.core_utils module#

bibcat.core.grammar module#

bibcat.core.keyword module#

bibcat.core.paper module#

bibcat.core.parameters module#

Module contents#