prefs 0.2

Simple but useful python library that helps you to store and manage user preferences.

What is PREFS?

PREFS is a simple but useful python library to store and manage user preferences.

How does PREFS work?

In a nutshell when you initialize PREFS class, PREFS checks if a file exists with the given filename: if it exists, read it; if doesn't, create it using prefs parameter.

Installation:

On windows: pip install PREFS

On MacOS and Linux: pip3 install PREFS

Syntax:

Each PREFS file is an instance of the PREFS class:
PREFS class has one required parameter, which is a dictionary with the default preferences, default means the preferences that all users will have at first time.

user_prefs = PREFS.PREFS(prefs = {
  "theme": "light", 
  "lang": "en", 
  "keybindings": {"Ctrl+C": "Copy", "Ctrl+V": "Paste", "Ctrl+X": "Cut"}
})

This code will create a file like this:

#PREFS
theme='light'
lang='en'
keybindings=>
  Ctrl+C='Copy'
  Ctrl+V='Paste'
  Ctrl+X='Cut'

A total human readable file that supports cascade/tree in nested dictionaries.

---

The main methods to manage the preferences are are:

• read_prefs(): Returns a dictionary reading the PREFS file.

• write_prefs(): Requires two arguments, first the name of the pref that you want to change (if pref exists) or create if it doesn't, and second argument is the value that you want to assign to the pref. If using nested dictionaries pass in key parameter the keys path separated by a forward slash, e.g.: write_prefs("keybindings/Ctr+C", "Ctrl+D")

• write_multiple_prefs(): Requires a list of prefs and a list of values to write. As it names says writes multiple prefs in a more efficient way than calling write_prefs() multiple times.

• convert_to_json(): Converts the PREFS file into a json one.

Methods outside PREFS class:

• read_json_file(): Requires a the filename of the json file to read and returns it's value.

• read_yaml_file(): Requires a the filename of the yaml file to read and returns it's value.

• read_prefs_file(): Given the filename of a PREFS file (which you can create manually) reads it and returns it's value.

Documentation

PREFS documentation can be found at https://patitotective.github.io/PREFS/ with more examples and information.

Extra info.

---

Links

• GitHub page: https://github.com/Patitotective/PREFS.

• Pypi page: https://pypi.org/project/PREFS/.

• Contact me:

  • Discord: patitotective#0127.
  • Email: [e-mail].

v0.2