https://github.com/purarue/full_todotxt

a todotxt interactive interface that forces you to specify certain attributes.
https://github.com/purarue/full_todotxt

cli prompt-toolkit todo todo-list todotxt tui

Last synced: 29 days ago
JSON representation

a todotxt interactive interface that forces you to specify certain attributes.

• Host: GitHub
• URL: https://github.com/purarue/full_todotxt
• Owner: purarue
• License: mit
• Created: 2020-05-12T23:50:07.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-10-24T23:17:56.000Z (3 months ago)
• Last Synced: 2024-12-01T21:47:49.746Z (about 2 months ago)
• Topics: cli, prompt-toolkit, todo, todo-list, todotxt, tui
• Language: Python
• Homepage: https://pypi.org/project/full_todotxt
• Size: 1.6 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# full-todotxt

[![PyPi version](https://img.shields.io/pypi/v/full_todotxt.svg)](https://pypi.python.org/pypi/full_todotxt) [![Python 3.8|3.9|3.10|3.11](https://img.shields.io/pypi/pyversions/full_todotxt.svg)](https://pypi.python.org/pypi/full_todotxt)

[todotxt](https://github.com/todotxt/todo.txt) interactive interface that forces you to specify certain attributes.



For each todo, you have to specify at least `one project tag` (e.g. `+work`) and a priority `(A)`.

Though not required for each todo, it will prompt you want to specify a `deadline`, which will store a `deadline` key-value pair to the todo with the datetime as the value.

For example:

```

(A) measure space for shelving +home deadline:2020-05-13-15-30

```

... which specifies 2020-05-13 at 3:30PM.

If the `todo.txt` file is not provided as the first argument, it tries to guess based on typical locations

The `my.todotxt.active` module in [HPI](https://github.com/purarue/HPI) parses the deadline back into python:

```

$ hpi query my.todotxt.active.todos -s | jq 'select(.deadline) | .raw' -r

(C) 2023-10-01 drink water +self deadline:2023-10-02T00-00-0700

```

## Installation

#### Requires:

`python3.8+`

To install with pip, run:

    python3 -m pip install full-todotxt

## Usage

```

Usage: full_todotxt [OPTIONS] [TODOTXT_FILE]

  If TODOTXT_FILE is not specified, the environment variable FULL_TODOTXT_FILE will be used.

Options:

  --add-due / --no-add-due        Add due: key/value flag based on deadline:  [default: no-add-due]

  -t, --time-format TEXT          Specify a different time format for deadline:  [env var: FULL_TODOTXT_TIME_FORMAT;

                                  default: %Y-%m-%d-%H-%M]

  -f, --full-screen / -p, --prompts

                                  Use prompts or the full screen dialog editor [default: full-screen]

  -h, --help                      Show this message and exit.

```

This checks many possible locations for the `todo.txt` file:

- `TODOTXT_FILE` passed to `full_todotxt`

- `$FULL_TODOTXT_FILE` environment variable

- `$TODO_DIR/todo.txt`

- `$XDG_CONFIG_HOME/todo/todo.txt`

- `~/.config/todo/todo.txt`

- `~/.todo/todo.txt`

- `~/.todo.txt`

- `~/todo.txt`