added authentication to spyre

README.md

@@ -1,4 +1,4 @@
-Spyre
+Secure Spyre
 =========
 
 Spyre is a Web Application Framework for providing a simple user interface for Python data projects.
@@ -12,11 +12,11 @@ Spyre runs on the minimalist python web framework, **[cherrypy]**, with **[jinja
 Installation
 ----
 ```bash
-    $ pip install dataspyre
+    $ pip install git+https://github.com/Dana-Farber/spyre
 ```
 
 
-The Simplest of Examples
+The Simplest of Examples, with User Authentication (Login)
 ----
 Here's a very simple spyre example that shows the primary components of a spyre app
 ```python
@@ -28,7 +28,7 @@ class SimpleApp(server.App):
 		"type": "text",
 		"key": "words",
 		"label": "write words here",
-		"value": "hello world", 
+		"value": "hello world",
 		"action_id": "simple_html_output"
 	}]
 
@@ -41,8 +41,17 @@ class SimpleApp(server.App):
 		words = params["words"]
 		return "Here's what you wrote in the textbox: <b>%s</b>" % words
 
+USERS={"alice":"secret"}
+
+from cherrypy.lib import auth_digest #must import this to compute ha1 digest
+digest_auth = {'/': {'tools.auth_digest.on': True,
+               'tools.auth_digest.realm': 'wonderland',
+               'tools.auth_digest.get_ha1': auth_digest.get_ha1_dict_plain(USERS),
+               'tools.auth_digest.key': 'a565c27146791cfb',
+}}
+
 app = SimpleApp()
-app.launch()
+app.launch(config=digest_auth)
 ```
 
 The SimpleApp class inherits server.App which includes a few methods that you can override to generate outputs. In this case we want our app to display HTML (just text for now) so we'll overide the getHTML method. This method should return a string.

spyre/server.py

@@ -14,6 +14,8 @@
 from cherrypy.lib.static import serve_file
 from cherrypy.lib.static import serve_fileobj
 
+from cherrypy.lib import auth_digest
+
 try:
     import StringIO as io  # python2
 except Exception:
@@ -478,14 +480,15 @@ def getCustomHead(self):
         """
         return ""
 
-    def launch(self, host="local", port=8080, prefix='/'):
+    def launch(self, host="local", port=8080, prefix='/', config=None):
+        """launch"""
         self.prefix = prefix
         webapp = self.getRoot()
         if host != "local":
             cherrypy.server.socket_host = '0.0.0.0'
         cherrypy.server.socket_port = port
         cherrypy.tree.mount(webapp, prefix)
-        cherrypy.quickstart(webapp)
+        cherrypy.quickstart(webapp, config=config)
 
     def launch_in_notebook(self, port=9095, width=900, height=600):
         """launch the app within an iframe in ipython notebook"""