prefs

What is PREFS?

PREFS is a Python library that facilitate the process of store and manage user preferences, simple but useful.

How does PREFS work?

In a nutshell what PREFS does is search for a PREFS file with the given name and if not found create it with the default PREFS.

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 in nested dictionaries.

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.
ReadPREFSFile(): Given the filename of a PREFS file reads it and returns it's value.

Documentation

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

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

PREFS-0.1.8.tar.gz (13.1 kB view details)

Uploaded Jul 31, 2021 Source

File details

Details for the file PREFS-0.1.8.tar.gz.

File metadata

Download URL: PREFS-0.1.8.tar.gz
Upload date: Jul 31, 2021
Size: 13.1 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.8.10

File hashes

Hashes for PREFS-0.1.8.tar.gz
Algorithm	Hash digest
SHA256	`0050a6b794a255014aa112e93d2b9714b784b22ae88eb0d1122dfcef177de8b0`
MD5	`2a7be25ae7d44bafaa93672a2605e46d`
BLAKE2b-256	`9fd23f0c3b711201c4bf8590193395d0a748f21bbf8456250ce74e6d5726c270`