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

• Release Notes
• Configuration
• Modules
• Contribute

pip install i3pystatus

• Arch Linux

• aaron-lebo
• afics
• al45tair
• Argish42
• Arvedui
• atalax
• cganas
• crwood
• dubwoc
• enkore (current maintainer)
• gwarf
• janoliver (former maintainer)
• jasonmhite
• jedrz
• jorio
• mekanix
• Mic92
• micha-a-schmidt
• naglis
• philipdexter
• sbrunner
• siikamiika
• talwrii
• tomkenmag
• tomxtobin
• tony
• yemu
• zzatkin

• Added uptime module
• cpu_usage: Add multicore support
• cpu_usage_bar: Add multicore support

• Added bitcoin module
• Added now_playing module
• Added reddit module
• Added shell module
• Core: fixed custom statusline colors not working properly (see issue #74)
• alsa and pulseaudio: added optional "formated_muted" audio is muted.
• battery: add bar formatter, add not_present_text, full_color, charging_color, not_present_color settings
• disk: add color and round_size options
• maildir: use os.listdir instead of ls
• mem: add round_size option
• mpd: add color setting
• mpd: add filename formatter
• mpd: next song on right click
• network and wireless: support interfaces enslaved to a bonding master
• network: detached_down is now True by default
• network: fixed some issues with interface up/down detection
• parcel: added support for Itella (Finnish national postal service) setting. If provided, it will be used instead of "format" when the
• temp: add file setting
• temp: fixed issue with Linux kernels 3.15 and newer
• temp: removed color_critical and high_factor options
• text: add cmd_leftclick and cmd_rightclick options
• weather: add colorize option
• wireless: Add quality_bar formatter

• 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

• 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.

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

• Add mem module

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

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
}

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

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.

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.

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:

Screen backlight info

Available formatters:

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

Settings:

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
• {bar} —bar displaying the percentage graphically

Settings:

This module fetches and displays current Bitcoin market prices and optionally monitors transactions to and from a list of user-specified wallet addresses. Market data is pulled from the BitcoinAverage Price Index API <https://bitcoinaverage.com> while transaction data is pulled from blockchain.info <https://blockchain.info/api/blockchain_api>.

Available formatters:

• {last_price}
• {ask_price}
• {bid_price}
• {daily_average}
• {volume}
• {status}
• {last_tx_type}
• {last_tx_addr}
• {last_tx_value}
• {balance_btc}
• {balance_fiat}

Settings:

This class shows a clock

Settings:

Shows CPU usage. The first output will be inacurate.

Linux only

Available formatters:

• {usage} usage average of all cores
• {usage_cpu*} usage of one specific core. replace "*" by core number starting at 0
• {usage_all} usage of all cores separate. usess natsort when available(relevant for more than 10 cores)

Settings:

Shows CPU usage as a bar (made with unicode box characters). The first output will be inacurate.

Linux only

Available formatters:

• {usage_bar} usage average of all cores
• {usage_bar_cpu*} usage of one specific core. replace "*"

by core number starting at 0

Settings:

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:

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:

Shows system load

Settings:

Generic mail checker

The backends setting determines the backends to use.

Settings:

Checks for mail on a IMAP server

Settings:

Checks for local mail in Maildir

Settings:

Checks for local mail in mbox

Settings:

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:

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

Requires python-dbus

Settings:

Shows memory load

Available formatters:

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

Requires psutil (from PyPI)

Settings:

Shows memory load as a bar.

Available formatters: * {used_mem_bar}

Requires psutil (from PyPI)

Settings:

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

Settings:

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)
• {filename} — (file name with out extension and path; empty unless title is empty)
• {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:

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:

Shows currently playing track information, supports most media players

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)
• {filename} — (file name with out extension and path; empty unless title is empty)
• {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)
• {status} — (play, pause, stop mapped through the status dictionary)
• {volume} — (Volume)

Left click on the module play/pauses, right click goes to the next track.

Requires python-dbus available from every distros' package manager.

Settings:

Used to track parcel/shipments.

Supported carriers: DHL, UPS, Itella

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

Settings:

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:

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:

This module fetches and displays posts and/or user mail/messages from reddit.com. Left-clicking on the display text opens the permalink/comments page using webbrowser.open() while right-clicking opens the URL of the submission directly. Depends on the Python Reddit API Wrapper (PRAW) <https://github.com/praw-dev/praw>.

Available formatters:

• {submission_title}
• {submission_author}
• {submission_points}
• {submission_comments}
• {submission_permalink}
• {submission_url}
• {submission_domain}
• {submission_subreddit}
• {message_unread}
• {message_author}
• {message_subject}
• {message_body}

Settings:

Simple regex file watcher

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

Settings:

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:

Shows output of shell command

Settings:

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:

Shows CPU temperature of Intel processors

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

Settings:

Display static, colored text.

Settings:

Outputs Uptime

Settings:

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}
• {current_wind}
• {humidity}

Requires pywapi from PyPI.

Settings:

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
• {quality_bar} —Bar graphically representing link quality

Settings:

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 :-)