Skip to content

Commit

Permalink
added readme
Browse files Browse the repository at this point in the history
  • Loading branch information
progrium committed Aug 30, 2011
1 parent dd1e081 commit b381f1e
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 1 deletion.
42 changes: 42 additions & 0 deletions 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

2 changes: 1 addition & 1 deletion main.py
Expand Up @@ -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):
Expand Down

0 comments on commit b381f1e

Please sign in to comment.