Module reference

Module overview:

System:clock - cpu_freq - cpu_usage - disk - keyboard_locks - load - mem - uname - uptime - xkblayout
Audio:alsa - pulseaudio
Hardware:backlight - battery - temp
Network:net_speed - network - online - openstack_vms - openvpn
Music:cmus - mpd - now_playing - pianobar - spotify
Websites:bitcoin - dota2wins - github - modsde - parcel - reddit - weather - whosonlocation
Other:anybar - mail - pomodoro - pyload - text - updates
Advanced:file - regex - makewatch - runwatch - shell

Module list:

class i3pystatus.alsa.ALSA[source]

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 (default: empty) – optional format string to use when muted
  • mixer (default: Master) – ALSA mixer
  • mixer_id (default: 0) – ALSA mixer id
  • card (default: 0) – ALSA sound card
  • increment (default: 5) – integer percentage of max volume to in/decrement volume on mousewheel
  • muted (default: M)
  • unmuted (default: empty)
  • color_muted (default: #AAAAAA)
  • color (default: #FFFFFF)
  • channel (default: 0)
  • map_volume (default: False) – volume display/setting as in AlsaMixer. increment option is ignored then.
  • interval (default: 1) – interval in seconds between module updates
  • on_leftclick (default: switch_mute) – Callback called on left click (see Callbacks)
  • on_rightclick (default: switch_mute) – Callback called on right click (see Callbacks)
  • on_upscroll (default: increase_volume) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: decrease_volume) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.anybar.AnyBar[source]

This module shows dot with given color in your panel. What color means is up to you. When to change color is also up to you. It’s a port of https://github.com/tonsky/AnyBar to i3pystatus. Color can be changed by sending text to UDP port. Check the original repo how to do it.

Settings

  • port (default: 1738) – UDP port to listen
  • color (default: #444444) – initial color
  • interval (default: 1) – interval in seconds between module updates
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: empty) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: empty) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
main_loop()[source]

Mainloop blocks so we thread it.

class i3pystatus.backlight.Backlight[source]

Screen backlight info

  • (Optional) requires xbacklight to change the backlight brightness with the scollwheel.

Available formatters

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

Settings

  • format (default: {brightness}/{max_brightness}) – format string, formatters: brightness, max_brightness, percentage
  • backlight (default: acpi_video0) – backlight, see /sys/class/backlight/
  • color (default: #FFFFFF)
  • components (default: {'max_brightness': (<class 'int'>, 'max_brightness'), 'brightness': (<class 'int'>, 'brightness')})
  • transforms (default: {'percentage': <function Backlight.<lambda> at 0x7f260558c378>})
  • base_path (default: /sys/class/backlight/{backlight}/)
  • interval (default: 5)
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: lighter) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: darker) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.battery.BatteryChecker[source]

This class uses the /sys/class/power_supply/…/uevent interface to check for the battery status It provides the “ALL” battery_ident which will summarise all available batteries for the moment and aggregate the % as well as the time remaining on the charge.

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}
  • {no_of_batteries} — The number of batteries included
  • {battery_ident} — the same as the setting
  • {bar} —bar displaying the relative percentage graphically
  • {bar_design} —bar displaying the absolute percentage graphically

