i3pystatus

i3pystatus is a (hopefully growing) collection of python scripts for status output compatible to i3status / i3bar of the i3 window manager.

Installation

Note

i3pystatus requires Python 3.2 or newer and is not compatible with Python 2.x. Some modules require additional dependencies documented below (see Modules).

From PyPI package i3pystatus

pip install i3pystatus

Packages for your OS

Arch Linux

Release Notes

Contributors

aaron-lebo
afics
al45tair
Arvedui
cganas
dubwoc
enkore (current maintainer)
gwarf
janoliver (started the project)
jasonmhite
jedrz
jorio
mekanix
micha-a-schmidt
philipdexter
sbrunner
siikamiika
talwrii
tomxtobin
tony
yemu
zzatkin

3.30

text: add cmd_leftclick and cmd_rightclick options
weather: add colorize option
disk: add color and round_size options
mem: add round_size option
mpd: next song on right click
network and wireless: support interfaces enslaved to a bonding master
alsa and pulseaudio: added optional "formated_muted" setting. If provided, it will be used instead of "format" when the audio is muted.
parcel: added support for Itella (Finnish national postal service)
network: detached_down is now True by default
temp: removed color_critical and high_factor options
temp: fixed issue with Linux kernels 3.15 and newer

3.29

network: prefer non link-local v6 addresses
mail: Open email client and refresh email with mouse click
disk: Add display and critical limit
battery: fix errors if CURRENT_NOW is not present
battery: add configurable colors
load: add configurable colors and limit
parcel: rewrote DHL tracker
Add spotify module

3.28

If you're currently using the i3pystatus command to run your i3bar:

Replace i3pystatus command in your i3 configuration with python ~/path/to/your/config.py
Do not name your script i3pystatus.py or it will break imports.
New options for mem
Added cpu\_usage
Improved error handling
Removed i3pystatus binary
pulseaudio: changed context name to "i3pystatus_pulseaudio"
Add maildir backend for mails
Code changes
Removed DHL tracker of parcel module, because it doesn't work anymore.

3.27

Add weather module
Add text module
PulseAudio module: Add muted/unmuted options

3.26

Add mem module

3.24

This release introduced changes that may require manual changes to your configuration file

Introduced TimeWrapper
battery module: removed remaining_* formatters in favor of TimeWrapper, as it can not only reproduce all the variants removed, but can do much more.
mpd: Uses TimeWrapper for song_length, song_elapsed

Configuration

The config file is just a normal Python script.

A simple configuration file could look like this (note the additional dependencies from network, wireless and pulseaudio in this example):

# -*- coding: utf-8 -*-

import subprocess

from i3pystatus import Status

status = Status(standalone=True)

# Displays clock like this:
# Tue 30 Jul 11:59:46 PM KW31
#                          ^-- calendar week
status.register("clock",
    format="%a %-d %b %X KW%V",)

# Shows the average load of the last minute and the last 5 minutes
# (the default value for format is used)
status.register("load")

# Shows your CPU temperature, if you have a Intel CPU
status.register("temp",
    format="{temp:.0f}°C",)

# The battery monitor has many formatting options, see README for details

# This would look like this, when discharging (or charging)
# ↓14.22W 56.15% [77.81%] 2h:41m
# And like this if full:
# =14.22W 100.0% [91.21%]
#
# This would also display a desktop notification (via dbus) if the percentage
# goes below 5 percent while discharging. The block will also color RED.
status.register("battery",
    format="{status}/{consumption:.2f}W {percentage:.2f}% [{percentage_design:.2f}%] {remaining:%E%hh:%Mm}",
    alert=True,
    alert_percentage=5,
    status={
        "DIS": "↓",
        "CHR": "↑",
        "FULL": "=",
    },)

# This would look like this:
# Discharging 6h:51m
status.register("battery",
    format="{status} {remaining:%E%hh:%Mm}",
    alert=True,
    alert_percentage=5,
    status={
        "DIS":  "Discharging",
        "CHR":  "Charging",
        "FULL": "Bat full",
    },)

# Displays whether a DHCP client is running
status.register("runwatch",
    name="DHCP",
    path="/var/run/dhclient*.pid",)

