Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Simple command-line task report builder + project management tool

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 bin
Octocat-spinner-32 data
Octocat-spinner-32 lib
Octocat-spinner-32 test
Octocat-spinner-32 .gitignore
Octocat-spinner-32 .travis.yml
Octocat-spinner-32 GUIDE.md
Octocat-spinner-32 Gemfile
Octocat-spinner-32 HISTORY.md
Octocat-spinner-32 Notes.md
Octocat-spinner-32 README.md
Octocat-spinner-32 Rakefile
Octocat-spinner-32 tasks.taskpaper
Octocat-spinner-32 tps_reporter.gemspec
README.md

Task progress sheet reporter

TPS report

We often need to make regular reports of things done for our projects at work. I hate doing these by hand. This tool lets us build these reports from TaskPaper files such as this:

Version 1:

    This file is in TaskPaper format.
    Tabs are used to indent.
    Each task begins with a "- ".
    Projects end with a ":".
    Tags are in the format "@tag_name".
    All other lines (such as these) are considered as notes,
    and are to be ignored.

    - User signup
        - Register for an account
        - Log in @done
        - Forget password

    - Manage users
        - Create users @in_progress
        - Delete users
        - User profile page @40%

    - Blog
        - Creating new posts @done
        - Comments @done
        - Moderating comments @done

Requires Ruby 1.9+. No, 1.8.7 will not work.

Get started

Install TPS (Ruby):

$ gem install tps_reporter

...then generate a sample file. (or create tasks.taskpaper based on this sample file.)

$ tps sample

Edit it, then generate the report:

$ tps open

Format

The tasks file, usually tasks.taskpaper, is in TaskPaper format.

They're simply a hierarchy of projects and tasks.

Edit users:
  - Register and signup
  - Login and logout

You can tag some projects or tasks.

Facebook connect:
  - Register via Facebook @done
  - Capture email

Manage employees: @done
  - Create user
  - Edit user

The following tags are recognized:

  • @done
  • @in_progress
  • @pt/2839478 (Pivotal tracker ID. Links to a Pivotal tracker story.)
  • @tr/LabxGP3 (Trello card short name. Links to a Trello card.)
  • @0pt (points; influences percentage. needs to end in pt or pts.)
  • @10% (task progress. implies in progress.)

Example:

Employee management:
  - Creating employees @40%
  - Editing employees @done @2pts

Exporting to PDF or image

If you're on a Mac, install Paparazzi and use the tps paparazzi command. This will open the report in Paparazzi where you can save or copy it as an image, or PDF.

Command line

There's also a command line reporter that you can access via tps print. It looks like this:

Comamnd line reporter

Sprints

You can define sprints to help you see the workload of each sprint. First, define your sprints on top of your file like so (this is a TaskPaper project with notes):

Sprints:
  s1: Sprint 1 (May 1)
  s2: Sprint 2 (May 8)
  s3: Sprint 3 (May 15)

The names are all arbitrary; s1..s3 is just used here for convention; feel free to use any string you like. (say, week1..week7 works well for some projects.)

Then use the names as tags (in this case, @s1, @s2):

Blog:
  - Writing articles @s1
  - Publishing @s2

Old YAML syntax

The old (v0.3.0) YAML syntax is still supported, see the v0.3.0 readme for more info.

License

© 2013, Rico Sta. Cruz. Released under the MIT License.

My site (ricostacruz.com) - Twitter (@rstacruz)

Something went wrong with that request. Please try again.