Terminal Kanban App written in Python
Project description
kanban-python
A Terminal Kanban Application written in Python to boost your productivity :rocket:
Introduction
Welcome to kanban-python, your Terminal Kanban Board Manager.
The clikan Kanban App inspired me to write my own Terminal Kanban Application, since I preferred a more simple and guided workflow.
kanban-python also comes with more features and customization options. This package was developed with pyscaffold, which provides nice project templates and takes over much of the boilerplate for python packaging. Which was a great help for developing my first package.
Features
-
colorful and interactive: kanban-python uses rich under the hood to process user input and display nice looking tables to the terminal.
-
configfile: A
pykanban.ini
file gets created on first initialization in yourHome
-Directory. This can be edited manually or within the kanban-python application. It tracks the location for all your created boards -
storage-file for each board: Each created board comes with its own name and
pykanban.json
file, which stores all tasks for that board. -
column customization: kanban-python comes with 5 pre-defined colored columns: [Ready, Doing, Done, Archived, Deleted] More column can be added in the
pykanban.ini
, also the visibility can be configured. -
time-tracking: for each task it is tracked, how long it was in the Doing column.
Installation
You can install kanban-python with:
python -m pip install kanban-python
Usage
There are 3 commands available after installation of kanban-python:
Create new Boards
kanban init
Is used to create a new kanban board i.e. it asks for a name and then creates a pykanban.json
file with a Welcome Task.
On first use, it will also create the pykanban.ini
configfile automatically.
Interact with Tasks/Boards
kanban
This is your main command to interact with your boards and tasks. It also gives the option to show the current settings and adjust them. Adjusting the settings can also be done directly by using the 3rd command which is:
Change Settings
kanban configure
Note
This project has been set up using PyScaffold 4.5. For details and usage information on PyScaffold see https://pyscaffold.org/.
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
Hashes for kanban_python-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 97bd49a8ca37966d9ae82524db91e066afbc8a9a077cadc02b607669c51b1614 |
|
MD5 | 953e9be76d57a49cecf445adb71b2c52 |
|
BLAKE2b-256 | 3daa3586940c0dbf1734c1086524b8db52b7cccd0568c872c294dc978c8d6039 |