/py3status-modules

Collection of modules for py3status

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

py3status-modules

Documentation status

Collection of modules for py3status.

dependencies

  • python (>=3.2)
  • py3status (>=2.0)
  • task (>=2.1.2) taskstatus
  • python-mpd (>=0.5.1) mpdstatus
  • upower (>=0.9.23) batterystatus
  • dbus-python (>=1.2.0) batterystatus
  • alsa-utils (>=1.0.28) alsastatus

modules

  • mailstatus shows the number of unread mails in your mailboxes. Currently only suports Maildir format.
  • taskstatus shows open Taskwarrior tasks. If you have overdue tasks it also displays the number of overdue tasks and changes color.
  • mpdstatus connects to MPD and shows the currently playing song. Left click will go to the previous song, right click will jump to the next song and middle click will pause playback.
  • batterystatus shows the status of your battery as reported by upower. For upower support batterystatus uses slightly modified code of the batti project.
  • alsastatus shows the current volume of a configurable ALSA mixer. Also, middle click will mute/unmute said mixer.

configuration

Since py3status-modules 0.3.0 you can configure each module directly in your i3status.conf.

See the configuration section of py3status-modules' documentation for an explanation and examples.

documentation

You can find detailed documentation at py3status-modules' Read the Docs page, powered by Sphinx.

tests

Tests have been written using pytest. Personally I'd recommend installing pytest, coverage and tox and then running the tests via tox:

$ tox

Which should print a nice coverage report if everything goes well.