zim.config

Module	`basedirs`	This module defines the search path for zim config files following the freedesktop.org (XDG) Base Dir specification.
Module	`dicts`	This module contains base classes to map config files to dicts
Module	`manager`	No module docstring; 0/2 variable, 0/2 function, 6/6 classes documented

From __init__.py:

Function	`data_dir`	No summary
Function	`data_dirs`	No summary
Function	`data_file`	No summary
Function	`user_dirs`	No summary
Variable	`logger`	Undocumented

logger = (source)

Undocumented

def data_dirs(path=None, include_non_existing=False): (source)

Generator listing paths that contain zim data files in the order that they should be searched. These will be the equivalent of e.g. "~/.local/share/zim", "/usr/share/zim", etc.

Parameters
path	a file path relative to to the data dir, including this will list sub-folders with this relative path.
include_non_existing	if `False` only existing folders are returned
Returns
yields `LocalFolder` objects for the data dirs

def data_dir(path): (source)

Get an data dir sub-folder. Will look up path relative to all data dirs and return the first one that exists. Use this function to find any folders from the "data/" folder in the source package.

Parameters
path	a file path relative to to the data dir
Returns
a `Dir` object or `None`

def data_file(path): (source)

Get a data file. Will look up path relative to all data dirs and return the first one that exists. Use this function to find any files from the "data/" folder in the source package.

Parameters
path	a file path relative to to the data dir (e.g. "zim.png")
Returns
a `File` object or `None`

def user_dirs(): (source)

Get the XDG user dirs.

Returns
a dict with directories for the XDG user dirs. These are typically defined in "~/.config/user-dirs.dirs". Common user dirs are: "XDG_DESKTOP_DIR", "XDG_DOWNLOAD_DIR", etc. If no definition is found an empty dict will be returned.