# Shows the address and up/down state of eth0. If it is up the address is shown in
# green (the default value of color_up) and the CIDR-address is shown
# (i.e. 10.10.10.42/24).
# If it's down just the interface name (eth0) will be displayed in red
# (defaults of format_down and color_down)
#
# Note: the network module requires PyPI package netifaces
status.register("network",
    interface="eth0",
    format_up="{v4cidr}",)

# Has all the options of the normal network and adds some wireless specific things
# like quality and network names.
#
# Note: requires both netifaces and basiciw
status.register("wireless",
    interface="wlan0",
    format_up="{essid} {quality:03.0f}%",)

# Shows disk usage of /
# Format:
# 42/128G [86G]
status.register("disk",
    path="/",
    format="{used}/{total}G [{avail}G]",)

# Shows pulseaudio default sink volume
#
# Note: requires libpulseaudio from PyPI
status.register("pulseaudio",
    format="♪{volume}",)

# Shows mpd status
# Format:
# Cloud connected▶Reroute to Remain
status.register("mpd",
    format="{title}{status}{album}",
    status={
        "pause": "▷",
        "play": "▶",
        "stop": "◾",
    },)

status.run()

Also change your i3wm config to the following:

# i3bar
bar {
    status_command    python ~/.path/to/your/config/file.py
    position          top
    workspace_buttons yes
}

Formatting

All modules let you specifiy the exact output formatting using a format string, which gives you a great deal of flexibility.

If a module gives you a float, it probably has a ton of uninteresting decimal places. Use {somefloat:.0f} to get the integer value, {somefloat:0.2f} gives you two decimal places after the decimal dot

formatp

Some modules use an extended format string syntax (the mpd module, for example). Given the format string below the output adapts itself to the available data.

[{artist}/{album}/]{title}{status}

Only if both the artist and album is known they're displayed. If only one or none of them is known the entire group between the brackets is excluded.

"is known" is here defined as "value evaluating to True in Python", i.e. an empty string or 0 (or 0.0) counts as "not known".

Inside a group always all format specifiers must evaluate to true (logical and).

You can nest groups. The inner group will only become part of the output if both the outer group and the inner group are eligible for output.

TimeWrapper

Some modules that output times use TimeWrapper to format these. TimeWrapper is a mere extension of the standard formatting method.

The time format that should be used is specified using the format specifier, i.e. with some_time being 3951 seconds a format string like {some_time:%h:%m:%s} would produce 1:5:51.

%h, %m and %s are the hours, minutes and seconds without leading zeros (i.e. 0 to 59 for minutes and seconds)
%H, %M and %S are padded with a leading zero to two digits, i.e. 00 to 59
%l and %L produce hours non-padded and padded but only if hours is not zero. If the hours are zero it produces an empty string.
%% produces a literal %
%E (only valid on beginning of the string) if the time is null, don't format anything but rather produce an empty string. If the time is non-null it is removed from the string.
When the module in question also uses formatp, 0 seconds counts as "not known".
The formatted time is stripped, i.e. spaces on both ends of the result are removed.

Modules

System: clock - disk - load - mem - cpu\_usage
Audio: alsa - pulseaudio
Hardware: battery - backlight - temp
Network: network - wireless
Other: mail - parcel - pyload - weather - mpd - text
Advanced: file - regex - runwatch

alsa

Shows volume of ALSA mixer. You can also use this for inputs, btw.

Requires pyalsaaudio

Available formatters:

{volume} — the current volume in percent
{muted} — the value of one of the muted or unmuted settings
{card} — the associated soundcard
{mixer} — the associated ALSA mixer

Settings:

