customizeable task tui powered by textual
Project description
kanban-tui
kanban-tui is a customizable task manager in the terminal.
Features
Expand for more detailed information
Following the XDG basedir convention
kanban-tui utilizes platformdirs user_config_dir
to save
the config file and user_data_dir
for the sqlite database.
Customizeable Board
kanban-tui comes with four default columns
(Ready
, Doing
, Done
, Archive
) but can be customized to your needs.
More columns can be created via the Settings
-Tab. Also the visibility of columns can be toggled.
Deletion of existing columns is only possible, if no task is present in the column you want to delete.
Task Management
When on the Kanban Board
-Tab you can create (n)
, edit (e)
, delete (d)
or move (H, L)
tasks between columns.
Visual Summary
To give you an overview over the amount of tasks you created
, started
or finished
, kanban-tui
provides an Overview
-Tab to show you a bar-chart on a monthly
, weekly
or daily
scale.
It also can be changed to a stacked bar chart per category.
This feature is powered by the plotext library with help of textual-plotext.
Installation
You can install kanban-tui
with one of the following options:
# not recommended
pip install kanban-tui
pipx install kanban-tui
rye install kanban-tui
uv tool install kanban-tui
I recommend using pipx, rye or uv to install CLI Tools into an isolated environment.
Usage
Normal Mode
ktui
Demo Mode
Creates a temporary Config and Database which is populated with example Tasks to play around.
Kanban-Tui will delete the temporary Config and Database after closing the application.
Pass the --clean
flag to start with an empty demo app.
Pass the --keep
flag to tell kanban-tui
not to delete the temporary Database and Config.
ktui demo
Feedback and Issues
Feel free to reach out and share your feedback, or open an Issue, if something doesnt work as expected. Also check the Changelog for new updates.
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
Built Distribution
File details
Details for the file kanban_tui-0.3.2.tar.gz
.
File metadata
- Download URL: kanban_tui-0.3.2.tar.gz
- Upload date:
- Size: 157.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.5.1
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 153ac3fa1dea9c50b077d57e2f9ae8386d2f3bc1e4e397d45f46e496e1b1e2eb |
|
MD5 | 7abbfc30b916afcad75f6b2801b66ec8 |
|
BLAKE2b-256 | 5cf4bea96ce76dd52d9bfb2e6449be1190337b0a1e4050a48228074d126f75ee |
File details
Details for the file kanban_tui-0.3.2-py3-none-any.whl
.
File metadata
- Download URL: kanban_tui-0.3.2-py3-none-any.whl
- Upload date:
- Size: 38.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.5.1
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 11c3a63e9d93b093e37c5f26c0554c1070a03cb7051de34b31b7848c6ede928f |
|
MD5 | 7408fde9941ccb5a9d4ddb062bf93d2f |
|
BLAKE2b-256 | 8416f49a3f958a8c40148b6abe83e604f832cda31d54665d81088ad39eaf1c0d |