Filewatcher File Search File Search
Catalog
Content Search
» » » » yokadi_0.13.0.orig.tar.bz2 » Content »
pkg://yokadi_0.13.0.orig.tar.bz2:59732/yokadi-0.13.0/  info  downloads

README.markdown

# What is it?

Yokadi is a command-line oriented, SQLite powered, TODO list tool.  It helps
you organize all the things you have to do and you must not forget. 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.

# Dependencies

- Unix or Linux system. Mac OS X and Windows should work but have not been
  tested yet.
- Python 2.4 or higher.
- Sqlite module (included in Python since 2.5 release).
- SQLObject 0.9 or higher.

# Quickstart

Here is an example of a short Yokadi session:

Start Yokadi:

    ./yokadi
    Using default database (/home/me/.yokadi.db)
    Creating database
    Added keyword 'severity'
    Added keyword 'likelihood'
    Added keyword 'bug'

Create your first task:

    yokadi> t_add birthday Buy food and drinks
    Project 'birthday' does not exist, create it (y/n)? y
    Added project 'birthday'
    Added task 'Buy food and drinks' (id=1)

Add two other tasks:

    yokadi> t_add birthday Invite Bob
    Added task 'Invite Bob' (id=2)
    yokadi> t_add birthday Invite Wendy
    Added task 'Invite Wendy' (id=3)

List tasks for project "birthday":

    yokadi> t_list birthday
                                             birthday
    ID |Title                                                       |U  |S|Creation date   |Time left
    --------------------------------------------------------------------------------------------------
    1  |Buy food and drinks                                         |0  |N|2009-01-09 08:57|
    2  |Invite Bob                                                  |0  |N|2009-01-09 08:58|
    3  |Invite Wendy                                                |0  |N|2009-01-09 08:58|

Once you have called Bob, you can mark task 2 as done:

    yokadi> t_mark_done 2
    Task 'Invite Bob' marked as done

    yokadi> t_list birthday
                                             birthday
    ID |Title                                                       |U  |S|Creation date   |Time left
    --------------------------------------------------------------------------------------------------
    1  |Buy food and drinks                                         |0  |N|2009-01-09 08:57|
    3  |Invite Wendy                                                |0  |N|2009-01-09 08:58|

Task 2 has not disappeared, but `t_list` skips done tasks by default. To list
all tasks use:

    yokadi> t_list birthday --all
                                             birthday
    ID |Title                                                       |U  |S|Creation date   |Time left
    --------------------------------------------------------------------------------------------------
    1  |Buy food and drinks                                         |0  |N|2009-01-09 08:57|
    2  |Invite Bob                                                  |0  |D|2009-01-09 08:58|
    3  |Invite Wendy                                                |0  |N|2009-01-09 08:58|

To list only tasks marked as done today:

    yokadi> t_list birthday --done today
                                             birthday
    ID |Title                                                       |U  |S|Creation date   |Time left
    --------------------------------------------------------------------------------------------------
    2  |Invite Bob                                                  |0  |D|2009-01-09 08:58|

You may want to attach your grocery list to task 1. This can be done with
`t_describe`.

    yokadi> t_describe 1

This will start the editor specified in $EDITOR (or `vi` if not set) to enter
a longer text, attached to the task.

You can now display details of task 1:

    yokadi> t_show 1
     Project: birthday
       Title: Buy food and drinks
     Created: 2009-01-09 08:57:33
         Due: None
      Status: new
     Urgency: 0
    Keywords:

    - Orange juice
    - Coke
    - Beer
    - Cookies
    - Pizzas

Note: `t_show` is not mandatory, just entering the task number will display its
details.

`t_list` indicates tasks which have a longer description with a `*` character:

    yokadi> t_list birthday
                                             birthday
    ID |Title                                                       |U  |S|Creation date   |Time left
    --------------------------------------------------------------------------------------------------
    1  |Buy food and drinks                                        *|0  |N|2009-01-09 08:57|
    3  |Invite Wendy                                                |0  |N|2009-01-09 08:58|

There is much more, we only scratched the surface, but this should get you
started. You can get a list of all commands by typing `help` and get the
detailed documentation of a command with `help <command>`.

# Advanced stuff

## Quick access to last task

When you execute multiple commands on the same task, you can use `_` as a shortcut to the last task id. Assuming you created a task like this:

    yokadi> t_add home Buy chocolate
    Added task 'Buy chocolate' (id=1069)

Then the following commands are equivalents (until you work on another task):

    yokadi> t_edit 1069
    yokadi> t_edit _

## Due dates

You can define due dates for your tasks with `t_due`. This can be done with a relative or absolute date:

    yokadi> t_due 21 +3d
    Due date for task 'Buy chocolate' set to Sat Jul 11 17:16:20 2009

    yokadi> t_due 21 23/07 10:30
    Due date for task 'Buy chocolate' set to Thu Jul 23 10:30:00 2009

Due dates are shown by `t_list`. Due date is colored according to time left. If you want to be reminded when a task
is due, you can use the Yokadi Daemon for that. See below for details.

## Periodic tasks