format: (default: ♪: {volume})
format_muted: optional format string to use when muted (default: None)
mixer: ALSA mixer (default: Master)
mixer_id: ALSA mixer id (default: 0)
card: ALSA sound card (default: 0)
muted: (default: M)
unmuted: (default: )
color_muted: (default: #AAAAAA)
color: (default: #FFFFFF)
channel: (default: 0)
interval: (default: 1)

backlight

Screen backlight info

Available formatters:

{brightness} — current brightness relative to max_brightness
{max_brightness} — maximum brightness value
{percentage} — current brightness in percent

Settings:

format: format string, formatters: brightness, max_brightness, percentage (default: {brightness}/{max_brightness})
backlight: backlight, see /sys/class/backlight/ (default: acpi_video0)
color: (default: #FFFFFF)
interval: (default: 5)

battery

This class uses the /sys/class/power_supply/…/uevent interface to check for the battery status

Available formatters:

{remaining} — remaining time for charging or discharging, uses TimeWrapper formatting, default format is %E%h:%M
{percentage} — battery percentage relative to the last full value
{percentage_design} — absolute battery charge percentage
{consumption (Watts)} — current power flowing into/out of the battery
{status}
{battery_ident} — the same as the setting

Settings:

battery_ident: The name of your battery, usually BAT0 or BAT1 (default: BAT0)
format: (default: {status} {remaining})
alert: Display a libnotify-notification on low battery (default: False)
alert_percentage: (default: 10)
alert_format_title: The title of the notification, all formatters can be used (default: Low battery)
alert_format_body: The body text of the notification, all formatters can be used (default: Battery {battery_ident} has only {percentage:.2f}% ({remaining:%E%hh:%Mm}) remaining!)
path: Override the default-generated path (default: None)
status: A dictionary mapping ('DIS', 'CHR', 'FULL') to alternative names (default: {'DIS': 'DIS', 'FULL': 'FULL', 'CHR': 'CHR'})
color: The text color (default: #ffffff)
critical_color: The critical color (default: #ff0000)
interval: (default: 5)

clock

This class shows a clock

Settings:

format: stftime format string, None means to use the default, locale-dependent format (default: None)
color: RGB hexadecimal code color specifier, default to #ffffff, set to i3Bar to use i3 bar default (default: #ffffff)
interval: (default: 1)

cpu_usage

Shows CPU usage. The first output will be inacurate Linux only

Available formatters:

{usage}

Settings:

format: format string (default: {usage:02}%)
interval: (default: 5)

disk

Gets {used}, {free}, {available} and {total} amount of bytes on the given mounted filesystem.

These values can also be expressed as percentages with the {percentage_used}, {percentage_free} and {percentage_avail} formats.

Settings:

format: (default: {free}/{avail})
path: (required)
divisor: divide all byte values by this value, default is 1024**3 (gigabyte) (default: 1073741824)
display_limit: if more space is available than this limit the module is hidden (default: inf)
critical_limit: critical space limit (see critical_color) (default: 0)
critical_color: the critical color (default: #FF0000)
color: the common color (default: #FFFFFF)
round_size: precision, None for INT (default: 2)
interval: (default: 5)

file

Rip information from text files

components is a dict of pairs of the form:

name => (callable, file)

Where name is a valid identifier, which is used in the format string to access the value of that component.
callable is some callable to convert the contents of file. A common choice is float or int.
file names a file, relative to base_path.

transforms is a optional dict of callables taking a single argument (a dictionary containing the values of all components). The return value is bound to the key.

Settings:

format: (required)
components: (required)
transforms: (default: {})
base_path: (default: /)
color: (default: #FFFFFF)
interval: (default: 5)

load

Shows system load

Settings:

format: format string used for output. {avg1}, {avg5} and {avg15} are the load average of the last one, five and fifteen minutes, respectively. {tasks} is the number of tasks (i.e. 1/285, which indiciates that one out of 285 total tasks is runnable). (default: {avg1} {avg5})
color: The text color (default: #ffffff)
critical_limit: Limit above which the load is considered critical (default: 1)
critical_color: The critical color (default: #ff0000)
interval: (default: 5)

mail

Generic mail checker

The backends setting determines the backends to use.

Settings:

backends: List of backends (instances of i3pystatus.mail.xxx.zzz, i.e. i3pystatus.mail.imap.IMAP)
color: (default: #ffffff)
color_unread: (default: #ff0000)
format: (default: {unread} new email)
format_plural: (default: {unread} new emails)
hide_if_null: Don't output anything if there are no new mails (default: True)
email_client: The email client to open on left click (default: None)
interval: (default: 5)

imap.IMAP

Checks for mail on a IMAP server

Settings:

host: (required)
port: (default: 993)
username: (required)
password: (required)
ssl: (default: True)
mailbox: (default: INBOX)

maildir.MaildirMail

Checks for local mail in Maildir

Settings:

directory: (required)

mbox.MboxMail

Checks for local mail in mbox

Settings:

notmuchmail.Notmuch

This class uses the notmuch python bindings to check for the number of messages in the notmuch database with the tags "inbox" and "unread"

Settings:

db_path: (required)

thunderbird.Thunderbird

This class listens for dbus signals emitted by the dbus-sender extension for thunderbird.

Requires python-dbus

Settings:

mem

Shows memory load

Available formatters:

{avail_mem}
{percent_used_mem}
{used_mem}
{total_mem}

Requires psutil (from PyPI)

Settings:

format: format string used for output. (default: {avail_mem} MiB)
divisor: divide all byte values by this value, default 1024**2(mebibytes (default: 1048576)
warn_percentage: minimal percentage for warn state (default: 50)
alert_percentage: minimal percentage for alert state (default: 80)
color: standard color (default: #00FF00)
warn_color: defines the color used wann warn percentage ist exceeded (default: #FFFF00)
alert_color: defines the color used when alert percentage is exceeded (default: #FF0000)
round_size: defines number of digits in round (default: 1)
interval: (default: 5)

modsde

This class returns i3status parsable output of the number of unread posts in any bookmark in the mods.de forums.

Settings:

format: Use {unread} as the formatter for number of unread posts (default: {unread} new posts in bookmarks)
offset: subtract number of posts before output (default: 0)
color: (default: #7181fe)
username: (required)
password: (required)
interval: (default: 5)

mpd

Displays various information from MPD (the music player daemon)

Available formatters (uses formatp)

{title} — (the title of the current song)
{album} — (the album of the current song, can be an empty string (e.g. for online streams))
{artist} — (can be empty, too)
{song_elapsed} — (Position in the currently playing song, uses TimeWrapper, default is %m:%S)
{song_length} — (Length of the current song, same as song_elapsed)
{pos} — (Position of current song in playlist, one-based)
{len} — (Songs in playlist)
{status} — (play, pause, stop mapped through the status dictionary)
{bitrate} — (Current bitrate in kilobit/s)
{volume} — (Volume set in MPD)

Left click on the module play/pauses, right click (un)mutes.

Settings:

host: (default: localhost)
port: MPD port (default: 6600)
format: formatp string (default: {title} {status})
status: Dictionary mapping pause, play and stop to output (default: {'play': '▶', 'stop': '◾', 'pause': '▷'})
interval: (default: 1)

network

Display network information about a interface.

Requires the PyPI package netifaces.

Available formatters:

{interface} — same as setting
{name} — same as setting
{v4} — IPv4 address
{v4mask} — subnet mask
{v4cidr} — IPv4 address in cidr notation (i.e. 192.168.2.204/24)
{v6} — IPv6 address
{v6mask} — subnet mask
{v6cidr} — IPv6 address in cidr notation
{mac} — MAC of interface

Not available addresses (i.e. no IPv6 connectivity) are replaced with empty strings.

Settings:

interface: Interface to obtain information for (default: eth0)
format_up: (default: {interface}: {v4})
color_up: (default: #00FF00)
format_down: (default: {interface})
color_down: (default: #FF0000)
detached_down: If the interface doesn't exist, display it as if it were down (default: True)
name: (default: eth0)
interval: (default: 5)

parcel

Used to track parcel/shipments.

Supported carriers: DHL, UPS, Itella

parcel.UPS("<id_code>")
parcel.DHL("<id_code>")
parcel.Itella("<id_code>"[, "en""sv"]) Second parameter is language. Requires beautiful soup 4 (bs4)

Settings:

instance: Tracker instance, for example parcel.UPS('your_id_code')
format: (default: {name}:{progress})
name
interval: (default: 60)

pulseaudio

Shows volume of default PulseAudio sink (output).

Available formatters:

{volume} — volume in percent (0...100)
{db} — volume in decibels relative to 100 %, i.e. 100 % = 0 dB, 50 % = -18 dB, 0 % = -infinity dB (the literal value for -infinity is -∞)
{muted} — the value of one of the muted or unmuted settings

Settings:

format: (default: ♪: {volume})
format_muted: optional format string to use when muted (default: None)
muted: (default: M)
unmuted: (default: )

pyload

Shows pyLoad status

Available formatters:

{captcha} (see captcha_true and captcha_false, which are the values filled in for this formatter)
{progress} (average over all running downloads)
{progress_all} (percentage of completed files/links in queue)
{speed} (kilobytes/s)
{download} (downloads enabled, also see download_true and download_false)
{total} (number of downloads)
{free_space} (free space in download directory in gigabytes)

Settings:

address: Address of pyLoad webinterface (default: http://127.0.0.1:8000)
format: (default: {captcha} {progress_all:.1f}% {speed:.1f} kb/s)
captcha_true: (default: Captcha waiting)
captcha_false: (default: )
download_true: (default: Downloads enabled)
download_false: (default: Downloads disabled)
username: (required)
password: (required)
interval: (default: 5)

regex

Simple regex file watcher

The groups of the regex are passed to the format string as positional arguments.

Settings:

format: format string used for output (default: {0})
regex: (required)
file: file to search for regex matches
flags: Python.re flags (default: 0)
interval: (default: 5)

runwatch

Expands the given path using glob to a pidfile and checks if the process ID found inside is valid (that is, if the process is running). You can use this to check if a specific application, such as a VPN client or your DHCP client is running.

Available formatters are {pid} and {name}.

Settings:

format_up: (default: {name})
format_down: (default: {name})
color_up: (default: #00FF00)
color_down: (default: #FF0000)
path: (required)
name: (required)
interval: (default: 5)

spotify

This class shows information from Spotify.

Left click will toggle pause/play of the current song. Right click will skip the song.

Dependent on Playerctl ( https://github.com/acrisci/playerctl ) and GLib

Settings:

format: Format string. {artist}, {title}, {album}, {volume}, and {length} are available for output. (default: {artist} - {title})
color: color of the output (default: #ffffff)

temp

Shows CPU temperature of Intel processors

AMD is currently not supported as they can only report a relative temperature, which is pretty useless

Settings:

format: format string used for output. {temp} is the temperature in degrees celsius (default: {temp} °C)
color: (default: #FFFFFF)
interval: (default: 5)

text

Display static, colored text.

Settings:

text: (required)
color: HTML color code #RRGGBB (default: None)
cmd_leftclick: Shell command to execute on left click (default: test)
cmd_rightclick: Shell command to execute on right click (default: test)

weather

This module gets the weather from weather.com using pywapi module First, you need to get the code for the location from the www.weather.com Available formatters:

{current_temp}
{humidity}

Requires pywapi from PyPI.

Settings:

location_code: (required)
colorize: Enable color with temperature and UTF-8 icons. (default: False)
units: Celsius (metric) or Fahrenheit (imperial) (default: metric)
format: (default: {current_temp})
interval: (default: 20)

wireless

Display network information about a interface.

Requires the PyPI packages netifaces and basiciw.

This is based on the network module, so all options and formatters are the same, except for these additional formatters and that detached_down doesn't work.

{essid} — ESSID of currently connected wifi
{freq} — Current frequency
{quality} — Link quality in percent

Settings:

interface: Interface to obtain information for (default: wlan0)
format_up: (default: {interface}: {v4})
color_up: (default: #00FF00)
format_down: (default: {interface})
color_down: (default: #FF0000)
detached_down: If the interface doesn't exist, display it as if it were down (default: True)
name: (default: eth0)
interval: (default: 5)

Contribute

To contribute a module, make sure it uses one of the Module classes. Most modules use IntervalModule, which just calls a function repeatedly in a specified interval.

The output attribute should be set to a dictionary which represents your modules output, the protocol is documented here.

To update this readme run python -m i3pystatus.mkdocs in the repository root and you're done :)

Developer documentation is available in the source code and here.

Patches and pull requests are very welcome :-)

Name		Name	Last commit message	Last commit date
Latest commit History 480 Commits
.idea		.idea
docs		docs
i3pystatus		i3pystatus
tests		tests
.gitignore		.gitignore
.travis.yml		.travis.yml
MIT-LICENSE		MIT-LICENSE
README.rst		README.rst
README.tpl.rst		README.tpl.rst
requirements.txt		requirements.txt
setup.py		setup.py

License

emilecaron/i3pystatus

Folders and files

Latest commit

History

Repository files navigation

i3pystatus

Installation

From PyPI package i3pystatus

Packages for your OS

Release Notes

Contributors

next

3.30

3.29

3.28

3.27

3.26

3.24

Configuration

Formatting

formatp

TimeWrapper

Modules

alsa

backlight

battery

clock

cpu_usage

disk

file

load

mail

imap.IMAP

maildir.MaildirMail

mbox.MboxMail

notmuchmail.Notmuch

thunderbird.Thunderbird

mem

modsde

mpd

network

parcel

pulseaudio

pyload

regex

runwatch

spotify

temp

text

weather

wireless

Contribute

About

Resources

License

Stars

Watchers

Forks

Languages