A kanban-style project task queue.
Project description
DaiKanban
大看板
A command-line Kanban board that helps you prioritize and organize your projects.
Screenshot
(screenshot from v0.1.0
)
Inspired by prior projects like the excellent clikan and kanban-python, I've made yet another terminal kanban board in Python. My long-term goals with it are:
- High degree of customization (display settings, scoring/prioritizing tasks)
- Syncing with external platforms (Github/Jira Issues)
- Productivity metrics and completion forecasting
⚠️ DaiKanban is currently in its very early stages and should not be considered stable.
Concepts
A DaiKanban board displays your tasks, organized into three status groups:
todo
(AKA backlog)active
(AKA in-progress)completed
Tasks advance from one status to the next. You can rank tasks in your backlog by various criteria such as priority, expected time to completion, etc.
You may have more than one board (e.g. to separate personal and business tasks), and tasks in each board may be associated with projects to categorize them further.
Installation
pip install daikanban
Usage
View help menu:
daikanban -h
Launch interactive shell:
daikanban shell
Common shell commands
Long | Short | Description |
---|---|---|
help |
h |
Show help menu |
quit |
q |
Quit |
board load |
b l |
Load a board |
board show |
b s |
Show current board |
project new |
p n |
Create new project |
project show [PROJECT] |
p s [PROJECT] |
Show project info |
task new |
t n |
Create new task |
task show [TASK] |
t s [TASK] |
Show task info |
task set [FIELD] [VALUE] |
t set [FIELD] [VALUE] |
Update task info (if VALUE is omitted, set it to null) |
Projects and tasks can be referred to either by their ID (a unique number assigned at creation) or their name. For ease of use, it is recommended to avoid whitespace characters in names:
- ❌
Do the thing
- ✅
do-the-thing
Shell commands to advance tasks
Long | Short | Description |
---|---|---|
task begin [TASK] |
t b [TASK] |
Start a task in the backlog |
task complete [TASK] |
t c [TASK] |
Complete an active task |
task pause [TASK] |
t p [TASK] |
Pause an active task |
task resume [TASK] |
t r [TASK] |
Resume a paused or completed task back to active |
task todo [TASK] |
t t [TASK] |
Revert a task to the backlog |
Board files
For now, DaiKanban boards are saved as local JSON files that you need to load explicitly, either by running board load [FILENAME]
within the shell, or launching the program like daikanban shell --board [FILENAME]
.
You can store multiple board files in your canonical board directory, including a default board file that will load automatically. This can be set using the global configuration file.
Configuration
To customize configurations, create a new config file:
daikanban config new
This creates a TOML file you can modify. You can override default settings like what board columns are displayed, how many tasks to show, preferred date format, and much more.
Flexible dates & times
One nice feature of DaiKanban is its flexible datetime parsing. For example, when creating a new task, it will prompt you for a due date. All of the following responses are valid:
2024-03-19
3/19/24
march 19th
in 2 days
in two days
48 hours from now
This makes it easy to enter these kinds of fields naturally as a human, without having to memorize a specific date format. 😃
🚧 Future Work
- Syncing with external platforms (Github, Jira)
- Custom task statuses
- Blocking tasks
- Recurring tasks
- Standard markdown format for storing readable task lists
- Productivity analytics
- Web-based alternative to CLI
- And more...
Support and feedback
🛠️ Feel free to submit pull requests, ask questions, or make bugfix/feature requests on Github Issues.
✨ This library is built on pydantic, fancy-dataclass, typer, and rich. Check them out!
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 daikanban-0.2.0.tar.gz
.
File metadata
- Download URL: daikanban-0.2.0.tar.gz
- Upload date:
- Size: 724.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: python-httpx/0.23.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9d9200a2e84ad3254cb357aec10821f4679b284f54a8e76777591b3b42f28c22 |
|
MD5 | b3887d279e23ef4e5962751444295402 |
|
BLAKE2b-256 | ebf69c5b3152e594c5037af76ef318d0a3b6b5fcc8010734c3a597432f87e048 |
File details
Details for the file daikanban-0.2.0-py3-none-any.whl
.
File metadata
- Download URL: daikanban-0.2.0-py3-none-any.whl
- Upload date:
- Size: 51.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: python-httpx/0.23.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6b71a702fb373c1f618be17a876dc522601c16ce62e969b949bca38c898d5456 |
|
MD5 | d74d74641e8dd0627a08bd2be22acb67 |
|
BLAKE2b-256 | 131c72894d92293e4f862cc15708bbcf25b2f8c6071d736a0417a9f1731d701e |