A python TUI todo app
Project description
Todol - Python TUI ToDo app
Installation
pip install todol
More Info
- Check out the project page on PyPi: https://pypi.org/project/todol/
- and on Github: https://github.com/WattoX00/todol
todol is a terminal application. I recommend installing it with pipx.
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file todol-0.2.9.tar.gz.
File metadata
- Download URL: todol-0.2.9.tar.gz
- Upload date:
- Size: 6.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
76471851a88211468d4bcf91fad7aab9659dd4946a3fec8998e1fcd963fda91e
|
|
| MD5 |
72b9c4fcf70005e089a78a4701094bda
|
|
| BLAKE2b-256 |
04003112975eb4b0996d270854c4faf14e8a6888b736ba1018970f6dc7e40ccb
|
File details
Details for the file todol-0.2.9-py3-none-any.whl.
File metadata
- Download URL: todol-0.2.9-py3-none-any.whl
- Upload date:
- Size: 7.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
dc3b036f84e49992b73aab6291e32c1005eaa0a9f59be39d4bf8d258e3711a1c
|
|
| MD5 |
5afc6b10ed39197159f55d750352ed10
|
|
| BLAKE2b-256 |
17552b0f0141859bda24eb58c692206db4471bfcb69f78c1c634d389e1626e5c
|