cumulusci.core.keychain package

Submodules

class cumulusci.core.keychain.BaseEncryptedProjectKeychain.BaseEncryptedProjectKeychain(project_config, key)[source]

Bases: cumulusci.core.keychain.BaseProjectKeychain.BaseProjectKeychain

Base class for building project keychains that use AES encryption for securing stored org credentials

encrypted = True
cumulusci.core.keychain.BaseEncryptedProjectKeychain.pad(s)[source]
class cumulusci.core.keychain.BaseProjectKeychain.BaseProjectKeychain(project_config, key)[source]

Bases: cumulusci.core.config.BaseConfig.BaseConfig

change_key(key)[source]

re-encrypt stored services and orgs with the new key

create_scratch_org(org_name, config_name, days=None, set_password=True)[source]

Adds/Updates a scratch org config to the keychain from a named config

encrypted = False
get_connected_app()[source]

retrieve the connected app configuration

get_default_org()[source]

retrieve the name and configuration of the default org

get_org(name)[source]

retrieve an org configuration by name key

get_service(name)[source]

Retrieve a stored ServiceConfig from the keychain or exception

Parameters:name (str) – the service name to retrieve

:rtype ServiceConfig :return the configured Service

list_orgs()[source]

list the orgs configured in the keychain

list_services()[source]

list the services configured in the keychain

remove_org(name, global_org=None)[source]
set_default_org(name)[source]

set the default org for tasks by name key

set_org(org_config, global_org=False)[source]
set_service(name, service_config, project=False)[source]

Store a ServiceConfig in the keychain

unset_default_org()[source]

unset the default orgs for tasks

class cumulusci.core.keychain.EncryptedFileProjectKeychain.EncryptedFileProjectKeychain(project_config, key)[source]

Bases: cumulusci.core.keychain.BaseEncryptedProjectKeychain.BaseEncryptedProjectKeychain

An encrypted project keychain that stores in the project’s local directory

config_local_dir
project_local_dir
class cumulusci.core.keychain.EnvironmentProjectKeychain.EnvironmentProjectKeychain(project_config, key)[source]

Bases: cumulusci.core.keychain.BaseProjectKeychain.BaseProjectKeychain

A project keychain that stores org credentials in environment variables

app_var = 'CUMULUSCI_CONNECTED_APP'
encrypted = False
org_var_prefix = 'CUMULUSCI_ORG_'
service_var_prefix = 'CUMULUSCI_SERVICE_'

Module contents