2017-01-11 12:26:40 +00:00
|
|
|
topydo - a powerful todo.txt application
|
|
|
|
========================================
|
2014-10-19 13:47:49 +00:00
|
|
|
|
2020-11-23 06:46:12 +00:00
|
|
|
[![Build Status](https://travis-ci.org/topydo/topydo.svg?branch=master)](https://travis-ci.org/topydo/topydo) [![codecov.io](https://codecov.io/github/topydo/topydo/coverage.svg?branch=master)](https://codecov.io/github/topydo/topydo?branch=master) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/2957b80fffa0460bbb0e1ff7948f0ee7)](https://www.codacy.com/app/bram85/topydo?utm_source=github.com&utm_medium=referral&utm_content=bram85/topydo&utm_campaign=Badge_Grade) [![PyPI version](https://badge.fury.io/py/topydo.svg)](https://badge.fury.io/py/topydo)
|
2015-05-04 22:32:56 +00:00
|
|
|
|
2017-01-11 12:26:40 +00:00
|
|
|
topydo is a powerful todo list application using the [todo.txt format][1].
|
2014-10-19 13:47:49 +00:00
|
|
|
|
2017-01-11 12:26:40 +00:00
|
|
|
It has three user interfaces:
|
|
|
|
|
|
|
|
* Command Line Interface (CLI) - originally inspired by the [todo.txt CLI][2]
|
|
|
|
by Gina Trapani.
|
|
|
|
* Prompt mode - a convenience mode for the CLI. Launch with `topydo prompt`.
|
|
|
|
* Column mode - a text based user interface (TUI) with customizable columns and
|
|
|
|
vim-like bindings. Launch with `topydo columns`.
|
|
|
|
|
|
|
|
![png][6]
|
|
|
|
|
|
|
|
Features
|
|
|
|
--------
|
|
|
|
|
|
|
|
Feature-wise, the todo.txt format is quite limited, but can be extended using
|
|
|
|
tags. topydo natively supports some of these tags to implement:
|
|
|
|
|
|
|
|
* **Due** and **start dates**;
|
2014-10-19 13:47:49 +00:00
|
|
|
* Maintain **dependencies** between todo items;
|
2017-01-11 12:26:40 +00:00
|
|
|
* **recurring** todo items;
|
|
|
|
|
|
|
|
topydo also offers:
|
|
|
|
|
|
|
|
* Fine-grained control on **sorting** and **grouping** items;
|
|
|
|
* Customizable output;
|
2014-10-19 13:47:49 +00:00
|
|
|
* Some conveniences when adding new items (e.g. adding creation date and use
|
|
|
|
**relative dates**);
|
2017-01-11 12:26:40 +00:00
|
|
|
* Additional output formats to iCalendar, JSON and Graphviz Dot;
|
|
|
|
* Aliases for frequently used commands.
|
|
|
|
* Text based todo identifiers, which are more stable and convenient than
|
|
|
|
line-based todo identifiers.
|
|
|
|
|
|
|
|
Yet, topydo is fully todo.txt compliant. The text file can be processed by
|
|
|
|
other todo.txt tools (but they may not interpret the tags properly).
|
2014-10-19 13:47:49 +00:00
|
|
|
|
2020-10-06 00:47:01 +00:00
|
|
|
The documentation on [the TiddlyWiki][4] provides more information about the
|
2016-07-08 19:13:14 +00:00
|
|
|
features and how to use topydo.
|
2014-10-19 20:09:07 +00:00
|
|
|
|
2017-01-11 12:26:40 +00:00
|
|
|
Installation
|
|
|
|
------------
|
2014-12-04 06:10:07 +00:00
|
|
|
|
2015-06-20 18:40:34 +00:00
|
|
|
Simply install with:
|
2014-12-04 06:10:07 +00:00
|
|
|
|
2017-01-18 10:40:03 +00:00
|
|
|
pip3 install topydo
|
2014-12-04 06:10:07 +00:00
|
|
|
|
2017-01-11 12:26:40 +00:00
|
|
|
If you wish to use column mode: install additional dependencies with:
|
|
|
|
|
2017-01-18 10:40:03 +00:00
|
|
|
pip3 install topydo[columns]
|
2016-01-11 15:19:06 +00:00
|
|
|
|
2017-01-11 12:26:40 +00:00
|
|
|
Similarly, for prompt mode you can install additional dependencies with:
|
2016-01-11 15:19:06 +00:00
|
|
|
|
2017-01-18 10:40:03 +00:00
|
|
|
pip3 install topydo[prompt]
|
2015-06-20 18:40:34 +00:00
|
|
|
|
2014-11-30 20:55:20 +00:00
|
|
|
Demo
|
|
|
|
----
|
2014-11-30 20:54:29 +00:00
|
|
|
|
2017-01-11 12:26:40 +00:00
|
|
|
CLI mode:
|
2014-11-30 20:54:29 +00:00
|
|
|
|
2017-01-11 12:26:40 +00:00
|
|
|
![gif][5]
|
2014-10-19 13:47:49 +00:00
|
|
|
|
2014-10-19 13:53:59 +00:00
|
|
|
[1]: https://github.com/ginatrapani/todo.txt-cli/wiki/The-Todo.txt-Format
|
|
|
|
[2]: https://github.com/ginatrapani/todo.txt-cli
|
|
|
|
[3]: https://github.com/bram85/todo.txt-tools
|
2022-12-06 19:57:34 +00:00
|
|
|
[4]: https://topydo.org/
|
2020-10-04 17:21:45 +00:00
|
|
|
[5]: https://raw.githubusercontent.com/topydo/topydo/master/docs/topydo.gif
|
|
|
|
[6]: https://raw.githubusercontent.com/topydo/topydo/master/docs/columns.png
|