Skip to main content

A python TUI todo app

Project description

Todol - Python TUI ToDo app

Installation

pip install todol

More Info

todol is a terminal application. I recommend installing it with pipx.

Demo

Running

Run from anywhere in you terminal with the command todol

COMMAND GUIDE

┏━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━━━━┳━━━━━━━┓
┃ Command    ┃ Alias  ┃ Action           ┃ Usage ┃
┡━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━━━━╇━━━━━━━┩
│ add        │ a      │ Add new task     │ add   │
│ done       │ d      │ Mark task done   │ done  │
│ list       │ l      │ Show todo list   │ list  │
│ remove     │ rm     │ Remove task      │ rm    │
│ edit       │ e      │ Edit task        │ edit  │
│ clear      │ c      │ Clear done tasks │ clear │
│ help       │ h      │ Show help        │ help  │
│ exit       │ 0      │ Exit app         │ exit  │
└────────────┴────────┴──────────────────┴───────┘
Tip: You can use Tab for autocomplete.
Pro Tip: Navigate the terminal efficiently: arrow keys, backspace, and delete all work.

FAQ

Where are the saved todo files stored?

todol stores its data using platformdirs.user_data_dir, which means files are written to the standard user data directory for each operating system.

Default locations

  • Linux ~/.local/share/todol/todoFiles/

  • macOS ~/Library/Application Support/todol/todoFiles/

  • Windows %APPDATA%\todol\todoFiles\

Hotkeys are available!

Cursor navigation

Key Action
Ctrl‑a Move cursor to beginning of line
Ctrl‑e Move cursor to end of line
Ctrl‑f Move cursor forward (right)
Ctrl‑b Move cursor backward (left)
Alt‑f Move forward one word
Alt‑b Move backward one word
Home Go to start of line
End Go to end of line

Editing

Key Action
Ctrl‑d Delete character under cursor
Ctrl‑h / Backspace Delete character before cursor
Alt‑d Delete word forward
Ctrl‑k Kill (cut) text to end of line
Ctrl‑y Yank (paste) killed text
Ctrl‑t Transpose characters

History

Key Action
Ctrl‑p Previous history item
Ctrl‑n Next history item

Searching

Key Action
Ctrl‑r Reverse search history
Ctrl‑s Forward search history (may be intercepted by terminal flow control)

Completion & Accept

Key Action
Tab Trigger completion
Ctrl‑Space Start/advance completion
Enter Accept input

Misc

Key Action
Ctrl‑c Cancel / raise KeyboardInterrupt
Ctrl‑z Suspend (depends on shell)
Escape Escape/Meta prefix for Alt‑ combos
Arrow keys Move cursor up/down/left/right

For the full official key binding documentation, check the prompt_toolkit docs: prompt_toolkit GITHUB

Support

If you find this project helpful and would like to support its development, you can make a donation via the following method:

Your contribution helps in maintaining and improving the app. Thank you for your support!

License

This project is licensed under the MIT License - see the LICENSE file for details.

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

todol-0.2.10.tar.gz (9.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

todol-0.2.10-py3-none-any.whl (9.4 kB view details)

Uploaded Python 3

File details

Details for the file todol-0.2.10.tar.gz.

File metadata

  • Download URL: todol-0.2.10.tar.gz
  • Upload date:
  • Size: 9.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for todol-0.2.10.tar.gz
Algorithm Hash digest
SHA256 d435b043adeeacfd0a1c3def5215e328a0a76aa51a530035afaf9950198ac946
MD5 33549a7b3f364d2e1c1232a6caf7e7cc
BLAKE2b-256 a0666cbe5f6b8958bb424271b7a8f080a8cae55633b981c93229c77c74c6272a

See more details on using hashes here.

File details

Details for the file todol-0.2.10-py3-none-any.whl.

File metadata

  • Download URL: todol-0.2.10-py3-none-any.whl
  • Upload date:
  • Size: 9.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for todol-0.2.10-py3-none-any.whl
Algorithm Hash digest
SHA256 97b583283e7e0d3b7eef1d669cfc7df1b671a5c1436afdc9debb50dce8721e28
MD5 efeafeaf74147f33b635e0d92d24c28e
BLAKE2b-256 76c3d0ca5d31a7dd87dad138ee6d7ad9e80b78f2fbdc25640006cdd89c7e3d3a

See more details on using hashes here.

Supported by

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