Settings

  • battery_ident (default: ALL) – The name of your battery, usually BAT0 or BAT1
  • format (default: {status} {remaining})
  • not_present_text (default: Battery {battery_ident} not present) – Text displayed if the battery is not present. No formatters are available
  • alert (default: False) – Display a libnotify-notification on low battery
  • critical_level_command (default: empty) – Runs a shell command in the case of a critical power state
  • critical_level_percentage (default: 1)
  • alert_percentage (default: 10)
  • alert_format_title (default: Low battery) – The title of the notification, all formatters can be used
  • alert_format_body (default: Battery {battery_ident} has only {percentage:.2f}% ({remaining:%E%hh:%Mm}) remaining!) – The body text of the notification, all formatters can be used
  • path (default: empty) – Override the default-generated path and specify the full path for a single battery
  • base_path (default: /sys/class/power_supply) – Override the default base path for searching for batteries
  • battery_prefix (default: BAT) – Override the default battery prefix
  • status (default: {'DIS': 'DIS', 'CHR': 'CHR', 'FULL': 'FULL', 'DPL': 'DPL'}) – A dictionary mapping (‘DPL’, ‘DIS’, ‘CHR’, ‘FULL’) to alternative names
  • color (default: #ffffff) – The text color
  • full_color (default: #00ff00) – The full color
  • charging_color (default: #00ff00) – The charging color
  • critical_color (default: #ff0000) – The critical color
  • not_present_color (default: #ffffff) – The not present color.
  • no_text_full (default: False) – Don’t display text when battery is full - 100%
  • interval (default: 5) – interval in seconds between module updates
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: empty) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: empty) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.bitcoin.Bitcoin[source]

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}
  • {symbol}

Settings

  • format (default: {symbol} {status}{last_price}) – Format string used for output.
  • currency (default: USD) – Base fiat currency used for pricing.
  • wallet_addresses (default: empty) – List of wallet address(es) to monitor.
  • color (default: #FFFFFF) – Standard color
  • colorize (default: False) – Enable color change on price increase/decrease
  • color_up (default: #00FF00) – Color for price increases
  • color_down (default: #FF0000) – Color for price decreases
  • interval (default: 600) – Update interval.
  • symbol (default: ฿) – Symbol for bitcoin sign
  • status (default: {'price_down': '▼', 'price_up': '▲'})
  • on_leftclick (default: electrum) – Callback called on left click (see Callbacks)
  • on_rightclick (default: [<function user_open at 0x7f2606c069d8>, 'https://bitcoinaverage.com/']) – Callback called on right click (see Callbacks)
  • on_upscroll (default: empty) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: empty) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.clock.Clock[source]

This class shows a clock.

format can be passed in four different ways:

  • single string, no timezone, just the strftime-format
  • one two-tuple, first is the format, second the timezone
  • list of strings - no timezones
  • list of two tuples, first is the format, second is timezone

Use mousewheel to cycle between formats.

For complete time format specification see:

man strftime

All available timezones are located in directory:

/usr/share/zoneinfo/

Format examples

# one format, local timezone
format = '%a %b %-d %b %X'
# multiple formats, local timezone
format = [ '%a %b %-d %b %X', '%X' ]
# one format, specified timezone
format = ('%a %b %-d %b %X', 'Europe/Bratislava')
# multiple formats, specified timezones
format = [ ('%a %b %-d %b %X', 'America/New_York'), ('%X', 'Etc/GMT+9') ]

Settings

  • format (default: empty) – None means to use the default, locale-dependent format.
  • color (default: #ffffff) – RGB hexadecimal code color specifier, default to #ffffff
  • interval (default: 1) – interval in seconds between module updates
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: ['scroll_format', 1]) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: ['scroll_format', -1]) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.cmus.Cmus[source]

Gets the status and current song info using cmus-remote

Available formatters

  • {status} — current status icon (paused/playing/stopped)
  • {song_elapsed} — song elapsed time (mm:ss format)
  • {song_length} — total song duration (mm:ss format)
  • {artist} — artist
  • {title} — title
  • {album} — album
  • {tracknumber} — tracknumber
  • {file} — file or url name
  • {stream} — song name from stream
  • {bitrate} — bitrate

Settings

  • format (default: {status} {song_elapsed}/{song_length} {artist} - {title}) – formatp string
  • format_not_running (default: Not running) – Text to show if cmus is not running
  • color (default: #ffffff) – The color of the text
  • color_not_running (default: #ffffff) – The color of the text, when cmus is not running
  • status (default: {'playing': '▶', 'paused': '▷', 'stopped': '◾'}) – Dictionary mapping status to output
  • interval (default: 1) – interval in seconds between module updates
  • on_leftclick (default: playpause) – Callback called on left click (see Callbacks)
  • on_rightclick (default: next_song) – Callback called on right click (see Callbacks)
  • on_upscroll (default: next_song) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: previous_song) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.cpu_freq.CpuFreq[source]

class uses by default /proc/cpuinfo to determine the current cpu frequency

Available formatters

  • {avg} - mean from all cores in MHz 4.3f
  • {avgg} - mean from all cores in GHz 1.2f
  • {coreX} - frequency of core number X in MHz (format 4.3f), where 0 <= X <= number of cores - 1
  • {coreXg} - frequency of core number X in GHz (fromat 1.2f), where 0 <= X <= number of cores - 1

Settings

  • format (default: {avgg})
  • color (default: #FFFFFF) – The text color
  • file (default: /proc/cpuinfo) – override default path
  • interval (default: 5) – interval in seconds between module updates
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: empty) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: empty) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
createvaluesdict()[source]

function processes the /proc/cpuinfo file :return: dictionary used as the full-text output for the module

class i3pystatus.cpu_usage.CpuUsage[source]

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

  • format (default: {usage:02}%) – format string.
  • format_all (default: {core}:{usage:02}%) – format string used for {usage_all} per core. Available formaters are {core} and {usage}.
  • exclude_average (default: False) – If True usage average of all cores will not be in format_all.
  • color (default: empty) – HTML color code #RRGGBB
  • interval (default: 1) – interval in seconds between module updates
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: empty) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: empty) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
calculate_usage(cpu, total, busy)[source]

calculates usage

gen_format_all(usage)[source]

generates string for format all

get_cpu_timings()[source]

reads and parses /proc/stat returns dictionary with all available cores including global average

get_usage()[source]

parses /proc/stat and calcualtes total and busy time (more specific USER_HZ see man 5 proc for further informations )

class i3pystatus.cpu_usage_bar.CpuUsageBar[source]

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

Linux only

Requires the PyPI package colour.

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

  • format (default: {usage_bar}) – format string
  • bar_type (default: horizontal) – whether the bar should be vertical or horizontal. Allowed values: vertical or horizontal
  • cpu (default: usage_cpu) – cpu to base the colors on. Choices are ‘usage_cpu’ for all or ‘usage_cpu*’. Replace ‘*’ by core number starting at 0.
  • start_color (default: #00FF00) – Hex or English name for start of color range, eg ‘#00FF00’ or ‘green’
  • end_color (default: red) – Hex or English name for end of color range, eg ‘#FF0000’ or ‘red’
  • format_all (default: {core}:{usage:02}%) – format string used for {usage_all} per core. Available formaters are {core} and {usage}.
  • exclude_average (default: False) – If True usage average of all cores will not be in format_all.
  • color (default: empty) – HTML color code #RRGGBB
  • interval (default: 1) – interval in seconds between module updates
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: empty) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: empty) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.cpu_usage_graph.CpuUsageGraph[source]

Shows CPU usage as a Unicode graph. The first output will be inacurate.

Depends on the PyPI colour module - https://pypi.python.org/pypi/colour/0.0.5

Linux only

Available formatters

  • {cpu_graph} — graph of cpu usage.
  • {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

  • cpu (default: usage_cpu) – cpu to monitor, choices are ‘usage_cpu’ for all or ‘usage_cpu*’. Replace ‘*’ by core number starting at 0.
  • start_color (default: #00FF00) – Hex or English name for start of color range, eg ‘#00FF00’ or ‘green’
  • end_color (default: red) – Hex or English name for end of color range, eg ‘#FF0000’ or ‘red’
  • graph_width (default: 15) – Width of the cpu usage graph
  • graph_style (default: blocks) – Graph style (‘blocks’, ‘braille-fill’, ‘braille-peak’, or ‘braille-snake’)
  • format (default: {cpu_graph}) – format string.
  • format_all (default: {core}:{usage:02}%) – format string used for {usage_all} per core. Available formaters are {core} and {usage}.
  • exclude_average (default: False) – If True usage average of all cores will not be in format_all.
  • color (default: empty) – HTML color code #RRGGBB
  • interval (default: 1) – interval in seconds between module updates
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: empty) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: empty) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.disk.Disk[source]

Gets {used}, {free}, {avail} 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 (default: 1073741824) – divide all byte values by this value, default is 1024**3 (gigabyte)
  • display_limit (default: inf) – if more space is available than this limit the module is hidden
  • critical_limit (default: 0) – critical space limit (see critical_color)
  • critical_color (default: #FF0000) – the critical color
  • color (default: #FFFFFF) – the common color
  • round_size (default: 2) – precision, None for INT
  • mounted_only (default: False) – display only if path is a valid mountpoint
  • format_not_mounted (default: empty)
  • color_not_mounted (default: #FFFFFF)
  • interval (default: 5) – interval in seconds between module updates
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: empty) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: empty) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.dota2wins.Dota2wins[source]

Displays the win/loss ratio of a given Dota account. Requires: dota2py

Settings

  • matches (default: 25) – Number of recent matches to calculate
  • steamid (required) – Steam ID or username to track
  • steam_api_key (required) – Steam API key (http://steamcommunity.com/dev/apikey)
  • good_threshold (default: 50) – Win percentage (or higher) which you are happy with
  • bad_threshold (default: 45) – Win percentage you want to be alerted (difference between good_threshold and bad_threshold is cautious_threshold)
  • interval (default: 1800) – Update interval (games usually last at least 20 min).
  • good_color (default: #00FF00) – Color of text while win percentage is above good_threshold
  • bad_color (default: #FF0000) – Color of text while win percentage is below bad_threshold
  • caution_color (default: #FFFF00) – Color of text while win precentage is between good and bad thresholds
  • screenname (default: retrieve) – If set to ‘retrieve’, requests for the users’s screenname via API calls. Else, use the supplied string as the user’s screename
  • format (default: {screenname} {wins}W:{losses}L {win_percent:.2f}%)
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: empty) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: empty) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.dpms.DPMS[source]

Shows and toggles status of DPMS which prevents screen from blanking.

Available formatters

  • {status} — the current status of DPMS

@author Georg Sieber <g.sieber AT gmail.com>

Settings

  • format (default: DPMS: {status})
  • color (default: #FFFFFF)
  • color_disabled (default: #AAAAAA)
  • interval (default: 5) – interval in seconds between module updates
  • on_leftclick (default: toggle_dpms) – Callback called on left click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: empty) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: empty) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.file.File[source]

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)
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: empty) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: empty) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.github.Github[source]

