Skip to main content

Powerline segments for showing information from the Taskwarrior task manager

Project description

Powerline Taskwarrior

CI PyPI PyPI

A set of Powerline segments for showing information retrieved from Taskwarrior task manager.

It shows a current context and the most urgent active task.

screenshot

Requirements

Taskwarrior segments require task v2.4.2 or later.

Installation

PIP

pip install --user -U powerline-taskwarrior

It can also be installed system-wide, but this is usually a bad idea.

Debian

On Debian (testing or unstable), installation can be performed with apt:

apt install python-powerline-taskwarrior

Usage

Activate segments

To activate Taskwarrior segments add them to your segment configuration. See more about powerline configuration in the official documentation. For example, I store powerline configuration in ~/.config/powerline/themes/shell/default.json.

These are available powerline-taskwarrior segments:

  • display current context name

    {
        "function": "powerline_taskwarrior.context",
        "priority": 70
    }
    
  • display the count of pending tasks

    {
        "function": "powerline_taskwarrior.pending_tasks_count",
        "priority": 70
    }
    
  • display the most urgent active task

    {
        "function": "powerline_taskwarrior.active_task",
        "priority": 70
    }
    
  • display the most urgent next task

    {
        "function": "powerline_taskwarrior.next_task",
        "priority": 70
    }
    
  • obsolete segment displays both of listed above

    {
        "function": "powerline_taskwarrior.taskwarrior",
        "priority": 70
    }
    

Color scheme

Taskwarrior-powerline requires custom colorscheme to be configured. Add the following to your colorschemes (.config/powerline/colorschemes/default.json):

{
  "groups": {
    "taskwarrior:context": "information:regular",
    "taskwarrior:pending_tasks_count": "information:priority",
    "taskwarrior:active_id": { "bg": "mediumgreen", "fg": "black", "attrs": [] },
    "taskwarrior:active_desc": { "bg": "green", "fg": "black", "attrs": [] },
    "taskwarrior:next_id": { "bg": "brightyellow", "fg": "black", "attrs": [] },
    "taskwarrior:next_desc": { "bg": "yellow", "fg": "black", "attrs": [] }
  }
}

And here you can configure the colors.

See powerline colorschemes docs for more details.

Further customization

If you have a custom name for task command, it should be specified in the segment configuration.

powerline_taskwarrior.active_task and powerline_taskwarrior.next_task segments accept description_length parameter. It is an integer which represents a maximum length of the description field. If a description is longer than description_length, it is truncated by words.

powerline_taskwarrior.next_task segment accepts ignore_active parameter. If it set to true, the segment will be shown always, regardless of existence of an active task.

{
    "function": "powerline_taskwarrior.next_task",
    "priority": 70,
    "args": {
        "task": "taskwarrior",
        "description_length": 40
    }
}

License

Licensed under the MIT License.

By German Lashevich.

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

powerline-taskwarrior-1.0.1.tar.gz (5.4 kB view hashes)

Uploaded Source

Built Distribution

powerline_taskwarrior-1.0.1-py2.py3-none-any.whl (5.5 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page