Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Ruby library & command line tool for accessing the backend of the Mac GTD app Things.

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 bin
Octocat-spinner-32 lib
Octocat-spinner-32 test
Octocat-spinner-32 .gitignore
Octocat-spinner-32 CHANGELOG
Octocat-spinner-32 Gemfile
Octocat-spinner-32 Gemfile.lock
Octocat-spinner-32 LICENSE
Octocat-spinner-32 README.markdown
Octocat-spinner-32 Rakefile
Octocat-spinner-32 VERSION
Octocat-spinner-32 things-rb.gemspec
README.markdown

things-rb

things-rb is a Ruby library and a command line tool for accessing the backend of the GTD app Things.app

Why?

There are many reasons why you would use a command line version of Things, including:

GeekTools

  • Keep a list of your ToDos on the desktop using an app like GeekTool
  • Access your ToDos remotely by SSH:ing into your machine (even from a Windows or Linux box)
  • You don't need to have Things.app running all the time
  • You like the Terminal and command line

Install

$ sudo gem install things-rb

If you're on default Mac OS X Leopard and haven't upgraded your RubyGem installation you'll need to to this first:

$ sudo gem update --system

When the upgrade is done, just run the gem install ... command above and you're set.

If you had an old version of things-rb installed (when the gem was still hosted on GitHub and not Rubygems.org) you'll need to remove the old version first:

$ sudo gem uninstall haraldmartin-things-rb

Usage

things-rb can be used either as a Ruby library or with the included command line tool.

Ruby Library

Example usage:

things = Things.new # will use Things' default database location. 
# things = Things.new(:database => '/path/to/Database.xml')

tasks = things.today.map do |task|
  tags    = "(#{task.tags.join(' ')})" if task.tags?
  project = "[#{task.parent}]" if task.parent?
  [task.bullet, task.title, tags, project].compact.join(" ")
end

puts tasks.compact.sort.join("\n")

Command Line Use

$ things
$ things --help

Shows all the options available.

The most common use I assume would be:

$ things today

which lists all tasks in "Today" which are not already completed.

If you like to show completed and canceled tasks, just pass the --all option

$ things --all today

Be default, things-rb will use the default location of the Things' database but if you keep it somewhere else you can set a custom path using the -d or --database switch

$ things --database /path/to/Database.xml

Replace today with other focus to list the task

$ things --all next
$ things logbook

To just show tasks with a specific tag, use the -t or --tag option

$ things -t errands today

Testing

To view the test document (test/fixtures/Database.xml) in Things, just launch Things with ⌥ (option/alt) down and click "Choose Library" and point it to things-rb/test/fixtures. Be sure to disable automatic logging of completed tasks in the Things.app preferences so they won't be moved around in the document.

To play nice with other package managers than Rubygems, the command line tool (bin/things) and the tests test/test_helper.rb don't require 'rubygems' before require 'hpricot'. So if hpricot isn't in your path you need to run the tests slightly different.

RUBYOPT=rubygems rake works for me to load hpricot and the other required gems, but still test the local things version (i.e. not the gem).

Run the local command line tool using ruby -r rubygems -I lib bin/things.

Of course you can just add the require statements in your code in development without committing them.

TODO

  • Support "Projects" focus
  • Optimize test and XML queries
  • Organize the classes, make internal methods private

Credits and license

By Martin Ström under the MIT license:

Copyright (c) 2009-2010 Martin Ström

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Something went wrong with that request. Please try again.