https://github.com/wsargent/toodledo

Ruby library (including command line client) for interacting with toodledo.com USES DEPRECATED V1 API
https://github.com/wsargent/toodledo

Last synced: about 1 month ago
JSON representation

Ruby library (including command line client) for interacting with toodledo.com USES DEPRECATED V1 API

• Host: GitHub
• URL: https://github.com/wsargent/toodledo
• Owner: wsargent
• Created: 2009-04-20T20:16:04.000Z (over 16 years ago)
• Default Branch: master
• Last Pushed: 2018-09-13T19:24:17.000Z (about 7 years ago)
• Last Synced: 2025-08-24T20:47:17.482Z (3 months ago)
• Language: Ruby
• Homepage: http://rubygems.org/gems/toodledo
• Size: 258 KB
• Stars: 59
• Watchers: 10
• Forks: 23
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: History.txt

Awesome Lists containing this project

README

          
# toodledo

* https://github.com/wsargent/toodledo

* will.sargent@gmail.com

## DESCRIPTION

This is a Ruby API and client for http://toodledo.com, a task management 

website. It implements all of the calls from Toodledo's developer API, and 

provides a nice wrapper around the functionality.

The client allows you to work with Toodledo from the command line. It will

work in either interactive or command line mode.

You can also use the client in your shell scripts, or use the API directly

as part of a web application.  Custom private RSS feed?  Want to have the Mac 

read out your top priority?  Input tasks through Quicksilver?  Print out

tasks with a BetaBrite?  It can all happen.

## FEATURES/PROBLEMS

* Command line client interface

* Interactive client interface

* Fully featured session based API

* Supports Proxy and SSL usage

* Easy configuration and automation (Quicksilver / Scripts / Automator)

## SYNOPSIS

### SETUP

You will need an account on Toodledo.  Once you have that and you're logged in, go to:

    http://www.toodledo.com/info/api_doc.php

and retrieve your userid.  You will need this for setup.

Then, type

    gem install toodledo

    toodledo setup

and enter your userid and password in the spaces provided.  Then save the file, and you're good to go.

### COMMAND LINE

 

You can add tasks.  The simplest form is here:

    toodledo add 'This is a test'

  

But tasks don't have to be simple.  Toodledo has a particularly rich model of 

a task, and allows full GTD type state to be attached to them.  The syntax 

for the client is as follows:

    *Folder

    @Context

    ^Goal

    !Priority

    #DueDate

    %Tags

Additionally, a * _not_ followed immediately by a folder name

indicates that the task should be starred.

For adding tasks, you may specify Priority as either a word:

top,high,medium,low,negative  or as a number: -1,0,1,2,3

You can encase the symbol with square brackets if there is a space involved:

    *[Blue Sky]

    @[Someday / Maybe]

    ^[Write Toodledo Ruby API]

    !top

    #[2011-03-18] or #[today]

    %[foo bar]

You can only provide one folder, context, goal, priority, or date, but you can

provide multiple tags, using the syntax shown above (i.e. foo and bar are two 

separate tags).

  

Let's use the command line client to list only the tasks you have in the office:

    toodledo tasks '@Office *Action'

Now let's add a task with several symbols:

    toodledo add '*Action @Programming ^[Write Toodledo Ruby API] Write docs'

Now let's add a different task with a date and tags:

    toodledo add Write more docs #today %for_my_boss

You can also edit tasks, using the task id.  This sets the folder to Someday:

    toodledo edit '*Someday 15934131'

And finally you can complete or delete tasks, again using the task id.

    toodledo complete 15934131

    toodledo delete 15934131

### INTERACTIVE MODE

Toodledo also comes with an interactive mode that is used if no arguments are 

found:

    toodledo

    > add This is a test

You can type 'help' at the prompt for a complete list of commands.  The client

makes for a nice way to enter in tasks as you think of them.

The client will also allow you to set up filters.  Filters are added with

the symbols, so in interactive mode

    filter @Office *Action

    tasks

Then it produces the same results as:

    toodledo tasks '@Office *Action'

Finally, if you want to write your own scripts, working with Toodledo is very

simple, since it will use the YAML config file:

    require 'rubygems'

    require 'toodledo'

    Toodledo.begin do |session|

      # work with session

    end

If you want to work with the session directly, then you should do

this instead:

    require 'rubygems'

    require 'toodledo'

    session = Session.new(userid, password)

    session.connect()

## REQUIREMENTS

* A connection to the Internet

* An account to http://toodledo.com

* Your Toodledo userid (see http://www.toodledo.com/info/api_doc.php)

* cmdparse

* highline

* rubygems

## INSTALL

* sudo gem install toodledo

* toodledo setup (sets up the YAML file with your credentials)

* toodledo

## TROUBLESHOOTING

* `The server returned a fatal error: invalid userid` - Verify you are using the **unique user id** from https://www.toodledo.com/info/api_doc.php (it seems to always start with `td`). This is different than your account's alias or password. 

* `The server returned a fatal error: key did not validate` - Verify you are using the correct user id and password.

## LICENSE:

		   GPL v3