README.md 1.62 KB
Newer Older
Sean Breckenridge's avatar
Sean Breckenridge committed
1 2 3
full-todotxt
======

Sean Breckenridge's avatar
Sean Breckenridge committed
4 5
[![PyPi version](https://img.shields.io/pypi/v/full_todotxt.svg)](https://pypi.python.org/pypi/full_todotxt) [![Python 3.6|3.7](https://img.shields.io/pypi/pyversions/full_todotxt.svg)](https://pypi.python.org/pypi/full_todotxt)

Sean Breckenridge's avatar
Sean Breckenridge committed
6 7
[todotxt](http://todotxt.org/) interactive interface that forces you to specify certain attributes.

Sean Breckenridge's avatar
Sean Breckenridge committed
8 9
<img src="https://raw.githubusercontent.com/seanbreckenridge/full_todotxt/master/.github/demo.gif" alt="demo gif">

Sean Breckenridge's avatar
Sean Breckenridge committed
10 11 12 13 14 15 16 17 18 19 20 21
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.

Sean Breckenridge's avatar
Sean Breckenridge committed
22
I use this with [`todotxt_deadline_notify`](https://github.com/seanbreckenridge/todotxt_deadline_notify), which parses the todo.txt file and sends me a reminders whenever a `deadline` is approaching.
Sean Breckenridge's avatar
Sean Breckenridge committed
23

Sean Breckenridge's avatar
Sean Breckenridge committed
24 25
If the `todo.txt` file is not provided as the first argument, it tries to guess based on typical locations

Sean Breckenridge's avatar
Sean Breckenridge committed
26 27 28 29 30 31 32 33 34
Installation
------------

#### Requires:

`python3.6+`

To install with pip, run:

Sean Breckenridge's avatar
Sean Breckenridge committed
35
    pip3 install full-todotxt
Sean Breckenridge's avatar
Sean Breckenridge committed
36 37 38 39 40

Run
----------

```
Sean Breckenridge's avatar
Sean Breckenridge committed
41
Usage: full_todotxt [OPTIONS] [TODOTXT_FILE]...
Sean Breckenridge's avatar
Sean Breckenridge committed
42 43

Options:
Sean Breckenridge's avatar
Sean Breckenridge committed
44 45 46 47 48 49
  --add-due           Add due: key/value flag based on
                      deadline:

  --time-format TEXT  Specify a different time format for
                      deadline:

Sean Breckenridge's avatar
Sean Breckenridge committed
50 51 52 53 54 55 56
  --help              Show this message and exit.
```

Example:

```
full_todotxt ~/.todo/todo.txt
Sean Breckenridge's avatar
Sean Breckenridge committed
57 58
```