supervisor_cache 0.2

supervisor_cache is an RPC extension for the supervisor module that provides the ability to cache limited amounts of data in the supervisor instance as key/value pairs.<br /><br />Installation<br /><br />Release packages are available on the Python Package Index (PyPI). You can download them from there or you can use easy_install to automatically install or upgrade:<br /><br />$ easy_install -U supervisor_cache<br /><br />Alternatively, you can download a package from GitHub in .tar.gz or .zip format. After extracting the package, use the following command to install:<br /><br />$ python setup.py install<br /><br />After installing the package, you must modify your supervisord.conf file to register the RPC interface and supervisorctl plugin:<br /><br />[rpcinterface:cache]<br />supervisor.rpcinterface_factory = supervisor_cache.rpcinterface:make_cache_rpcinterface<br /><br />[ctlplugin:cache]<br />supervisor.ctl_factory = supervisor_cache.controllerplugin:make_cache_controllerplugin<br /><br />After modifying the supervisord.conf file, both your supervisord instance and supervisorctl must be restarted for these changes to take effect.<br /><br />Usage<br /><br />The cache functions allow key/value pairs to be stored and fetched. The following Python interpreter session demonstrates the usage.<br /><br />First, a ServerProxy object must be configured. If supervisord is listening on an inet socket, ServerProxy configuration is simple:<br /><br />>>> import xmlrpclib<br />>>> s = xmlrpclib.ServerProxy('http://localhost:9001')<br /><br />If supervisord is listening on a domain socket, ServerProxy can be configured with SupervisorTransport. The URL must still be supplied and be a valid HTTP URL to appease ServerProxy, but it is superfluous.<br /><br />>>> import xmlrpclib<br />>>> from supervisor.xmlrpc import SupervisorTransport<br />>>> s = xmlrpclib.ServerProxy('http://127.0.0.1/whatever',<br />... SupervisorTransport('', '', 'unix:///path/to/supervisor.sock'))<br /><br />Once ServerProxy has been configured appropriately, we can now exercise supervisor_cache:<br /><br />>>> s.cache.getKeys()<br />[]<br />>>> s.cache.store('foo', 'bar')<br />True<br />>>> s.cache.fetch('foo')<br />'bar'<br />>>> s.cache.getKeys()<br />['foo']<br /><br />The key must be a string and cannot be zero-length. The value must also be a string but is permitted to be zero-length.<br /><br />Please consult the inline source documentation for the specifics of each command available.<br /><br />md5=a5178faeab3ba3a96114e74f12f087a8

Requirements:	No special requirements
Platforms:	*nix, Linux
Keyword:	Cache,  Command,  Configured,  Download,  Easy Install,  Import,  Install,  Instance,  Listening,  Package,  Python,  Serverproxy,  String,  Supervisor,  Supervisor Cache 0 2,  Supervisorctl,  Supervisord,  Supervisordconf,  Xmlrpclibgtgtgt
Users rating:	0/10