flexiznam.config package

Module contents

flexiznam.config.config_tools module

flexiznam.config.config_tools.add_password(app, username, password, password_file=None)

Add a password to a new or existing password file

flexiznam.config.config_tools.create_config(overwrite=False, config_folder=None, template=None, skip_checks=False, config_file='config.yml', **kwargs)

Create a config file based on a template

If no template is provided, use ./config/default_config.py to generate a new config file

**kwargs elements are used to update/supplement info found in the template

flexiznam.config.config_tools.get_password(username, app, password_file=None)

Read the password yaml

flexiznam.config.config_tools.load_param(param_folder=None, config_file='config.yml')

Read parameter file from config folder

flexiznam.config.config_tools.update_config(param_file=None, config_folder=None, skip_checks=False, **kwargs)

Update the current configuration

You can give any keyword arguments. For nested levels, provide a dictionary (of dictionaries). For instance: update_config(project_ids=dict(my_project=’its_id’))

will add the new project into the project_ids dictionary without removing existing projects.

If you want to replace a nested field by a flat structure, use the skip_checks=True flag

flexiznam.config.default_config module

This file is used to generate the initial config file