Skip to content
agateau edited this page Sep 14, 2010 · 12 revisions

Welcome to the Yokadi wiki!

Introduction

The Yokadi Concept

Yokadi is a todo list tool. It helps you organize all the things you have to do and you must not forget. Yokadi is a command line tool. It works in terminal or shell. It aims to be simple, intuitive and very efficient.
In Yokadi you manage projects, which contains tasks. At the minimum, a task has a title, but it can also have a description, a due date, an urgency or keywords. Keywords can be any word that help you to find and sort your tasks.

How it works

Yokadi is written in Python and stores your tasks in an sqlite database. An sqlite database is a single file that you can copy and move easily (by mail, or usb key for example).

Yokadi Installation

Prerequisite

  • Unix or Linux system. MacOSX should work but have not been tested. Sorry, Windows is not supported for the moment.
  • Python 2.4 or higher
  • Sqlite module (included in Python since 2.5 release)
  • SQLObject 0.9 or 0.10

Getting Yokadi

Yokadi has not been released yet, but it is fully usable. Get the source with Git :

git clone git://github.com/agateau/yokadi.git

Install Yokadi

You can put the Yokadi directory where you want. This will not affect Yokadi. You don’t need write access to Yokadi directory.
If you want to make Yokadi available for all system users, put it in a place where everyone can read (/usr/local/yokadi for example).

To start Yokadi, just launch the yokadi script. Example :

/usr/local/yokadi/yokadi

To do this easily, see the Yokadi integration section below.

Update Yokadi

Yokadi integration

Integration with your shell

(to be done)

  • explain how to create a shell alias to start yokadi
  • how to integrate yokadi in shell script

Integration with your KDE Plasma desktop

(to be done)

  • Plasmoïd

Using Yokadi

Tasks

(to be done)

Projects

(to be done)

Yokadi tips and frequently asked questions

How to organize projects in subprojects?

There is no notion of subprojects, but you can easily organize your projects through a project naming convention. For example, name the main project “foo”, first subproject “foo_bar” and new one “foo_bar2”. Now you can list tasks of all projects with “t_list foo%”.

Contribute to Yokadi

  • Use it and report bugs
  • Just say “thanks”
  • Spread Yokadi everywhere around you!
  • Contribute to user documentation
  • Develop: by squashing bugs or adding new features
Clone this wiki locally