Metadata-Version: 2.1
Name: userconf
Version: 0.1.0
Summary: Python library to manage application user settings
Home-page: https://github.com/jajimenez/userconf
Author: Jose A. Jimenez
Author-email: jajimenezcarm@gmail.com
License: UNKNOWN
Description: # UserConf
        Python library to manage application user settings
        
        - Version: 0.1.0
        - Author: Jose A. Jimenez (jajimenezcarm@gmail.com)
        - License: MIT
        
        ### Introduction
        
        This library allows you to write and read key-value settings for a Python
        application in a JSON file inside the home directory of the user who is running
        the application.
        
        ### Usage example
        
        ```python
        import userconf as uc
        
        # Set the working application ID. The JSON file containing the settings will be
        # saved in a directory which name is the dot character "." followed by the ID
        # provided when calling the following function. This directory will be created
        # inside the user's home directory.
        uc.set_application_id("exampleapp")
        
        # Write a setting value. This is done by providing its ID and value. The value
        # can be any JSON serializable object (e.g. a string, a list, a dictionary...).
        uc.set_setting_value("setting_example", "Example value")
        
        # Read a setting value. This is done by providing its ID and an optional
        # default value that will be returned if the setting doesn't exist.
        v = uc.get_setting_value("setting_example", "Default value")
        ```
        
        ### Function list
        
        ```
        get_application_id()
        set_application_id(id)
        setting_exists(id)
        get_setting_value(id, default_value = None)
        set_setting_value(id, value)
        clear_setting(id)
        clear_all_settings()
        ```
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: MacOS :: MacOS X
Requires-Python: >=3.6
Description-Content-Type: text/markdown
