Metadata-Version: 2.1
Name: pter
Version: 1.0.0
Summary: Console UI to manage your todo.txt file(s).
Home-page: https://github.com/vonshednob/pter
Author: R
Author-email: devel+pter@kakaomilchkuh.de
License: UNKNOWN
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console :: Curses
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.0
Description-Content-Type: text/markdown
Requires-Dist: pytodotxt (>=1.0)
Provides-Extra: xdg
Requires-Dist: pyxdg ; extra == 'xdg'

# pter

Your console UI to manage your todo.txt file(s).

![](doc/pter-demo.gif)

pter has a bunch of features that help you managing your todo.txt file:

 - Fully compatible to the todo.txt standard
 - Support for `due:`, `h:`, `t:`
 - Save search queries for quick access
 - Convenient entering of dates
 - Configurable behaviour, shortcuts, and colors
 - Time tracking


## Installation

### Install from PIP

To install pter you can either clone the repository (see at the end) or, much
simpler, use pip to install it:

    pip install pter


### Clone from github

To go the long way and clone the repository from github, these are the steps
to follow:

    git clone https://github.com/vonshednob/pter.git
    cd pter
    pip install .

There is a man-page available, but `pip` won’t install it by default (it
doesn’t know where to). If you want to, you can just copy it from `man/pter.1`
to your man-page folder (usually `~/.local/share/man/man1`).


## Using pter

To launch pter you have to tell it where your todo.txt file is:

    pter ~/todo.txt

This will give you a listing of all your tasks order by how soon they will be
due and what priority you have given them.

You can navigate the tasks with your cursor keys and edit selected tasks by
pressing `e`.

More default shortcuts are:

 - `e`, edit the selected task
 - `n`, create a new task
 - `d`, mark the selected task as done (or toggle back to not done)
 - `?`, show all keyboard shortcuts
 - `q`, quit the program

There is a complex search available (have a look at the manual for details), but the short version is:

 - press `/` to enter your search terms
 - search for `done:n` to only show incomplete tasks
 - search for a context with `@context`
 - search for a project with `+project`
 - search for tasks that do not belong to a context with `-@context` or `not:@context`
 - press `Return` to return the focus to the task list



