Permalink
Browse files

added readme

  • Loading branch information...
1 parent dd1e081 commit b381f1e635a56b978b12d12982f3386f3cae4edc @progrium committed Aug 30, 2011
Showing with 43 additions and 1 deletion.
  1. +42 −0 README
  2. +1 −1 main.py
View
42 README
@@ -0,0 +1,42 @@
+Pivotal Tracker Widget
+======================
+
+Generates a page that lists stories from Pivotal Tracker based on iteration (done, current, backlog)
+or search query (label:"label name", state:unstarted, etc) intended to be embedded via iframe.
+
+Code at http://github.com/progrum/tracker-widget
+Hosted at https://tracker-widget.appspot.com
+
+Any accepted pull requests will get deployed.
+
+Pivotal Tracker Setup
+---------------------
+1) Be sure to enable API access in your project settings
+2) You should create a user that has only viewing privileges
+3) Note your project ID
+
+Widget URLs
+-----------
+
+https://tracker-widget.appspot.com/widget/iteration
+ Required query parameters:
+ username
+ password
+ project_id
+ iteration
+ values: "done", "current", "backlog"
+
+ Optional query parameter:
+ css URL of CSS to use instead of Twitter Bootstrap
+
+https://tracker-widget.appspot.com/widget/stories
+ Required query parameters:
+ username
+ password
+ project_id
+ filter
+ see: https://www.pivotaltracker.com/help#howcanasearchberefined
+
+ Optional query parameter:
+ css URL of CSS to use instead of Twitter Bootstrap
+
View
2 main.py
@@ -16,7 +16,7 @@ def stories_for_view(stories):
class MainHandler(webapp.RequestHandler):
def get(self):
- self.response.out.write('Hello world!')
+ self.response.out.write('<pre>%s</pre>' % open('README').read())
class StoryWidgetHandler(webapp.RequestHandler):
def get(self):

0 comments on commit b381f1e

Please sign in to comment.