pyrax/__init__.py File Reference

Classes
class	Settings
	Holds and manages the settings for pyrax. More...
Packages
namespace	pyrax
namespace	cf_wrapper
	This module wraps swiftclient, the Python client for OpenStack / Swift, providing an object-oriented interface to the Swift object store.
Functions
def	get_environment
	Returns the name of the current environment.
def	set_environment
	Change your configuration environment.
def	list_environments
	Returns a list of all defined environments.
def	get_setting
	Returns the config setting for the specified key.
def	set_setting
	Changes the value of the specified key in the current environment, or in another environment if specified.
def	set_default_region
	Changes the default_region setting.
def	create_context
	Returns an instance of the specified identity class, or if none is specified, an instance of the current setting for 'identity_class'.
def	auth_with_token
	If you already have a valid token and either a tenant ID or name, you can call this to configure the identity and available services.
def	set_credentials
	Set the credentials directly, and then try to authenticate.
def	set_credential_file
	Read in the credentials from the supplied file path, and then try to authenticate.
def	keyring_auth
	Use the password stored within the keyring to authenticate.
def	authenticate
	Generally you will not need to call this directly; passing in your credentials via set_credentials() and set_credential_file() will call authenticate() on the identity object by default.
def	plug_hole_in_swiftclient_auth
	This is necessary because swiftclient has an issue when a token expires and it needs to re-authenticate against Rackspace auth.
def	clear_credentials
	De-authenticate by clearing all the names back to None.
def	connect_to_services
	Establishes authenticated connections to the various cloud APIs.
def	connect_to_cloudservers
	Creates a client for working with cloud servers.
def	connect_to_cloudfiles
	Creates a client for working with cloud files.
def	connect_to_cloud_databases
	Creates a client for working with cloud databases.
def	connect_to_cloud_loadbalancers
	Creates a client for working with cloud loadbalancers.
def	connect_to_cloud_blockstorage
	Creates a client for working with cloud blockstorage.
def	connect_to_cloud_dns
	Creates a client for working with cloud dns.
def	connect_to_cloud_networks
	Creates a client for working with cloud networks.
def	connect_to_cloud_monitoring
	Creates a client for working with cloud monitoring.
def	connect_to_autoscale
	Creates a client for working with AutoScale.
def	connect_to_images
	Creates a client for working with Images.
def	connect_to_queues
	Creates a client for working with Queues.
def	client_class_for_service
	Returns the client class registered for the given service, or None if there is no such service, or if no class has been registered.
def	get_http_debug
def	set_http_debug
def	get_encoding
	Returns the unicode encoding type.
Variables
	keyring = None
tuple	callstack = inspect.stack()
	in_setup = False
	cloudservers = None
	cloudfiles = None
	cloud_loadbalancers = None
	cloud_databases = None
	cloud_blockstorage = None
	cloud_dns = None
	cloud_networks = None
	cloud_monitoring = None
	autoscale = None
	images = None
	queues = None
	default_region = None
string	default_encoding = "utf-8"
dictionary	settings = {}
string	_environment = "default"
	identity = None
string	USER_AGENT = "pyrax/%s"
	_http_debug = False
tuple	regions = tuple()
tuple	services = tuple()
dictionary	_client_classes
tuple	config_file = os.path.join(os.path.expanduser("~"), ".pyrax.cfg")
tuple	debug = get_setting("http_debug")
tuple	_logger = logging.getLogger("pyrax")