Metadata-Version: 2.1
Name: PREFS
Version: 0.0.65
Summary: A simple program that creates, read and write prefs
Home-page: https://github.com/Patitotective/PREFS
Author: Cristobal Riaga
Author-email: cristobalriaga@gmail.com
License: MIT
Description: <p align="center">
          <a href="https://prefs.readthedocs.io/en/latest/" target="blank">
          <img src="logo1.png" alt="PREFS Logo" /></a>
        </p>
        
        ## Why?
        **PREFS's purpose is to facilitate the process of store information, user information (that don't will lost when program ends).**
        
        ### Store Prefs:
        The main feature is store prefs, read them and also (re)write.
        It creates a .txt file where, like dictionary structure, your prefs will be stored, like this:
        ```
        firstEntry="02/05/2021"
        theme="Dark"
        username="Patitotective"
        age="21"
        ```
        
        ### Syntaxis:
        First you have to create an instance of the class PREFS:
        ```
        UserPrefs = PREFS.PREFS(prefs = {"age": 21, "username": "Patitotective"})
        ```
        from this you could call the two methods:
        
        ```ReadPrefs()```: It will return a dictionarie with your prefs (key and value).
        
        ```WritePrefs()```: It requires two arguments, first the name of the pref that you want to change (if pref exists) or create it doesn't (like a dictionarie).
        
        ## Installation:
        On windows:
        ```pip install PREFS```
        
        On Mac and Linux:
        ```pip3 install PREFS```
        
        ## Documentation
        
        PREFS documentation can be found at [prefs.readthedocs.io](https://prefs.readthedocs.io/en/latest/) with more examples and information.
        
        Change Log
        ==========
        
        0.0.1 (01/05/2021)
        -------------------
        - First Release
        
        0.0.2 (01/05/2021)
        -------------------
        - Name change
        
        0.0.3 (02/05/2021)
        -------------------
        - Added python interpreter for pref values (using ast library)
        
        0.0.4 (02/05/2021)
        -------------------
        - Now in class PREFS argument prefs you must pass a lambda: function for not execute the function always, only when file is lost.
        
        0.0.45 (02/05/2021)
        -------------------
        - Fixed error with lambda.
        
        0.0.46 (04/05/2021)
        -------------------
        - Now you can choose your prefs ender, line break is predetermined, remember don't put a character that is on your prefs because program fails.
        
        
        0.0.6 (04/05/2021)
        -------------------
        - Set max split as 1.
        
        0.0.65 (04/05/2021)
        -------------------
        - Added ChangeFilename() function and ReWritePrefs() function.
Keywords: prefs
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Education
Classifier: Operating System :: Microsoft :: Windows :: Windows 10
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
