scr package¶
Subpackages¶
Submodules¶
scr.brotherw module¶
scr.congregationw module¶
scr.database module¶
scr.databasew module¶
scr.mainw module¶
scr.outlinew module¶
scr.tchelper module¶
scr.tchelperlib module¶
-
class
scr.tchelperlib.Brother(id, first, middle, last, phone1, congregation, responsibility, speaker, chairman, coordinator, phone2=None, note=None, visibility=True)¶ Bases:
objectBrother class that defines a person.
-
setFirstName(firstName)¶ Sets or changes the first name of the brother
- Parameters
firstName (str) – The first name of the brother to be set or changed
-
setFullName(first, middle, last)¶ Sets/change the name of the brother
- Parameters
first (str) – The first name of the brother to be set or changed
middle (str) – The optinal middle name of the brother to be set or changed
last (str) – The last name of the brother to be set or changed
-
setLastName(lastName)¶ Sets or changes the last name of the brother
- Parameters
lastName (str) – The last name of the brother to be set or changed
-
setMiddleName(middleName)¶ Sets or changes the middle name of the brother
- Parameters
middleName (str) – The middle name of the brother to be set or changed
-
scr.yam module¶
YAML wrapper for tcHelper
-
scr.yam.get_value(key)¶ Returns the value for the key
- Parameters
key – The _key_ to be returned
- Returns
The _value_ of the key passed in
-
scr.yam.open_config_file()¶ Reads the configuration file _config.yaml
- Returns
The configuration file _config.yaml_
- Return type
str
-
scr.yam.set_value(key, value)¶ Sets a key value
Takes the key and value and saves it to the default configuration file.
- Parameters
key – The _key_ to the value that is to be set.
value – The _value_ that is to be set.
- Variables
config – The content of the configuration file.
-
scr.yam.write_yaml(config)¶ Writes to the configuration file _config.yaml
Writes to the configuration file passed in and returns true when the file is written.
- Parameters
config – The configuration to be written
- Returns
True
- Return type
bool