Check Github for pending notifications. Requires requests

Formatters:

  • {unread} — contains the value of unread_marker when there are pending notifications
  • {unread_count} — number of unread notifications, empty if 0

Settings

  • format (default: {unread}) – format string
  • keyring_backend (default: empty) – alternative keyring backend for retrieving credentials
  • unread_marker (default: ) – sets the string that the “unread” formatter shows when there are pending notifications
  • username (default: empty)
  • password (default: empty)
  • color (default: #78EAF2)
  • interval (default: 600) – interval in seconds between module updates
  • on_leftclick (default: open_github) – Callback called on left click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: empty) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: empty) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.gpu_mem.GPUMemory[source]

Shows GPU memory load

Currently Nvidia only and nvidia-smi required

Available formatters

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

Settings

  • format (default: {avail_mem} MiB) – format string used for output.
  • divisor (default: 1) – divide all megabyte values by this value, default is 1 (megabytes)
  • warn_percentage (default: 50) – minimal percentage for warn state
  • alert_percentage (default: 80) – minimal percentage for alert state
  • color (default: #00FF00) – standard color
  • warn_color (default: #FFFF00) – defines the color used wann warn percentage ist exceeded
  • alert_color (default: #FF0000) – defines the color used when alert percentage is exceeded
  • round_size (default: 1) – defines number of digits in round
  • interval (default: 5) – interval in seconds between module updates
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: empty) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: empty) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.gpu_temp.GPUTemperature[source]

Shows GPU temperature

Currently Nvidia only and nvidia-smi required

Available formatters

  • {temp} — the temperature in integer degrees celsius

Settings

  • format (default: {temp} °C) – format string used for output. {temp} is the temperature in integer degrees celsius
  • color (default: #FFFFFF)
  • alert_temp (default: 90)
  • alert_color (default: #FF0000)
  • interval (default: 5) – interval in seconds between module updates
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: empty) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: empty) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.iinet.IINet[source]

Check IINet Internet usage. Requires requests and colour

Formatters:

  • {percentage_used} — percentage of your quota that is used
  • {percentage_available} — percentage of your quota that is available

Settings

  • format (default: {percent_used})
  • username (default: empty) – Username for IINet
  • password (default: empty) – Password for IINet
  • start_color (default: #00FF00) – Beginning color for color range
  • end_color (default: #FF0000) – End color for color range
  • interval (default: 5) – interval in seconds between module updates
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: empty) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: empty) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.keyboard_locks.Keyboard_locks[source]

Shows the status of CAPS LOCK, NUM LOCK and SCROLL LOCK

Available formatters

  • {caps} — the current status of CAPS LOCK
  • {num} — the current status of NUM LOCK
  • {scroll} — the current status of SCROLL LOCK

Settings

  • format (default: {caps} {num} {scroll}) – Format string
  • caps_on (default: CAP) – String to show in {caps} when CAPS LOCK is on
  • caps_off (default: ___) – String to show in {caps} when CAPS LOCK is off
  • num_on (default: NUM) – String to show in {num} when NUM LOCK is on
  • num_off (default: ___) – String to show in {num} when NUM LOCK is off
  • scroll_on (default: SCR) – String to show in {scroll} when SCROLL LOCK is on
  • scroll_off (default: ___) – String to show in {scroll} when SCROLL LOCK is off
  • color (default: #FFFFFF)
  • interval (default: 1) – interval in seconds between module updates
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: empty) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: empty) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.load.Load[source]

Shows system load

Available formatters

  • {avg1} — the load average of the last minute
  • {avg5} — the load average of the last five minutes
  • {avg15} — the load average of the last fifteen minutes
  • {tasks} — the number of tasks (e.g. 1/285, which indiciates that one out of 285 total tasks is runnable)

Settings

  • format (default: {avg1} {avg5})
  • color (default: #ffffff) – The text color
  • critical_limit (default: 4) – Limit above which the load is considered critical, defaults to amount of cores.
  • critical_color (default: #ff0000) – The critical color
  • interval (default: 5) – interval in seconds between module updates
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: empty) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: empty) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.mail.Mail[source]

Generic mail checker

The backends setting determines the backends to use. For available backends see Mail Backends.

