kanban-python 0.1.3

Terminal Kanban App written in Python

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 a .kanban-python folder in your Home-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 manually 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, based on the moments when you update the task status. The initial Task structure on creation looks as follows:

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 of any command, the pykanban.ini configfile and the .kanban-python folder will be created 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:

Use Ctrl-C to exit the application at any time. :warning: If you exit in the middle of creating/updating a task, or changing settings, your progress wont be saved.

Change Settings

kanban configure

To create a new custom Columns, you have to edit the pykanban.ini manually and add a new columnname + visibility status under the settings.columns.visible section.

Feedback and Issues

Feel free to reach out and share your feedback, or open an Issue, if something doesnt work as expected.

Note

This project has been set up using PyScaffold 4.5. For details and usage information on PyScaffold see https://pyscaffold.org/.