Skip to main content

Console UI to manage your todo.txt file(s).

Project description

pter

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

A screenshot of pter in action

There’s a presentation of pter in motion on asciinema.

Also in this package, the QT5 based graphical user interface, qpter.

A screenshot of qpter

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:, rec:, id:
  • Save search queries and sorting for quick access
  • Convenient entering of dates
  • Time tracking, notes, task delegation
  • Connect tasks in sequences
  • Template system and auto-completion for ease of creating tasks
  • Support for archive and trash
  • Can work with multiple todo.txt files at the same time
  • Configurable behaviour, shortcuts, and colors

There is also a graphical user interface called qpter, but some features are missing.

Installation

Install using pipx

To install pter using pipx, run this:

    pipx install pter

If you wish to use qpter, the graphical version of pter, make sure you pass this option to pipx:

    pipx install pter[qt]

Install from PIP

This is the deprecated way to install pter; instead rather use pipx; see above.

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

    pip install pter

If you want to use the Qt GUI qpter, you have to install PyQt5::

    pip install PyQt5

Using pter

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

    pter ~/todo.txt

For the graphical user interface (requires QT), you have to start it like this:

    qpter ~/todo.txt

Both 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

Using qpter

To launch the Qt GUI, you may (but don’t have to) provide the location of your todo.txt file::

    qpter ~/todo.txt

Contributing

Just like any other open source project, you’re invited to participate in pter’s development. Any contribution is welcome, from bug reports to pull requests/sending of patches!

You can find the project at codeberg or just email any of the authors with your input.

There is also a general XMPP discussion channel pter over at spacepanda.se.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pter-3.18.0.tar.gz (318.7 kB view details)

Uploaded Source

Built Distribution

pter-3.18.0-py3-none-any.whl (111.5 kB view details)

Uploaded Python 3

File details

Details for the file pter-3.18.0.tar.gz.

File metadata

  • Download URL: pter-3.18.0.tar.gz
  • Upload date:
  • Size: 318.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.1.dev0+g94f810c.d20240510 CPython/3.12.7

File hashes

Hashes for pter-3.18.0.tar.gz
Algorithm Hash digest
SHA256 a0a9af10c2f54f37dcce686f8f93316cf7c114b3256c13fdc1aa74d61a86fcd4
MD5 b11dfffa94dd72dc545868e1f250a8ff
BLAKE2b-256 f38c0ba867644dc8cf806de997207cfb284cf3cf9bd5960940fcadc146bd998c

See more details on using hashes here.

File details

Details for the file pter-3.18.0-py3-none-any.whl.

File metadata

  • Download URL: pter-3.18.0-py3-none-any.whl
  • Upload date:
  • Size: 111.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.1.dev0+g94f810c.d20240510 CPython/3.12.7

File hashes

Hashes for pter-3.18.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8bd5ab3ab8715df34d13c00455db0ea70da7dee1193de07c74a2f31b9bf69b35
MD5 dae2a1caa3d119c60cf49013af1cdf48
BLAKE2b-256 ecb6b4e4e39fba2b8c7d27f03ebfd3fb782853659d80de4778e8c54bf35073c2

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page