https://github.com/topydo/topydo

A powerful todo list application for the console, using the todo.txt format.
https://github.com/topydo/topydo

bsd cli cross-platform hacktoberfest linux macos open-source python task task-list task-manager todo todoapp todotxt tui windows

Last synced: 4 days ago
JSON representation

A powerful todo list application for the console, using the todo.txt format.

• Host: GitHub
• URL: https://github.com/topydo/topydo
• Owner: topydo
• License: gpl-3.0
• Created: 2014-10-19T13:49:43.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2023-08-14T14:28:51.000Z (about 1 year ago)
• Last Synced: 2024-01-24T00:45:01.648Z (10 months ago)
• Topics: bsd, cli, cross-platform, hacktoberfest, linux, macos, open-source, python, task, task-list, task-manager, todo, todoapp, todotxt, tui, windows
• Language: Python
• Homepage:
• Size: 3.3 MB
• Stars: 713
• Watchers: 27
• Forks: 82
• Open Issues: 70
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt
  • Authors: AUTHORS.md

Awesome Lists containing this project

• awesome-productivity - Topydo - A powerful todo list application using the todo.txt format, positioned between todo.txt CLI and Taskwarrior. (Tools and Apps / Task Management)

README

        
topydo - a powerful todo.txt application

========================================

[![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)

topydo is a powerful todo list application using the [todo.txt format][1].

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**;

* Maintain **dependencies** between todo items;

* **recurring** todo items;

topydo also offers:

* Fine-grained control on **sorting** and **grouping** items;

* Customizable output;

* Some conveniences when adding new items (e.g. adding creation date and use

  **relative dates**);

* 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).

The documentation on [the TiddlyWiki][4] provides more information about the

features and how to use topydo.

Installation

------------

Simply install with:

    pip3 install topydo

If you wish to use column mode: install additional dependencies with:

    pip3 install topydo[columns]

Similarly, for prompt mode you can install additional dependencies with:

    pip3 install topydo[prompt]

Demo

----

CLI mode:

![gif][5]

[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

[4]: https://topydo.org/

[5]: https://raw.githubusercontent.com/topydo/topydo/master/docs/topydo.gif

[6]: https://raw.githubusercontent.com/topydo/topydo/master/docs/columns.png