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.20.1.tar.gz (325.7 kB view details)

Uploaded Source

Built Distribution

pter-3.20.1-py3-none-any.whl (149.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pter-3.20.1.tar.gz
  • Upload date:
  • Size: 325.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for pter-3.20.1.tar.gz
Algorithm Hash digest
SHA256 4f1c480d0930d93d3d3f2d986ecca1456a00ded21cf0feaf4041cc506cc336ed
MD5 12d70c2250b9ec1789a45273c426b813
BLAKE2b-256 7cb39d527cabc89e376f05d7c1047f82a8c9eb9f1f40d1ca8f3830bd52917d1b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pter-3.20.1-py3-none-any.whl
  • Upload date:
  • Size: 149.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for pter-3.20.1-py3-none-any.whl
Algorithm Hash digest
SHA256 fa1448ca673ce8f526e6b32d3b7e3485ece11479a363c8e738d47a98757a6a11
MD5 83b4132973a371b301946498c7b10131
BLAKE2b-256 2881167db12f2b58e9cace4a06307dc7b805f95d038a70a1a6cf41a1cea09e65

See more details on using hashes here.

Supported by

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