Ravel Python API Reference
A Database-Defined Network Controller
Public Member Functions | List of all members
ravel.env.Environment Class Reference

The executing environment for the Ravel CLI. More...

Inherits object.

Public Member Functions

def __init__
 
def start
 Start the environment, initialize the database and network provider.
 
def stop
 Stop the environment, including the database and network provider.
 
def mkterm
 Create a new xterm process for the specified command. More...
 
def unload_app
 Unload an application from the environment. More...
 
def load_app
 Load an application in the environment. More...
 
def discover
 Search for new applications in the list of directories specified in the constructor.
 
def pprint
 Pretty print the list of startup parameters.
 

Detailed Description

The executing environment for the Ravel CLI.

Constructor & Destructor Documentation

def ravel.env.Environment.__init__ (   self,
  db,
  provider,
  appdirs,
  params 
)
Parameters
dba ravel.db.RavelDb instance
providera ravel.network.NetworkProvider instance
appdirsa list of directories to search for applications
paramsdictionary of startup parameters, such as db name, user

Member Function Documentation

def ravel.env.Environment.load_app (   self,
  appname 
)

Load an application in the environment.

Parameters
appnamethe application to unload
def ravel.env.Environment.mkterm (   self,
  cmds,
  cmdfile = None 
)

Create a new xterm process for the specified command.

Parameters
cmdsstring containing the command(s) to pass to xterm
cmdfileif the command requires a temporary file, a path to the file, which should be deleted when the environment stops
def ravel.env.Environment.unload_app (   self,
  appname 
)

Unload an application from the environment.

Parameters
appnamethe application to load

The documentation for this class was generated from the following file: