upref’s documentation¶

upref 🐸¶

Upref is a small python module to grab and save some user data like login, password, url (mainly string data). After some projects, I want a simple method to find the right login and url from the user and save it in the personnal data of the user.

Installation¶

Installing upref with pip:

$ pip install upref

Basic Usage¶

Here is the first example. The code fetch the URL from the user parameter

import upref

user_data = upref.get_pref(
    {"url": {"label": "The application url"}},
    "example01")

print("URL is {}".format(user_data['url']))

This code create a file in the user folder. And this file will be read again during the next run.

url:
  label: The application url
  value: http://www.test.org/

Code example¶

import upref
data = upref.get_pref(
    {
        'login': {'label': "Your login"},
        'passwd': {'label': "Your secret password",
                'type': "Password"},
    },
    name="example02")
print("Your login is %s" % data['login'])
print("Your password (not so secret) is %s" % data['passwd'])

At the first execution, there is a window to grab the data. The second execution, there will be no windows, the data are only read from the file.

All data are saved in a yaml file at %APPDATA%/.upref/example02.conf or ~/.local/share/.upref/example02.conf.

login:
  label: Your login
  value: My login
passwd:
  label: Your secret password
  value: Password

Features¶

Read and save small amount of data (url, login, )
Small gui to ask data from the user
Text option is avaible

License¶

The upref is licensed under the terms of the MIT license and is available for free.

MIT © Florent

MIT License¶

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Examples¶

Easy first Examples¶

Read the interesting URL from the user. At the second run, nothing is asked to the user.

import upref

user_data = upref.get_pref(
    {"url": {"label": "The application url"}},
    "example01")

print("URL is {}".format(user_data['url']))

Here is the created file. The is located in the user folder.

example01.conf¶

url:
  label: The application url
  value: http://www.test.org/

Library API¶

Class Hierarchy¶

- Namespace upref
  - Namespace upref::gui
    - Class PrefDialog

File Hierarchy¶

- Directory upref
  - File __init__.py
  - File core.py
  - File gui.py
  - File tty.py
  - File version.py

Full API¶

Namespaces¶

Namespace upref¶

Contents

Detailed Description
Namespaces
Variables

Detailed Description¶

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. Small tool to grab data from the user and to save it

Namespaces¶

Variables¶

Namespace upref::core¶

Contents

Functions
Variables

Variables¶

Namespace upref::gui¶

Contents

Classes
Functions
Variables

Classes¶

Class PrefDialog

Functions¶

Variables¶

Variable upref::gui::__all__

Namespace upref::tty¶

Contents

Functions
Variables

Functions¶

Variables¶

Variable upref::tty::__all__

Namespace upref::version¶

Contents

Variables

Variables¶

Classes and Structs¶

Class PrefDialog¶

Defined in File gui.py

Inheritance Relationships¶

Base Type¶

public Dialog

Class Documentation¶

class PrefDialog¶

Main dialog in wxPython.

Public Functions

__init__(self self, parent parent, data data)¶

init_ui(self self)¶

on_ok(self self, event event)¶

on_close(self self, event event)¶

Public Members

data_description¶

panel¶

data_widget¶

Functions¶

Function upref::core::__get_this_filename¶

Defined in File core.py

Function Documentation¶

upref.core.__get_this_filename()¶

Find the filename of this file (depend on the frozen or not) This function return the filename of this script.

The function is complex for the frozen system

Return: the filename of THIS script.

Function upref::core::__get_this_folder¶

Defined in File core.py

Function Documentation¶

upref.core.__get_this_folder()¶

Find the filename of this file (depend on the frozen or not) This function return the filename of this script.

The function is complex for the frozen system

Return: the folder of THIS script.

Function upref::core::__main¶

Defined in File core.py

Function Documentation¶

upref.core.__main()¶: Main script call only if this script is runned directly.

Function upref::core::__set_logging_system¶

Defined in File core.py

Function Documentation¶

upref.core.__set_logging_system()¶: Set up the logging system.

Function upref::core::all_values_are_set¶

Defined in File core.py

Function Documentation¶

upref.core.all_values_are_set(data_description data_description)¶: Conversion from the direct pref dict to a dict of descripiton.

Function upref::core::conv_description_to_raw¶

Defined in File core.py

Function Documentation¶

upref.core.conv_description_to_raw(data_description data_description)¶: Conversion from the direct pref dict to a dict of descripiton.

Function upref::core::conv_raw_to_description¶

Defined in File core.py

Function Documentation¶

upref.core.conv_raw_to_description(data data)¶: Conversion from the direct pref dict to a dict of descripiton.

Function upref::core::current_upref¶

Defined in File core.py

Function Documentation¶

upref.core.current_upref(name name)¶

Read the current upref of the user.

Return

the dict with the preference

Parameters

name: the name of the preference file (we add the extension .upref)

Function upref::core::default_conf¶

Defined in File core.py

Function Documentation¶

upref.core.default_conf()¶: Read a conf file and return the dict.

Function upref::core::dict_merge¶

Defined in File core.py

Function Documentation¶

upref.core.dict_merge(dct dct, merge_dct merge_dct, add_keys add_keys = True)¶

Recursive dict merge.

Inspired by :meth:dict.update(), instead of updating only top-level keys, dict_merge recurses down into dicts nested to an arbitrary depth, updating keys. The merge_dct is merged into dct.

This version will return a copy of the dictionary and leave the original arguments untouched.

The optional argument add_keys, determines whether keys which are present in merge_dict but not dct should be included in the new dict.

Code from https://gist.github.com/angstwad/bf22d1822c38a92ec0a9

Args: dct (dict) onto which the merge is executed merge_dct (dict): dct merged into dct add_keys (bool): whether to add new keys

Returns: dict: updated dict

Function upref::core::get_pref¶

Defined in File core.py

Function Documentation¶

upref.core.get_pref(data_description data_description, name name, interface interface = "gui", force_renew force_renew = False, mandatory mandatory = True)¶: Get the value of preference or setting.