Pympress package¶
This page contains the inline documentation, generated from the code using sphinx.
The code is documented in the source using the Google style for docstrings. Sphinx has gathered a set of examples which serves as a better crash course than the full style reference.
Retructured text (rst) can be used inside the comments and docstrings.
Modules¶
pympress.util
– various utility functions¶
- pympress.util.fileopen(f)[source]¶
Call the right function to open files, based on the platform.
- Parameters:
f (path-like) – path to the file to open
- pympress.util.get_default_config()[source]¶
Returns the path to the configuration file containing the defaults.
- Returns:
The path to the portable configuration file.
- Return type:
- pympress.util.get_locale_dir()[source]¶
Returns the path to the locale directory.
- Returns:
The path to the locale directory
- Return type:
- pympress.util.get_log_path()[source]¶
Returns the appropriate path to the log file in the user app dirs.
- Returns:
path to the log file.
- Return type:
- pympress.util.get_portable_config()[source]¶
Returns the path to the configuration file for a portable install (i.e. in the install root).
- Returns:
The path to the portable configuration file.
- Return type:
- pympress.util.get_pympress_meta()[source]¶
Get metadata (version, etc) from pympress’ __init__.py or git describe.
- Returns:
metadata properties (version, contributors) mapped to their values
- Return type:
- pympress.util.get_ui_resource_file(name, ext='.glade')[source]¶
Load an UI definition file from pympress’ resources
- pympress.util.get_user_config()[source]¶
Returns the path to the configuration file in the user config directory
- Returns:
path to the user configuration file.
- Return type: