README.markdown

pyAgileTaskAPI

A python wrapper for the AgileTask API

API

• http://doc.agiletask.me/get_tasks.html
  • .GetAll()
• http://doc.agiletask.me/get_today.html
  • .GetToday()
• http://doc.agiletask.me/get_icebox.html
  • .GetIcebox()
• http://doc.agiletask.me/get_single.html
  • .GetSingle( <Task ID> )
• http://doc.agiletask.me/get_completed.html
  • .GetCompleted()
• http://doc.agiletask.me/get_achievements.html
  • .GetRecentAchievements()
• http://doc.agiletask.me/get_new_achievements.html
  • .GetAllAchievements()
• http://doc.agiletask.me/new_tasks.html
  • .AddTask( <name>, icebox = 'true|false', <position>, complete = 'true|false' )
• http://doc.agiletask.me/delete_tasks.html
  • .DeleteTask( <Task ID> )
• http://doc.agiletask.me/update_tasks.html
  • .UpdateTask( <Task ID>[, <name> [, <icebox>[<position>[, <complete>]]]], task = <Task Object> )
    • Note: You have to provide either the task object or some combination of name, icebox, position and complete
    • Note: <Task Object> is a python dictionary representation of a simple task.
      { 'task' : { 'name' : <name>, 'icebox' : <icebox>, 'position' : <position>, 'complete' : <complete> } }

ToDo

• .MoveTaskToIcebox( <Task ID> )
• .MoveTaskToToday( <Task ID> )
• .CompleteTask( <Task ID> )

Examples

Initialize the API

from AgileTaskAPI import AgileTaskAPI

patapi = AgileTaskAPI( '<Your Agile Task API Key>' )

Print Today's Tasks

for task in patapi.GetToday():
	print task['task']['name']

Add New Task to Top of Today's Tasks

newTask = patapi.AddTask( 'Super cool awesome task text goes here!', icebox = 'false' )

Update added task's name and move it to the icebox

newTask['task']['name'] = "Cool task #tyghe is #awesome"
newTask['task']['icebox'] = 'true'
oldTask = patapi.UpdateTask( newTask['task']['id'], task = newTask )

You can also make an entirely new task with changed values like this

updatedTaskDef = { 'task' : { 'name' : "Cool task #tyghe is #awesome", 'icebox' : 'false', 'complete' : 'false', 'position' : 0 } }
oldTask = patapi.UpdateTask( newTask['task']['id'], task = updatedTaskDef )

Note: that you have to provide all 4 task keys if you make a task from scratch and update that way

Delete a task

deletedTask = patapi.DeleteTask( oldTask['task']['id'] )

Tips

Python Path

You can add the path to pyAgileTaskAPI like this before you import the module

import sys
sys.path.append( '<Path to pyAgileTaskAPI folder>' )