prefs 0.1.3

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

Why?

PREFS's purpose is to facilitate the process of store and manage user preferences, simple but useful library.

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.

UserPrefs = 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.

---

The main methods to manage the preferences are are:

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

• WritePrefs(): 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.: WritePrefs("keybindings/Ctr+C", "Ctrl+D")

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

Methods outside PREFS class:

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

• GetStats(): Returns and prints the PREFS library stats using pypistats (https://pypi.org/project/pypistats/).

Documentation

PREFS documentation can be found at https://prefs-documentation.readthedocs.io/en/latest/ with more examples and information.

---

Links

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

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

• Contact me:

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