Skip to content

Commit

Permalink
docs and version #
Browse files Browse the repository at this point in the history
  • Loading branch information
Jonathan Tushman committed Sep 19, 2013
1 parent ad7ff08 commit 55a198c
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 30 deletions.
25 changes: 9 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,17 +34,17 @@ changelog
---------------
List out projects stories that are delivered or finished (not accepted)

show_stories
show stories
---------------
Lists all stories for a given project (will prompt you if not specified)
Can filter by user with the `for` option
By default show the top 20 stories, can specify more (or less) with the _number_ option

show_story
show story
---------------
Show the details for a given story. passing the project-index parameter will make it faster

browser_open
open
---------------
Will open the given story in a browser. passing the project-index parameter will make it faster

Expand All @@ -60,27 +60,20 @@ create (feature|bug|chore)
---------------
Create a story

(start|finish|deliver|accept|reject) story
------------------------------------------
Change the state of a story


```
Usage:
pivotal_tools changelog [--project-index=<pi>]
pivotal_tools show_stories [--project-index=<pi>] [--for=<user_name>] [--number=<number_of_stories>]
pivotal_tools show_story <story_id> [--project-index=<pi>]
pivotal_tools browser_open <story_id> [--project-index=<pi>]
pivotal_tools scrum [--project-index=<pi>]
pivotal_tools poker [--project-index=<pi>]
pivotal_tools planning [--project-index=<pi>]
pivotal_tools create (feature|bug|chore) <title> [<description>] [--project-index=<pi>]
pivotal_tools (start|finish|deliver|accept|reject) story <story_id> [--project-index=<pi>]
pivotal_tools show stories [--project-index=<pi>] [--for=<user_name>] [--number=<number_of_stories>]
pivotal_tools show story <story_id> [--project-index=<pi>]
pivotal_tools open <story_id> [--project-index=<pi>]
pivotal_tools changelog [--project-index=<pi>]
pivotal_tools scrum [--project-index=<pi>]
pivotal_tools (planning|poker) [--project-index=<pi>]

Options:
-h --help Show this screen.
--for=<user_name> Username, or initials
--project-index=<pi> If you have multiple projects, this is the index that the project shows up in my prompt
This is useful if you do not want to be prompted, and then you can pipe the output
```

20 changes: 10 additions & 10 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
pivotal_tools v0.13
pivotal_tools v0.14
===================

pivotal_tools is a geeky command-line interface with additional scrum, planning
Expand Down Expand Up @@ -47,7 +47,7 @@ changelog

List out projects stories that are delivered or finished (not accepted)

show_stories
show stories
^^^^^^^^^^^^

Lists all stories for a given project (will prompt you if not specified).
Expand All @@ -58,21 +58,21 @@ Lists all stories for a given project (will prompt you if not specified).
:option:`--number`
Number of stories to show. Defaults to 20.

show_story <story_id>
show story <story_id>
^^^^^^^^^^^^^^^^^^^^^

::

pivotal_tools show_story <story_id>
pivotal_tools show story <story_id>

Show the details for a given story.

browser_open <story_id>
^^^^^^^^^^^^^^^^^^^^^^^
open <story_id>
^^^^^^^^^^^^^^^

::

pivotal_tools browser_open <story_id>
pivotal_tools open <story_id>

Will open the given story in a browser.

Expand Down Expand Up @@ -124,9 +124,9 @@ Change the state of a story.

Usage:
pivotal_tools changelog [--project-index=<pi>]
pivotal_tools show_stories [--project-index=<pi>] [--for=<user_name>] [--number=<number_of_stories>]
pivotal_tools show_story <story_id> [--project-index=<pi>]
pivotal_tools browser_open <story_id> [--project-index=<pi>]
pivotal_tools show stories [--project-index=<pi>] [--for=<user_name>] [--number=<number_of_stories>]
pivotal_tools show story <story_id> [--project-index=<pi>]
pivotal_tools open <story_id> [--project-index=<pi>]
pivotal_tools scrum [--project-index=<pi>]
pivotal_tools poker [--project-index=<pi>]
pivotal_tools planning [--project-index=<pi>]
Expand Down
6 changes: 3 additions & 3 deletions pivotal_tools/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,17 @@
---------------
List out projects stories that are delivered or finished (not accepted)
show_stories
show stories
---------------
Lists all stories for a given project (will prompt you if not specified)
Can filter by user with the `for` option
By default show the top 20 stories, can specify more (or less) with the _number_ option
show_story
show story
---------------
Show the details for a given story. passing the project-index parameter will make it faster
browser_open
open
---------------
Will open the given story in a browser. passing the project-index parameter will make it faster
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
from setuptools import setup

setup(name='pivotal_tools',
version='0.13',
version='0.14',
description='Collection of pivotal command line tools',
url='http://github.com/jtushman/pivotal_tools',
author='Jonathan Tushman',
Expand Down

0 comments on commit 55a198c

Please sign in to comment.