Home

Awesome

<!-- Icons -->

Ruff PyPI-Server Pyversions License: MIT Downloads Coverage Status

kanban-tui

kanban-tui is a customizable task manager in the terminal.

<!-- ![board_image](https://raw.githubusercontent.com/Zaloog/kanban-tui/main/images/image_kanbanboard.png) -->

Demo GIF

demo_gif

If you want to test kanban-tui you can directly run this demo yourself with the help of uv using uvx with

uvx --from kanban-tui ktui demo

Features

Expand for more detailed information

</details> <details><summary>Following the XDG basedir convention</summary>

kanban-tui utilizes platformdirs user_config_dir to save the config file and user_data_dir for the sqlite database.

</details> </details> <details><summary>Customizeable Board</summary>

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.

</details> </details> <details><summary>Multi Board Support</summary>

With version v0.4.0 kanban-tui allows the creation of multiple boards. Use B on the Kanban Board-Tab to get an overview over all Boards including the amount of columns, tasks and the closest Due Date. Each Board starts with the default columns, but the columns are individual for each board.

</details> </details> <details><summary>Task Management</summary>

When on the Kanban Board-Tab you can create (n), edit (e), delete (d) or move (H, L) tasks between columns.

</details> <!-- </details> <details><summary>Database Infomation</summary> - Task attributes - Title - Category - Description - Due Date - Creation Date (updated on task creation) - Start Date (updated on movement to Doing column) - Finish Date (updated on movement to Done column) </details> --> </details> <details><summary>Visual Summary</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.

</details>

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

Starts kanban-tui with a starting board. The application can be closed by pressing ctrl+q.

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

Clear Database and Configuration

If you want to start with a fresh database and configuration file, you can use this command to delete your current database and configuration file.

ktui clear

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.

<!-- Repo Links --> <!-- external Links Python --> <!-- external Links Others -->