If you have periodic tasks, you can tell it to yokadi with `t_recurs`:

    yokadi> t_recurs 1 weekly monday 21:30
    yokadi> t_recurs 1 monthly 3 11:00
    yokadi> t_recurs 1 monthly last saturday 11:00
    yokadi> t_recurs 1 yearly 23/2 14:00

Type `help t_recurs` to see all possible syntax

## Encrypt your tasks

Whenever you want to protect your todo list data, yokadi provide a simple mechanism
to encrypt a task title or description. This is usefull when you store passwords like tasks
or notes. 

Let's encrypt a task and a note title with the -c option:

    yokadi> t_add -c my_project this is a very secret task, don't tell anyone !
    passphrase>
    Added task '<... encrypted data...>' (id=1)

Yokadi ask you for a passphrase. Don't forget it! It is a global passphrase for this yokadi database.
Each time you will want to encrypt something, you will have to use this passphrase. For convenience, Yokadi
will keep this passphrase in memory during your yokadi session. If you are quite paranoiac and feel bad with that,
don't panic, you can set the PASSPHRASE_CACHE option to 0 to disable passphrase cache:

    yokadi> c_set PASSPHRASE_CACHE 0
    Info: Parameter updated

If you list encrypted stuff but have still give your passphrase in the current session, yokadi won't bother you with asking
for passphrase, but won't data in a clear way:

    yokadi> t_list
                                 my_project                             
    ID|Title                  |U  |S|Age     |Due date                  
    --------------------------------------------------------------------
    1 |<... encrypted data...>|0  |N|5m      |                          
    yokadi> 

To reveal secret data, you have to use the --decrypt option and type your passphrase when prompted to:

    yokadi> t_list --decrypt
    passphrase> 
                                             my_project                                         
    ID|Title                                          |U  |S|Age     |Due date                  
    --------------------------------------------------------------------------------------------
    1 |this is a very secret task, don't tell anyone !|0  |N|6m      |                          
    yokadi> 

Note: when you encrypt a task or note title, the description will be also encrypted. 

## Tasks range and magic __ keyword

t_apply is a very function but sometimes you have to use it on numerous tasks. First, you can use task range like this:

    yokadi> t_apply 1-3 t_urgency 10
    Executing: t_urgency 1 10
    Executing: t_urgency 2 10
    Executing: t_urgency 3 10
    yokadi> 

But sometimes tasks are not consecutive and you would like to use wonderful t_list options to select your tasks.
Here's the trick: each time you display tasks with t_list, yokadi store the id list in the magic keywod __ that you can
give to t_apply like this:

    yokadi> t_list @keyword myProject
    (...)
    yokadi> t_apply __ t_urgency 35

Oh, by the way, some yokadi dev use the followings alias which is quite self explicit :

    yokadi> a_list
    procrastinate => t_apply __ t_due +1d

# Integration

## Database location

By default, Yokadi creates a database in `$HOME/.yokadi.db`, but you can
specify an alternative location with the `--db` option.

A convenient way to start yokadi is by creating an alias in your `.bashrc` file
like this:

    alias y=yokadi

The single letter `y` will start Yokadi with your favorite database from
wherever you are.

If you do not want to use the default database location, you can define
the `YOKADI_DB` env variable to point to your database:

    export YOKADI_DB=$HOME/work/yokadi.db

## History location

By default, Yokadi will store input history in `$HOME/.yokadi_history`. This file
stores commands used in Yokadi for future use and reference.

If you do now want to use the default history file location, you can define
the `YOKADI_HISTORY` env variable to point to your history file:

    export YOKADI_HISTORY=$HOME/.hist/yokadi_history

## Yokadid, the Yokadid daemon

If you want to be automatically reminded of due tasks, you can use the Yokadi
daemon.

The Yokadi daemon can be launched via desktop autostart services. In KDE, you
must create a symlink to yokadid (or a shell script that calls it) in `$HOME/.kde/Autostart/`.

    ln -s `which yokadid` $HOME/.kde/Autostart/

# Contact

The project is hosted on http://yokadi.github.com.

All discussion happens on Yokadi mailing-list, hosted by our friends from the
Sequanux LUG. To join, visit
<http://sequanux.org/cgi-bin/mailman/listinfo/ml-yokadi>.

You can also find some of us on #yokadi, on the Freenode IRC network.

# Authors

Yokadi has been brought to you by:

- Aurélien Gâteau <aurelien.gateau@free.fr>: Developer, founder
- Sébastien Renard <sebastien.renard@digitalfox.org>: Developer

Other people contributed to Yokadi:

- Olivier Hervieu <olivier.hervieu@wallix.com>: first working setup.py release
- Marc-Antoine Gouillart <marsu_pilami@msn.com>: Windows port
- Kartik Mistry <kartik@debian.org>: man pages
- Jonas Christian Drewsen <jdrewsen@gmail.com>: quarterly recurrence feature

<!-- vim: set ts=4 sw=4 et: -->

Results 1 - 1 of 1
Help - FTP Sites List - Software Dir.
Search over 15 billion files
© 1997-2017 FileWatcher.com