Settings

  • backends (required) – List of backends (instances of i3pystatus.mail.xxx.zzz, e.g. imap.IMAP)
  • color (default: #ffffff)
  • color_unread (default: #ff0000)
  • format (default: {unread} new email)
  • format_plural (default: {account} : {current_unread}/{unread} new emails)
  • hide_if_null (default: True) – Don’t output anything if there are no new mails
  • email_client (default: empty) – The command to run on left click. For example, to launch Thunderbird set email_client` to ``thunderbird. Alternatively, to bring Thunderbird into focus, set email_client to i3-msg -q [class="^Thunderbird$"] focus. Hint: To discover the X window class of your email client run ‘xprop | grep -i class’ and click on it’s window
  • interval (default: 5) – interval in seconds between module updates
  • on_leftclick (default: open_client) – Callback called on left click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: ['scroll_backend', 1]) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: ['scroll_backend', -1]) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
run()[source]

Returns the sum of unread messages across all registered backends

class i3pystatus.makewatch.MakeWatch[source]

Watches for make jobs and notifies when they are completed. requires: psutil

Settings

  • name (default: make) – Listen for a job other than ‘make’ jobs
  • running_color (default: #FF0000) – Text color while the job is running
  • idle_color (default: #00FF00) – Text color while the job is not running
  • format (default: {name}: {status})
  • interval (default: 5) – interval in seconds between module updates
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: empty) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: empty) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.mem.Mem[source]

Shows memory load

Available formatters

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

Requires psutil (from PyPI)

Settings

  • format (default: {avail_mem} MiB) – format string used for output.
  • divisor (default: 1048576) – divide all byte values by this value, default is 1024**2 (megabytes)
  • warn_percentage (default: 50) – minimal percentage for warn state
  • alert_percentage (default: 80) – minimal percentage for alert state
  • color (default: #00FF00) – standard color
  • warn_color (default: #FFFF00) – defines the color used wann warn percentage ist exceeded
  • alert_color (default: #FF0000) – defines the color used when alert percentage is exceeded
  • round_size (default: 1) – defines number of digits in round
  • interval (default: 5) – interval in seconds between module updates
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: empty) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: empty) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.mem_bar.MemBar[source]

Shows memory load as a bar.

Available formatters

  • {used_mem_bar}

Requires psutil and colour (from PyPI)

Settings

  • format (default: {used_mem_bar}) – format string used for output.
  • warn_percentage (default: 50) – minimal percentage for warn state
  • alert_percentage (default: 80) – minimal percentage for alert state
  • color (default: #00FF00) – standard color
  • warn_color (default: #FFFF00) – defines the color used wann warn percentage ist exceeded
  • alert_color (default: #FF0000) – defines the color used when alert percentage is exceeded
  • multi_colors (default: False) – whether to use range of colors from ‘color’ to ‘alert_color’ based on memory usage.
  • interval (default: 5) – interval in seconds between module updates
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: empty) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: empty) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.modsde.ModsDeChecker[source]

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

Settings

  • format (default: {unread} new posts in bookmarks) – Use {unread} as the formatter for number of unread posts
  • keyring_backend (default: empty) – alternative keyring backend for retrieving credentials
  • offset (default: 0) – subtract number of posts before output
  • color (default: #7181fe)
  • username (required)
  • password (required)
  • interval (default: 5) – interval in seconds between module updates
  • on_leftclick (default: open_browser) – Callback called on left click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: empty) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: empty) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.moon.MoonPhase[source]

Available Formatters

status: Allows for mapping of current moon phase - New Moon: - Waxing Crescent: - First Quarter: - Waxing Gibbous: - Full Moon: - Waning Gibbous: - Last Quarter: - Waning Crescent:

Settings

  • format (default: {illum} {status})
  • status (default: {'Full Moon': 'FM', 'Last Quarter': 'LQ', 'Waning Crescent': 'WanCres', 'Waxing Crescent': 'WaxCres', 'New Moon': 'NM', 'Waning Gibbous': 'WanGib', 'First Quarter': 'FQ', 'Waxing Gibbous': 'WaxGib'}) – Current moon phase
  • illum (default: <function MoonPhase.illum at 0x7f26054ef730>) – Percentage that is illuminated
  • color (default: {'Full Moon': '#4C00B3', 'Last Quarter': '#C32250', 'Waning Crescent': '#FF341F', 'Waxing Crescent': '#138DD8', 'New Moon': '#00BDE5', 'Waning Gibbous': '#871181', 'First Quarter': '#265ECC', 'Waxing Gibbous': '#392FBF'}) – Set color
  • interval (default: 7200) – interval in seconds between module updates
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: empty) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: empty) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.mpd.MPD[source]

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

  • host (default: localhost)
  • port (default: 6600) – MPD port. If set to 0, host will we interpreted as a Unix socket.
  • format (default: {title} {status}) – formatp string
  • status (default: {'stop': '◾', 'play': '▶', 'pause': '▷'}) – Dictionary mapping pause, play and stop to output
  • color (default: #FFFFFF) – The color of the text
  • max_field_len (default: 25) – Defines max length for in truncate_fields defined fields, if truncated, ellipsis are appended as indicator. It’s applied before max_len. Value of 0 disables this.
  • max_len (default: 100) – Defines max length for the hole string, if exceeding fields specefied in truncate_fields are truncated equaly. If truncated, ellipsis are appended as indicator. It’s applied after max_field_len. Value of 0 disables this.
  • truncate_fields (default: ('title', 'album', 'artist')) – fields that will be truncated if exceeding max_field_len or max_len.
  • hide_inactive (default: False) – Hides status information when MPD is not running
  • interval (default: 1) – interval in seconds between module updates
  • on_leftclick (default: switch_playpause) – Callback called on left click (see Callbacks)
  • on_rightclick (default: next_song) – Callback called on right click (see Callbacks)
  • on_upscroll (default: next_song) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: previous_song) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.net_speed.NetSpeed[source]

Attempts to provide an estimation of internet speeds. Requires: speedtest_cli

Settings

  • url (default: empty) – Target URL to download a file from. Uses speedtest_cli to find the ‘best’ server if none is supplied.
  • units (default: bits) – Valid values are B, b, bytes, or bits
  • format (default: {speed} ({hosting_provider}))
  • interval (default: 300) – interval in seconds between module updates
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: empty) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: empty) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.network.Network[source]

Displays network information for an interface.

Requires the PyPI packages colour, netifaces, psutil (optional, see below) and basiciw (optional, see below).

Available formatters

Network Information Formatters:

  • {interface} — 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

Wireless Information Formatters (requires PyPI package basiciw):

  • {essid} — ESSID of currently connected wifi
  • {freq} — Current frequency
  • {quality} — Link quality in percent
  • {quality_bar} —Bar graphically representing link quality

Network Traffic Formatters (requires PyPI pacakge psutil):

  • {interface} — the configured network interface
  • {kbs} – Float representing kbs
  • {network_graph} – Unicode graph representing network usage
  • {bytes_sent} — bytes sent per second (divided by divisor)
  • {bytes_recv} — bytes received per second (divided by divisor)
  • {packets_sent} — bytes sent per second (divided by divisor)
  • {packets_recv} — bytes received per second (divided by divisor)
  • {rx_tot_Mbytes} — total Mbytes received
  • {tx_tot_Mbytes} — total Mbytes sent

Settings

  • format_up (default: {interface} {network_graph}{kbs}KB/s) – format string
  • format_down (default: {interface}: DOWN) – format string
  • color_up (default: #00FF00)
  • color_down (default: #FF0000)
  • interface (default: eth0) – Interface to watch, eg ‘eth0’
  • dynamic_color (default: True) – Set color dynamically based on network traffic. Note: this overrides color_up
  • start_color (default: #00FF00) – Hex or English name for start of color range, eg ‘#00FF00’ or ‘green’
  • end_color (default: red) – Hex or English name for end of color range, eg ‘#FF0000’ or ‘red’
  • graph_width (default: 15) – Width of the network traffic graph
  • graph_style (default: blocks) – Graph style (‘blocks’, ‘braille-fill’, ‘braille-peak’, or ‘braille-snake’)
  • upper_limit (default: 150.0) – Expected max kb/s. This value controls how the network traffic graph is drawn and in what color
  • graph_type (default: input) – Whether to draw the network traffic graph for input or output. Allowed values ‘input’ or ‘output’
  • divisor (default: 1024) – divide all byte values by this value
  • ignore_interfaces (default: ['lo']) – Array of interfaces to ignore when cycling through on click, eg, [‘lo’]
  • round_size (default: empty) – defines number of digits in round
  • detached_down (default: True) – If the interface doesn’t exist, display it as if it were down
  • unknown_up (default: False) – If the interface is in unknown state, display it as if it were up
  • interval (default: 1) – interval in seconds between module updates
  • on_leftclick (default: nm-connection-editor) – Callback called on left click (see Callbacks)
  • on_rightclick (default: cycle_interface) – Callback called on right click (see Callbacks)
  • on_upscroll (default: ['cycle_interface', 1]) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: ['cycle_interface', -1]) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
cycle_interface(increment=1)[source]

Cycle through available interfaces in increment steps. Sign indicates direction.

class i3pystatus.now_playing.NowPlaying[source]

Shows currently playing track information, supports most media players

  • Requires python-dbus available from every distros’ package manager.

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

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)

Settings

  • player (default: empty) – Player name. If not set, compatible players will be detected automatically.
  • status (default: {'stop': '◾', 'play': '▶', 'pause': '▷'}) – Dictionary mapping pause, play and stop to output text
  • format (default: {title} {status}) – formatp string
  • color (default: #ffffff) – Text color
  • format_no_player (default: No Player) – Text to show if no player is detected
  • color_no_player (default: #ffffff) – Text color when no player is detected
  • hide_no_player (default: True) – Hide output if no player is detected
  • interval (default: 1) – interval in seconds between module updates
  • on_leftclick (default: playpause) – Callback called on left click (see Callbacks)
  • on_rightclick (default: next_song) – Callback called on right click (see Callbacks)
  • on_upscroll (default: empty) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: empty) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.online.Online[source]

Show internet connection status.

Settings

  • color (default: #ffffff) – Text color when online
  • color_offline (default: #ff0000) – Text color when offline
  • format_online (default: online) – Status text when online
  • format_offline (default: offline) – Status text when offline
  • interval (default: 10) – interval in seconds between module updates
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: empty) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: empty) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.openstack_vms.Openstack_vms[source]

Displays the number of VMs in an openstack cluster in ACTIVE and non-ACTIVE states. Requires: python-novaclient

Settings

  • auth_url (required) – OpenStack cluster authentication URL (OS_AUTH_URL)
  • username (required) – Username for OpenStack authentication (OS_USERNAME)
  • password (required) – Password for Openstack authentication (OS_PASSWORD)
  • tenant_name (required) – Tenant/Project name to view (OS_TENANT_NAME)
  • color (default: #00FF00) – Display color when non-active VMs are =< threshold
  • crit_color (default: #FF0000) – Display color when non-active VMs are => threshold
  • threshold (default: 0) – Set critical indicators when non-active VM pass this number
  • horizon_url (default: empty) – When clicked, open this URL in a browser
  • format (default: {tenant_name}: {active_servers} up, {nonactive_servers} down)
  • interval (default: 5) – interval in seconds between module updates
  • on_leftclick (default: openurl) – Callback called on left click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: empty) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: empty) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.openvpn.OpenVPN[source]

Monitor OpenVPN connections. Currently only supports systems that use Systemd.

Formatters:

  • {vpn_name} — Same as setting.
  • {status} — Unicode up or down symbol.
  • {output} — Output of status_command.
  • {label} — Label for this connection, if defined.

Settings

  • format (default: {vpn_name} {status}) – Format string
  • color_up (default: #00ff00) – VPN is up
  • color_down (default: #FF0000) – VPN is down
  • status_down (default: ) – Symbol to display when down
  • status_up (default: ) – Symbol to display when up
  • vpn_name (default: empty) – Name of VPN
  • status_command (default: bash -c "systemctl show openvpn@%(vpn_name)s | grep 'ActiveState=active') – command to find out if the VPN is active
  • interval (default: 5) – interval in seconds between module updates
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: empty) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: empty) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.parcel.ParcelTracker[source]

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)

Requires lxml and cssselect.

Settings

  • instance (required) – Tracker instance, for example parcel.UPS('your_id_code')
  • format (default: {name}:{progress})
  • name (required)
  • interval (default: 60) – interval in seconds between module updates
  • on_leftclick (default: open_browser) – Callback called on left click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: empty) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: empty) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.pianobar.Pianobar[source]

Shows the title and artist name of the current music

In pianobar config file must be setted the fifo and event_command options (see man pianobar for more information)

For the event_cmd use: https://github.com/jlucchese/pianobar/blob/master/contrib/pianobar-song-i3.sh

Mouse events: - Left click play/pauses - Right click plays next song - Scroll up/down changes volume

Settings

  • format (default: {songtitle} -- {songartist})
  • songfile (required) – File generated by pianobar eventcmd
  • ctlfile (required) – Pianobar fifo file
  • color (default: #FFFFFF) – The color of the text
  • interval (default: 5) – interval in seconds between module updates
  • on_leftclick (default: playpause) – Callback called on left click (see Callbacks)
  • on_rightclick (default: next_song) – Callback called on right click (see Callbacks)
  • on_upscroll (default: increase_volume) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: decrease_volume) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.plexstatus.Plexstatus[source]

Displays what is currently being streamed from your Plex Media Server.

Settings

  • apikey (required) – Your Plex API authentication key (https://support.plex.tv/hc/en-us/articles/204059436-Finding-your-account-token-X-Plex-Token) .
  • address (required) – Hostname or IP address of the Plex Media Server.
  • port (default: 32400) – Port which Plex Media Server is running on.
  • interval (default: 120) – Update interval (in seconds).
  • format_no_streams (default: empty) – String that is shown if nothing is being streamed.
  • format (default: {platform}: {title})
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: empty) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: empty) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.pomodoro.Pomodoro[source]

This plugin shows Pomodoro timer.

Left click starts/restarts timer. Right click stops it.

Settings

  • sound (required) – Path to sound file to play as alarm. Played by “aplay” utility
  • pomodoro_duration (default: 1500) – Working (pomodoro) interval duration in seconds
  • break_duration (default: 300) – Short break duration in seconds
  • long_break_duration (default: 900) – Long break duration in seconds
  • short_break_count (default: 3) – Short break count before first long break
  • format (default: {current_pomodoro}/{total_pomodoro} {time}) – format string, available formatters: current_pomodoro, total_pomodoro, time
  • interval (default: 1) – interval in seconds between module updates
  • on_leftclick (default: start) – Callback called on left click (see Callbacks)
  • on_rightclick (default: stop) – Callback called on right click (see Callbacks)
  • on_upscroll (default: empty) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: empty) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.pulseaudio.PulseAudio[source]

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
  • {volume_bar} — unicode bar showing volume

Settings

  • format (default: ♪: {volume})
  • format_muted (default: empty) – optional format string to use when muted
  • muted (default: M)
  • unmuted (default: empty)
  • color_muted (default: #FF0000)
  • color_unmuted (default: #FFFFFF)
  • step (default: 5) – percentage to increment volume on scroll
  • bar_type (default: vertical) – type of volume bar. Allowed values are ‘vertical’ or ‘horizontal’
  • multi_colors (default: False) – whether or not to change the color from ‘color_muted’ to ‘color_unmuted’ based on volume percentage
  • vertical_bar_width (default: 2) – how many characters wide the vertical volume_bar should be
  • on_leftclick (default: pavucontrol) – Callback called on left click (see Callbacks)
  • on_rightclick (default: switch_mute) – Callback called on right click (see Callbacks)
  • on_upscroll (default: increase_volume) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: decrease_volume) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
context_notify_cb(context, _)[source]

Checks wether the context is ready

-Queries server information (server_info_cb is called) -Subscribes to property changes on all sinks (update_cb is called)

init()[source]

Creates context, when context is ready context_notify_cb is called

request_update(context)[source]

Requests a sink info update (sink_info_cb is called)

server_info_cb(context, server_info_p, userdata)[source]

Retrieves the default sink and calls request_update

sink_info_cb(context, sink_info_p, _, __)[source]

Updates self.output

update_cb(context, t, idx, userdata)[source]

A sink property changed, calls request_update

class i3pystatus.pyload.pyLoad[source]

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 (default: http://127.0.0.1:8000) – Address of pyLoad webinterface
  • format (default: {captcha} {progress_all:.1f}% {speed:.1f} kb/s)
  • captcha_true (default: Captcha waiting)
  • captcha_false (default: empty)
  • download_true (default: Downloads enabled)
  • download_false (default: Downloads disabled)
  • username (required)
  • password (required)
  • keyring_backend (default: empty) – alternative keyring backend for retrieving credentials
  • interval (default: 5) – interval in seconds between module updates
  • on_leftclick (default: open_webbrowser) – Callback called on left click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: empty) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: empty) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.reddit.Reddit[source]

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}
  • {link_karma}
  • {comment_karma}

Settings

  • format (default: [{submission_subreddit}] {submission_title} ({submission_domain})) – Format string used for output.
  • username (default: empty) – Reddit username.
  • password (default: empty) – Reddit password.
  • keyring_backend (default: empty) – alternative keyring backend for retrieving credentials
  • subreddit (default: empty) – Subreddit to monitor. Uses frontpage if unspecified.
  • sort_by (default: hot) – ‘hot’, ‘new’, ‘rising’, ‘controversial’, or ‘top’.
  • color (default: #FFFFFF) – Standard color.
  • colorize (default: True) – Enable color change on new message.
  • color_orangered (default: #FF4500) – Color for new messages.
  • mail_brackets (default: False) – Display unread message count in square-brackets.
  • title_maxlen (default: 80) – Maximum number of characters to display in title.
  • interval (default: 300) – Update interval.
  • status (default: {'no_mail': '', 'new_mail': '✉'}) – New message indicator.
  • on_leftclick (default: open_permalink) – Callback called on left click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: empty) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: empty) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.regex.Regex[source]

Simple regex file watcher

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

Settings

  • format (default: {0}) – format string used for output
  • regex (required)
  • file (required) – file to search for regex matches
  • flags (default: 0) – Python.re flags
  • interval (default: 5) – interval in seconds between module updates
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: empty) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: empty) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.runwatch.RunWatch[source]

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

  • {pid}
  • {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) – interval in seconds between module updates
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: empty) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: empty) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.sge.SGETracker[source]

Used to display status of Batch computing jobs on a cluster running Sun Grid Engine. The data is collected via ssh, so a valid ssh address must be specified.

Requires lxml.

Settings

  • ssh (required) – The SSH connection address. Can be user@host or user:password@host or user@host -p PORT etc.
  • color (default: #ffffff)
  • format (default: SGE qw: {queued} / r: {running} / Eqw: {error})
  • interval (default: 60) – interval in seconds between module updates
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: empty) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: empty) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.shell.Shell[source]

Shows output of shell command

Available formatters

  • {output} — just the striped command output without newlines

Settings

  • command (required) – command to be executed
  • color (default: #FFFFFF) – standard color
  • error_color (default: #FF0000) – color to use when non zero exit code is returned
  • format (default: {output})
  • interval (default: 5) – interval in seconds between module updates
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: empty) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: empty) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.solaar.Solaar[source]

Shows status and load percentage of bluetooth-device

Available formatters

  • {output} — percentage of battery and status

Settings

  • nameOfDevice (required) – name of the bluetooth-device
  • color (default: #FFFFFF) – standard color
  • error_color (default: #FF0000) – color to use when non zero exit code is returned
  • interval (default: 30) – interval in seconds between module updates
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: empty) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: empty) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.spotify.Spotify[source]

Gets Spotify info using playerctl

Available formatters

  • {status} — current status icon (paused/playing)
  • {length} — total song duration (mm:ss format)
  • {artist} — artist
  • {title} — title
  • {album} — album

Settings

  • format (default: {status} {length} {artist} - {title}) – formatp string
  • format_not_running (default: Not running) – Text to show if cmus is not running
  • color (default: #ffffff) – The color of the text
  • color_not_running (default: #ffffff) – The color of the text, when cmus is not running
  • status (default: {'playing': '▶', 'paused': '▷'}) – Dictionary mapping status to output
  • interval (default: 1) – interval in seconds between module updates
  • on_leftclick (default: playpause) – Callback called on left click (see Callbacks)
  • on_rightclick (default: next_song) – Callback called on right click (see Callbacks)
  • on_upscroll (default: next_song) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: previous_song) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
get_info(player)[source]

gets spotify track info from playerctl

next_song()[source]

skips to the next song

playpause()[source]

Pauses and plays spotify

previous_song()[source]

Plays the previous song

run()[source]

Main statement, executes all code every interval

class i3pystatus.syncthing.Syncthing[source]

Check Syncthing’s online status and start/stop Syncthing via click events.

Requires requests.

Settings

  • format_up (default: ST up) – Text to show when Syncthing is running
  • format_down (default: ST down) – Text to show when Syncthing is not running
  • color_up (default: #00ff00) – Color when Syncthing is running
  • color_down (default: #ff0000) – Color when Syncthing is not running
  • configfile (default: ~/.config/syncthing/config.xml) – Path to Syncthing config
  • url (default: auto) – Syncthing GUI URL; “auto” reads from local config
  • apikey (default: auto) – Syncthing APIKEY; “auto” reads from local config
  • verify_ssl (default: True) – Verify SSL certificate
  • interval (default: 10) – interval in seconds between module updates
  • on_leftclick (default: st_open) – Callback called on left click (see Callbacks)
  • on_rightclick (default: st_toggle_systemd) – Callback called on right click (see Callbacks)
  • on_upscroll (default: empty) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: empty) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
st_open()[source]

Callback: Open Syncthing web UI

st_restart()[source]

Callback: Restart Syncthing

st_restart_systemd()[source]

Callback: systemctl –user restart syncthing.service

st_start_systemd()[source]

Callback: systemctl –user start syncthing.service

st_stop()[source]

Callback: Stop Syncthing

st_stop_systemd()[source]

Callback: systemctl –user stop syncthing.service

st_toggle_systemd()[source]

Callback: start Syncthing service if offline, or stop it when online

class i3pystatus.temp.Temperature[source]

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 (default: {temp} °C) – format string used for output. {temp} is the temperature in degrees celsius
  • color (default: #FFFFFF)
  • file (default: /sys/class/thermal/thermal_zone0/temp)
  • alert_temp (default: 90)
  • alert_color (default: #FF0000)
  • interval (default: 5) – interval in seconds between module updates
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: empty) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: empty) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.text.Text[source]

Display static, colored text.

Settings

  • text (required)
  • color (default: empty) – HTML color code #RRGGBB
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: empty) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: empty) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.timer.Timer[source]

Timer module to remind yourself that there probably is something else you should be doing right now.

Main features include:

  • Set custom time interval with click events.
  • Different output formats triggered when remaining time is less than x seconds.
  • Execute custom python function or external command when timer overflows (or reaches zero depending on how you look at it).

Available formatters

Time formatters are available to show the remaining time. These include %h, %m, %s, %H, %M, %S. See TimeWrapper for detailed description.

The format_custom setting allows you to display different formats when certain amount of seconds is remaining. This setting accepts list of tuples which contain time in seconds, format string and color string each. See the default settings for an example:

  • (0, "+%M:%S", "#ffffff") - Use this format after overflow. White text with red background set by the urgent flag.
  • (60, "-%M:%S", "#ffa500") - Change color to orange in last minute.
  • (3600, "-%M:%S", "#00ff00") - Hide hour digits when remaining time is less than one hour.

Only first matching rule is applied (if any).

Callbacks

Module contains three mouse event callback methods:

  • start() - Default: Left click starts (or adds) 5 minute countdown.
  • increase() - Default: Upscroll/downscroll increase/decrease time by 1 minute.
  • reset() - Default: Right click resets timer.

Two new event settings were added:

  • on_overflow - Executed when remaining time reaches zero.
  • on_reset - Executed when timer is reset but only if overflow occured.

These settings accept either a python callable object or a string with shell command. Python callbacks should be non-blocking and without any arguments.

Here is an example that plays a short sound file in ‘loop’ every 60 seconds until timer is reset. (play is part of SoX - the Swiss Army knife of audio manipulation)

on_overflow = "play -q /path/to/sound.mp3 pad 0 60 repeat -"
on_reset = "pkill -SIGTERM -f 'play -q /path/to/sound.mp3 pad 0 60 repeat -'"

Settings

  • format (default: -%h:%M:%S) – Default format that is showed if no format_custom rules are matched.
  • format_stopped (default: T) – Format showed when timer is inactive.
  • color (default: #00ff00)
  • color_stopped (default: #ffffff)
  • format_custom (default: [(0, '+%M:%S', '#ffffff'), (60, '-%M:%S', '#ffa500'), (3600, '-%M:%S', '#00ff00')])
  • overflow_urgent (default: True) – Set urgent flag on overflow.
  • on_overflow (default: empty)
  • on_reset (default: empty)
  • interval (default: 1) – interval in seconds between module updates
  • on_leftclick (default: ['start', 300]) – Callback called on left click (see Callbacks)
  • on_rightclick (default: reset) – Callback called on right click (see Callbacks)
  • on_upscroll (default: ['increase', 60]) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: ['increase', -60]) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
increase(seconds)[source]

Change remainig time value.

Parameters:seconds (int) – Seconds to add. Negative value substracts from remaining time.
reset()[source]

Stop timer and execute on_reset if overflow occured.

start(seconds=300)[source]

Starts timer. If timer is already running it will increase remaining time instead.

Parameters:seconds (int) – Initial time.
class i3pystatus.uname.Uname[source]

uname(1) like module.

Available formatters

  • {sysname} — operating system name
  • {nodename} — name of machine on network (implementation-defined)
  • {release} — operating system release
  • {version} — operating system version
  • {machine} — hardware identifier

Settings

  • format (default: {sysname} {release}) – format string used for output
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: empty) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: empty) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.updates.Updates[source]

Generic update checker. To use select appropriate backend(s) for your system. For list of all available backends see Update Backends.

Left clicking on the module will refresh the count of upgradeable packages. This may be used to dismiss the notification after updating your system.

Available formatters

  • {count} — Sum of all available updates from all backends.
  • For each backend registered there is one formatter named after the backend, multiple identical backends do not accumulate, but overwrite each other.
  • For example, {Cower} (note capitcal C) is the number of updates reported by the cower backend, assuming it has been registered.

Usage example

from i3pystatus import Status
from i3pystatus.updates import pacman, cower

status = Status()

status.register("updates",
                format = "Updates: {count}",
                format_no_updates = "No updates",
                backends = [pacman.Pacman(), cower.Cower()])

status.run()

Settings

  • backends (default: empty) – Required list of backends used to check for updates.
  • format (default: Updates: {count}) – Format used when updates are available. May contain formatters.
  • format_no_updates (default: empty) – String that is shown if no updates are available. If not set the module will be hidden if no updates are available.
  • format_working (default: empty) – Format used while update queries are run. By default the same as format.
  • color (default: #00DD00)
  • color_no_updates (default: #FFFFFF)
  • color_working (default: empty)
  • interval (default: 3600) – Default interval is set to one hour.
  • on_leftclick (default: run) – Callback called on left click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: empty) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: empty) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.uptime.Uptime[source]

Outputs Uptime

Available formatters

  • {days} - uptime in days
  • {hours} - rest of uptime in hours
  • {mins} - rest of uptime in minutes
  • {secs} - rest of uptime in seconds
  • {uptime} - deprecated: equals ‘{hours}:{mins}

Settings

  • format (default: up {hours}:{mins}) – Format string
  • color (default: #ffffff) – String color
  • alert (default: False) – If you want the string to change color
  • seconds_alert (default: 2592000) – How many seconds necessary to start the alert
  • color_alert (default: #ff0000) – Alert color
  • interval (default: 5) – interval in seconds between module updates
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: empty) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: empty) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.vk.Vk[source]

Display amount of unread messages in VK social network. Creating your own VK API app is highly recommended for your own privacy, though there is a default one provided. Reference vk.com/dev for instructions on creating VK API app. If access_token is not specified, the module will try to open a request page in browser. You will need to manually copy obtained acess token to your config file. Requires the PyPI package vk.

Settings

  • app_id (default: 5160484) – Id of your VK API app
  • access_token (default: empty) – Your access token. You must have messages and offline access permissions
  • token_error (default: Vk: token error) – Message to be shown if there’s some problem with your token
  • color (default: #ffffff) – General color of the output
  • color_bad (default: #ff0000) – Color of the output in case of access token error
  • color_unread (default: #ffffff) – Color of the output if there are unread messages
  • interval (default: 1) – interval in seconds between module updates
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: empty) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: empty) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.weather.Weather[source]

This module gets the weather from weather.com. First, you need to get the code for the location from www.weather.com

Available formatters

  • {current_temp} — current temperature including unit (and symbol if colorize is true)
  • {min_temp} — today’s minimum temperature including unit
  • {max_temp} — today’s maximum temperature including unit
  • {current_wind} — current wind direction, speed including unit
  • {humidity} — current humidity excluding percentage symbol

Settings

  • location_code (default: empty) – Location code from www.weather.com
  • colorize (default: False) – Enable color with temperature and UTF-8 icons.
  • units (default: metric) – Celsius (metric) or Fahrenheit (imperial)
  • format (default: {current_temp})
  • interval (default: 20) – interval in seconds between module updates
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: empty) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: empty) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
fetch_weather()[source]

Fetches the current weather from wxdata.weather.com service.

class i3pystatus.whosonlocation.WOL[source]

Change your whosonlocation.com status.

Requires the PyPi module beautifulsoup4

Settings

  • keyring_backend (default: empty) – alternative keyring backend for retrieving credentials
  • email (default: empty)
  • password (default: empty)
  • interval (default: 5) – interval in seconds between module updates
  • on_leftclick (default: change_status) – Callback called on left click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: empty) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: empty) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.xkblayout.Xkblayout[source]

Displays and changes current keyboard layout.

change_layout callback finds the current layout in the layouts setting and enables the layout following it. If the current layout is not in the layouts setting the first layout is enabled.

layouts can be stated with or without variants, e.g.: status.register(“xkblayout”, layouts=[“de neo”, “de”])

Settings

  • layouts (default: []) – List of layouts
  • interval (default: 1) – interval in seconds between module updates
  • on_leftclick (default: change_layout) – Callback called on left click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: empty) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: empty) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.zabbix.Zabbix[source]

Zabbix alerts watcher

Requires: pyzabbix

Available formatters

  • {default} - Full output count alerts like total:a5/a4/a3/a2/a1/a0
  • {total} - Total count of alerts
  • {aX_count} - Count alerts of X severity
  • {colorX} - Predicted color for X severity. It can be used with Pango markup hint for different colours at each severity with

Settings

  • zabbix_server (required) – Zabbix Server URL
  • zabbix_user (required) – Zabbix API User
  • zabbix_password (required) – Zabbix users password
  • interval (default: 60) – Update interval
  • format (default: {default})
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: empty) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: empty) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublerightclick (default: empty) – Callback called on double right click (see Callbacks)
  • on_doubleupscroll (default: empty) – Callback called on double scroll up (see Callbacks)
  • on_doubledownscroll (default: empty) – Callback called on double scroll down (see Callbacks)
  • multi_click_timeout (default: 0.25) – Time (in seconds) before a single click is executed.
  • hints (default: {'markup': 'none'}) – Additional output blocks for module output (see Hints)
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.

Mail Backends

The generic mail module can be configured to use multiple mail backends. Here is an example configuration for the MaildirMail backend:

from i3pystatus.mail import maildir
status.register("mail",
                backends=[maildir.MaildirMail(
                        directory="/home/name/Mail/inbox")
                ],
                format="P {unread}",
                log_level=20,
                hide_if_null=False, )

class i3pystatus.mail.imap.IMAP[source]

Checks for mail on a IMAP server

Settings

  • host (required)
  • port (default: 993)
  • username (required)
  • password (required)
  • keyring_backend (default: empty) – alternative keyring backend for retrieving credentials
  • ssl (default: True)
  • mailbox (default: INBOX)
  • account (default: Default account) – Account name
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
imap_class

alias of IMAP4

class i3pystatus.mail.maildir.MaildirMail[source]

Checks for local mail in Maildir

Settings

  • directory (default: empty)
  • account (default: Default account) – Account name
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.mail.mbox.MboxMail[source]

Checks for local mail in mbox

Settings

  • account (default: Default account) – Account name
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.mail.notmuchmail.Notmuch[source]

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 (default: empty) – Path to the directory of your notmuch database
  • query (default: tag:unread and tag:inbox) – Same query notmuch would accept, by default ‘tag:unread and tag:inbox
  • account (default: Default account) – Account name
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.mail.thunderbird.Thunderbird[source]

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

Requires python-dbus

Settings

  • account (default: Default account) – Account name
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.

Update Backends

class i3pystatus.updates.aptget.AptGet[source]

Gets update count for Debian based distributions.

This mimics the Arch Linux checkupdates script but with apt-get and written in python.

Settings

  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.updates.cower.Cower[source]

Checks for updates in Arch User Repositories using the cower AUR helper.

Depends on cower AUR agent - https://github.com/falconindy/cower

Settings

  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.updates.pacman.Pacman[source]

Checks for updates in Arch Linux repositories using the checkupdates script which is part of the pacman package.

Settings

  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.updates.yaourt.Yaourt[source]

This module counts the available updates using yaourt. By default it will only count aur packages. Thus it can be used with the pacman backend like this:

from i3pystatus.updates import pacman, yaourt status.register(“updates”, backends = [pacman.Pacman(), yaourt.Yaourt()])

If you want to count both pacman and aur packages with this module you can set the variable count_only_aur = False like this:

from i3pystatus.updates import yaourt status.register(“updates”, backends = [yaourt.Yaourt(False)])

Settings

  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.