https://github.com/jnrowe/penelopise

Thing to do when things need doing
https://github.com/jnrowe/penelopise

Last synced: 5 days ago
JSON representation

Thing to do when things need doing

• Host: GitHub
• URL: https://github.com/jnrowe/penelopise
• Owner: JNRowe
• License: gpl-3.0
• Created: 2024-04-22T09:09:37.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-04-25T22:06:08.000Z (10 months ago)
• Last Synced: 2024-04-25T23:52:38.452Z (10 months ago)
• Language: Python
• Size: 18.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: COPYING

Awesome Lists containing this project

README

        
``penelopise`` — Minimal todo tracking

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

.. note::

   This isn’t a working tool, or even a *moderately* working tool.  I’m just

   playing around with things.

I’ve been using taskwarrior_ for well over a decade, but the recent release has

left me with somewhat of a quandary.  Version 3 has `changed the backend`_ to

use sqlite, but that makes it incompatible with version 2.  I’m left wondering

if it makes more sense to switch tools than try to figure out how to work while

the different systems I use migrate to making version 3 available at their own

pace.  My question is “What is the *least* amount of effort that could get me

to a working system?”

Perhaps it would be possible to just revert to using todo.txt_, and bring the

experience I value from taskwarrior along for the ride.  What this means to me:

1. Local; I don’t want to trust my data to a remote service for both privacy

   and availability reasons.

2. Scriptable output; firstly to enable the web and interactive terminal

   interface I use, but also to make mangling the data in bulk easier.

3. Works tomorrow; I don’t want to upgrade my system and find my todo list is

   out of reach [again].

``todo.txt`` provides most of this as a base data format.  Let’s make it

happen!

Required features

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

Body text

'''''''''

I realised very early on that I need some degree of multi-line todo items,

which ``todo.txt`` doesn’t provide.  This isn’t a showstopper however, as it is

really easy to implement in a compliant manner.  The format allows for

user-defined key/value pairs, so we can simply add a ``body:`` element to

an entry.

This method has added advantages too:

* We can navigate using ``gf`` from within vim_.

* We aren’t restricted by file type or content, for example

  ``image:`` or ``json:``.  Easy access via ```` while

  editing.

* Multiple items can reference the same supporting data, which would require

  duplication with simple multi-line items.

* A self-standardised key set makes it easy to support in an external UI.

.. _taskwarrior: https://taskwarrior.org/

.. _changed the backend: https://taskwarrior.org/docs/upgrade-3/

.. _todo.txt: https://todotxt.org/

.. _vim: https://www.vim.org/