Module reference

Module overview:

System:clock - cpu_freq - cpu_usage - disk - keyboard_locks - load - mem - swap - uname - uptime - xkblayout
Audio:alsa - pulseaudio
Hardware:backlight - battery - temp
Network:net_speed - network - online - openstack_vms - openvpn
Music:cmus - moc - 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.abc_radio.ABCRadio[source]
Module name: abc_radio (class i3pystatus.abc_radio.ABCRadio)

Streams ABC Australia radio - https://radio.abc.net.au/. Currently uses VLC to do the actual streaming.

Requires the PyPI packages python-vlc, python-dateutil and requests. Also requires VLC - https://www.videolan.org/vlc/index.html

Available formatters

  • {station} — Current station
  • {title} — Title of current show
  • {url} — Show’s URL
  • {remaining} — Time left for current show
  • {player_state} — Unicode icons representing play, pause and stop

Settings

  • format (default: {station} {title} {player_state}) – format string for when the player is inactive
  • format_playing (default: {station} {title} {remaining} {player_state}) – format string for when the player is playing
  • target_stations (default: []) – list of station ids to select from. Station ids can be obtained from the following XML - http://www.abc.net.au/radio/data/stations_apps_v3.xml. If the list is empty, all stations will be accessible.
  • interval (default: 1) – interval in seconds between module updates
  • on_leftclick (default: toggle_play) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: ['cycle_stations', 1]) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: ['cycle_stations', -1]) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: display_notification) – Callback called on double left click (see Callbacks)
  • on_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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.alsa.ALSA[source]
Module name: alsa (class i3pystatus.alsa.ALSA)

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

Requires pyalsaaudio

Available formatters

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

Settings

  • format (default: ♪: {volume})
  • format_muted (default: empty) – optional format string to use when muted
  • mixer (default: Master) – ALSA mixer
  • mixer_id (default: 0) – ALSA mixer id
  • card (default: -1) – 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_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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.amdgpu.Amdgpu[source]
Module name: amdgpu (class i3pystatus.amdgpu.Amdgpu)

Shows information about gpu’s using the amdgpu driver

Available formatters

  • {temp}
  • {sclk} - Gpu clock speed
  • {mclk} - Memory clock speed
  • {fan_speed} - Fan speed
  • {gpu_usage} - Gpu Usage percent

Settings

  • format (default: {temp} {mclk} {sclk})
  • color (default: empty)
  • card (default: 0) – [1, 2, ...] card to read (options are in /sys/class/drm/)
  • interval (default: 5) – interval in seconds between module updates
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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]
Module name: anybar (class i3pystatus.anybar.AnyBar)

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_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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]
Module name: backlight (class i3pystatus.backlight.Backlight)

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
  • format_no_backlight (default: No backlight) – format string when no backlight file available
  • backlight (default: *) – backlight, see /sys/class/backlight/. Supports glob expansion, i.e. * matches anything. If it matches more than one filename, selects the first one in alphabetical order
  • color (default: #FFFFFF)
  • components (default: {'brightness': (<class 'int'>, 'brightness'), 'max_brightness': (<class 'int'>, 'max_brightness')})
  • transforms (default: {'percentage': <function Backlight.<lambda> at 0x7f8450451598>})
  • base_path (default: /sys/class/backlight/{backlight}/)
  • interval (default: 5)
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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]
Module name: battery (class i3pystatus.battery.BatteryChecker)

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

Setting battery_ident to ALL will summarise all available batteries and aggregate the % as well as the time remaining on the charge. This is helpful when the machine has more than one battery available.

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
  • {glyph} — A single character or string (selected from ‘glyphs’) representing the current battery percentage

This module supports the formatp extended string format syntax. By setting the FULL status to an empty string, and including brackets around the {status} formatter, the text within the brackets will be hidden when the battery is full, as can be seen in the below example:

from i3pystatus import Status

status = Status()

status.register(
    'battery',
    interval=5,
    format='{battery_ident}: [{status} ]{percentage_design:.2f}%',
    alert=True,
    alert_percentage=15,
    status={
        'DPL': 'DPL',
        'CHR': 'CHR',
        'DIS': 'DIS',
        'FULL': '',
    }
)

# status.register(
#     'battery',
#     format='{status} {percentage:.0f}%',
#     levels={
#         25: "<=25",
#         50: "<=50",
#         75: "<=75",
#     },
# )

status.run()

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_timeout (default: -1)
  • 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: {'DPL': 'DPL', 'CHR': 'CHR', 'DIS': 'DIS', 'FULL': 'FULL'}) – A dictionary mapping (‘DPL’, ‘DIS’, ‘CHR’, ‘FULL’) to alternative names
  • levels (default: empty) – A dictionary mapping percentages of charge levels to corresponding 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%
  • glyphs (default: ▁▂▃▄▅▆▇█) – Arbitrarily long string of characters (or array of strings) to represent battery charge percentage
  • use_design_percentage (default: False) – Use design percentage rather then absolute percentage for alerts
  • interval (default: 5) – interval in seconds between module updates
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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]
Module name: bitcoin (class i3pystatus.bitcoin.Bitcoin)

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> and it is possible to specify the exchange to be monitored. Transaction data is pulled from blockchain.info <https://blockchain.info/api/blockchain_api>.

Available formatters

  • {last_price}
  • {ask_price}
  • {bid_price}
  • {daily_average}
  • {volume}
  • {volume_thousand}
  • {volume_percent}
  • {age}
  • {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
  • exchange (default: empty) – Get ticker from a custom exchange instead
  • 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_up': '▲', 'price_down': '▼'})
  • on_leftclick (default: electrum) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle click (see Callbacks)
  • on_rightclick (default: ['open_something', '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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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.
open_something(url_or_command)[source]

Wrapper function, to pass the arguments to user_open

class i3pystatus.bluetooth.Bluetooth[source]
Module name: bluetooth (class i3pystatus.bluetooth.Bluetooth)

Shows currently connected bluetooth devices.

  • Requires python-dbus from your distro package manager, or dbus-python from PyPI.

Left click on the module to cycle forwards through devices, and right click to cycle backwards.

Available formatters (uses formatp)

  • {name} — (the name of the device)
  • {dev_addr} — (the bluetooth device address)

Available callbacks

  • next_device — iterate forward through devices
  • prev_device — iterate backwards through devices

Example module registration with callbacks:

::
status.register(“now_playing”,
on_leftclick=”next_device”, on_rightclick=”prev_device”, on_upscroll=”next_device”, on_downscroll=”prev_device”)

Settings

  • format (default: {name}: {dev_addr}) – formatp string
  • color (default: #ffffff) – Text color
  • connected_color (default: #00ff00) – Connected device color
  • show_disconnected (default: True) – Show disconnected but paired devices
  • interval (default: 1) – interval in seconds between module updates
  • on_leftclick (default: next_device) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle click (see Callbacks)
  • on_rightclick (default: prev_device) – Callback called on right click (see Callbacks)
  • on_upscroll (default: next_device) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: prev_device) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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.calendar.Calendar[source]
Module name: calendar (class i3pystatus.calendar.Calendar)

Generic calendar module. Requires the PyPI package colour.

Available formatters

  • {title} - the title or summary of the event
  • {remaining_time} - how long until this event is due
  • {humanize_remaining} - how long until this event is due in human readable format

Additional formatters may be provided by the backend, consult their documentation for details.

Note

Optionally requires humanize to display time in human readable format.

Settings

  • format (default: {title} - {remaining}) – Format string to display in the bar
  • backend (required) – Backend to use for collecting calendar events
  • skip_recurring (default: False) – Whether or not to skip recurring events
  • skip_all_day (default: False) – Whether or not to skip all day events
  • skip_regex (default: empty) – Skip events with titles that match this regex
  • update_interval (default: 600) – How often in seconds to call the backend’s update method
  • urgent_seconds (default: 300) – When within this many seconds of the event, set the urgent flag
  • urgent_blink (default: False) – Whether or not to blink when within urgent_seconds of the event
  • dynamic_color (default: True) – Whether or not to change color as the event approaches
  • color (default: empty)
  • interval (default: 1) – interval in seconds between module updates
  • on_leftclick (default: acknowledge) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle click (see Callbacks)
  • on_rightclick (default: handle_click) – 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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.
is_urgent()[source]

Determine whether or not to set the urgent flag. If urgent_blink is set, toggles urgent flag on and off every second.

class i3pystatus.circleci.CircleCI[source]
Module name: circleci (class i3pystatus.circleci.CircleCI)

Get current status of circleci builds Requires circleci dateutil.parser

Formatters:

  • {repo_slug} - repository owner/repository name
  • {repo_status} - repository status
  • {repo_name} - repository name
  • {repo_owner} - repository owner
  • {last_build_started} - date of the last finished started
  • {last_build_duration} - duration of the last build, not populated with workflows(yet)

Examples

status_color_map = {
    'passed': '#00FF00',
    'failed': '#FF0000',
    'errored': '#FFAA00',
    'cancelled': '#EEEEEE',
    'started': '#0000AA',

}
repo_status_map={
    'success': '<span color="#00af00">success</span>',
    'running': '<span color="#0000af">running</span>',
    'failed': '<span color="#af0000">failed</span>',
}

Settings

  • format (default: {repo_owner}/{repo_name}-{repo_status} [({last_build_started}({last_build_duration}))])
  • circleci_token (required) – circleci access token
  • repo_slug (required) – repository identifier eg. “enkore/i3pystatus”
  • time_format (default: %m/%d) – passed directly to .strftime() for last_build_started
  • repo_status_map (default: empty) – map representing how to display status
  • duration_format (default: %m:%S) – last_build_duration format string
  • status_color_map (default: empty) – color for all text based on status
  • color (default: #DDDDDD) – color for all text not otherwise colored
  • workflow_name (default: empty) – [WORKFLOWS_ONLY] if specified, monitor this workflows status. if not specified this module will default to reporting the status of your last build
  • workflow_branch (default: empty) – [WORKFLOWS_ONLY] if specified, monitor the workflows in this branch
  • interval (default: 5) – interval in seconds between module updates
  • on_leftclick (default: open_build_webpage) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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]
Module name: clock (class i3pystatus.clock.Clock)

This class shows a clock.

Note

Optionally requires pytz for time zone data when using time zones other than local time.

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_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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]
Module name: cmus (class i3pystatus.cmus.Cmus)

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: {'paused': '▷', 'playing': '▶', '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_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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.coin.Coin[source]
Module name: coin (class i3pystatus.coin.Coin)

Fetches live data of all cryptocurrencies availible at coinmarketcap <https://coinmarketcap.com/>. Coin setting should be equal to the ‘id’ field of your coin in <https://api.coinmarketcap.com/v1/ticker/>.

Example coin settings: bitcoin, bitcoin-cash, ethereum, litecoin, dash, lisk. Example currency settings: usd, eur, huf.

Available formatters

  • {symbol}
  • {price}
  • {rank}
  • {24h_volume}
  • {market_cap}
  • {available_supply}
  • {total_supply}
  • {max_supply}
  • {percent_change_1h}
  • {percent_change_24h}
  • {percent_change_7d}
  • {last_updated} - time of last update on the API’s part
  • {status}

Settings

  • format (default: {symbol} {price}{status}) – format string used for output.
  • color (default: empty)
  • coin (default: ethereum) – cryptocurrency to fetch
  • decimal (default: 2) – round coin price down to this decimal place
  • currency (default: USD) – fiat currency to show fiscal data
  • symbol (default: ¤) – coin symbol
  • interval (default: 600) – update interval in seconds
  • status_interval (default: 24h) – percent change status in the last: ‘1h’ / ‘24h’ / ‘7d’
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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]
Module name: cpu_freq (class i3pystatus.cpu_freq.CpuFreq)

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_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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, use file=/sys to use kernel >=4.13 location :return: dictionary used as the full-text output for the module

class i3pystatus.cpu_usage.CpuUsage[source]
Module name: cpu_usage (class i3pystatus.cpu_usage.CpuUsage)

Shows CPU usage. The first output will be inacurate.

Linux only Requires the PyPI package ‘colour’.

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: #FFFFFF) – HTML color code #RRGGBB
  • dynamic_color (default: False) – Set color dynamically based on CPU usage. 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’
  • interval (default: 1) – interval in seconds between module updates
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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]
Module name: cpu_usage_bar (class i3pystatus.cpu_usage_bar.CpuUsageBar)

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’
  • dynamic_color (default: False) – Use dynamic color
  • 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: #FFFFFF) – 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_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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]
Module name: cpu_usage_graph (class i3pystatus.cpu_usage_graph.CpuUsageGraph)

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’)
  • direction (default: left-to-right) – Graph running direction (‘left-to-right’, ‘right-to-left’)
  • 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: #FFFFFF) – HTML color code #RRGGBB
  • dynamic_color (default: False) – Set color dynamically based on CPU usage. Note: this overrides color_up
  • interval (default: 1) – interval in seconds between module updates
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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.deluge.Deluge[source]
Module name: deluge (class i3pystatus.deluge.Deluge)

Deluge torrent module Requires deluge-client

Formatters:

  • {num_torrents} - number of torrents in deluge
  • {free_space_bytes} - bytes free in path
  • {used_space_bytes} - bytes used in path
  • {upload_rate} - bytes sent per second
  • {download_rate} - bytes received per second
  • {total_uploaded} - bytes sent total
  • {total_downloaded} - bytes received total

Settings

  • format (default: ⛆{num_torrents} ✇{free_space_bytes})
  • color (default: empty)
  • rounding (default: 2) – number of decimal places to round numbers too
  • host (default: 127.0.0.1) – address of deluge server (default: 127.0.0.1)
  • port (default: 58846) – port of deluge server (default: 58846)
  • username (required) – username to authenticate with deluge
  • password (required) – password to authenticate to deluge
  • path (default: empty) – override “download path” server-side when checking space used/free
  • offline_string (default: offline) – string to output while unable to connect to deluge daemon
  • interval (default: 5) – interval in seconds between module updates
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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_free_space(path=None)[source]

get free space of path in bytes (default: download location)

get_path_size(path=None)[source]

get used space of path in bytes (default: download location)

class i3pystatus.disk.Disk[source]
Module name: disk (class i3pystatus.disk.Disk)

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_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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]
Module name: dota2wins (class i3pystatus.dota2wins.Dota2wins)

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_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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]
Module name: dpms (class i3pystatus.dpms.DPMS)

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})
  • format_disabled (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_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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.exmo.Exmo[source]
Module name: exmo (class i3pystatus.exmo.Exmo)

This module fetching and displays exchange rates with EXMO. Using API <https://exmo.me/en/api>.

Available formatters

  • {buy_price}
  • {status}
  • {pair}

Settings

  • format (default: {buy_price}[ {status}] {pair}) – Format string used for output
  • pair (default: BTC_USD) – Currency pair for display on output
  • 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: 60) – Update interval.
  • status (default: {'price_up': '▲', 'price_down': '▼'})
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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.
open_something(url_or_command)[source]

Wrapper function, to pass the arguments to user_open

class i3pystatus.external_ip.ExternalIP[source]
Module name: external_ip (class i3pystatus.external_ip.ExternalIP)

Shows the external IP with the country code/name.

Requires the PyPI package GeoIP.

Available formatters

  • {country_name} the full name of the country from the IP (eg. ‘United States’)
  • {country_code} the country code of the country from the IP (eg. ‘US’)
  • {ip} the ip

Settings

  • format (default: {country_name} {country_code} {ip})
  • color (default: #FFFFFF)
  • color_down (default: #FF0000) – color when the http request failed
  • color_hide (default: #FFFF00) – color when the user has decide to switch to the hide format
  • format_down (default: Timeout) – format when the http request failed
  • format_hide (default: {country_code}) – format when the user has decide to switch to the hide format
  • ip_website (default: https://api.ipify.org) – http website where the IP is directly available as raw
  • timeout (default: 5) – timeout in seconds when the http request is taking too much time
  • interval (default: 15) – interval in seconds between module updates
  • on_leftclick (default: switch_hide) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle click (see Callbacks)
  • on_rightclick (default: run) – 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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]
Module name: file (class i3pystatus.file.File)

Rip information from text files

components is a dict of pairs of the form:

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

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

Settings

  • format (required)
  • components (required)
  • transforms (default: {})
  • base_path (default: /)
  • color (default: #FFFFFF)
  • interval (default: 5)
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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]
Module name: github (class i3pystatus.github.Github)

This module checks the GitHub system status, and optionally the number of unread notifications.

Changed in version 3.36: Module now checks system status in addition to unread notifications.

Note

For notification checking, the following is required:

  • The requests module must be installed.
  • Either access_token (recommended) or username and password must be used to authenticate to GitHub.

Using an access token is the recommended authentication method. Click here to generate a new access token. Fill in the Token description box, and enable the notifications scope by checking the appropriate checkbox. Then, click the Generate token button.

Important

An access token is the only supported means of authentication for this module, if 2-factor authentication is enabled.

See here for more information on GitHub’s authentication API.

If you would rather use a username and password pair, you can either pass them as arguments when registering the module, or use i3pystatus’ credential management support to store them in a keyring. Keep in mind that if you do not pass a username or password parameter when registering the module, i3pystatus will still attempt to retrieve these values from a keyring if the keyring Python module is installed. This could result in i3pystatus aborting during startup if it cannot find a usable keyring backend. If you do not plan to use credential management at all in i3pystatus, then you should either ensure that A) keyring is not installed, or B) both keyring and keyrings.alt are installed, to avoid this error.

Available formatters

  • {status} — Current GitHub status. This formatter can be different depending on the current outage status (none, minor, major, or critical). The content displayed for each of these statuses is defined in the status config option.
  • {unread} — When there are unread notifications, this formatter will contain the value of the unread_marker marker config option. there are no unread notifications, it formatter will be an empty string.
  • {unread_count} — The number of unread notifications notifications, it will be an empty string.
  • {update_error} — When an error is encountered updating this module, this formatter will be set to the value of the update_error config option.

Click events

This module responds to 4 different click events:

  • Left-click — Forces an update of the module.
  • Right-click — Triggers a desktop notification showing the most recent update to the GitHub status. This is useful when the status changes when you are away from your computer, so that the updated status can be seen without visiting the GitHub Status Dashboard. This click event requires notify_status to be set to True.
  • Double left-click — Opens the GitHub notifications page in your web browser.
  • Double right-click — Opens the GitHub Status Dashboard in your web browser.

Desktop notifications

New in version 3.36.

If notify_status is set to True, a notification will be displayed when the status reported by the GitHub Status API changes.

If notify_unread is set to True, a notification will be displayed when new unread notifications are found. Double-clicking the module will launch the GitHub notifications dashboard in your browser.

Note

A notification will be displayed if there was a problem querying the GitHub Status API, irrespective of whether or not notify_status or notify_unread is set to True.

Example configuration

The below example enables desktop notifications, enables Pango hinting for differently-colored update_error and refresh_icon text, and alters the both the status text and the colors used to visually denote the current status level. It also sets the log level to debug, for troubleshooting purposes.

status.register(
    'github',
    log_level=logging.DEBUG,
    notify_status=True,
    notify_unread=True,
    access_token='0123456789abcdef0123456789abcdef01234567',
    hints={'markup': 'pango'},
    update_error='<span color="#af0000">!</span>',
    refresh_icon='<span color="#ff5f00">⟳</span>',
    status={
        'none': '✓',
        'minor': '!',
        'major': '!!',
        'critical': '!!!',
    },
    colors={
        'none': '#008700',
        'minor': '#d7ff00',
        'major': '#af0000',
        'critical': '#640000',
    },
)

Note

Setting debug logging and authenticating with an access token will include the access token in the log file, as the notification URL is logged at this level.

Extended string formatting

New in version 3.36.

This module supports the formatp extended string format syntax. This allows for values to be hidden when they evaluate as False. The default format string value for this module makes use of this syntax to conditionally show the value of the update_error config value when the backend encounters an error during an update, but this can also be used to only show the number of unread notifications when that number is not 0. The below example would show the unread count as (3) when there are 3 unread notifications, but would show nothing when there are no unread notifications.

status.register(
    'github',
    notify_status=True,
    notify_unread=True,
    access_token='0123456789abcdef0123456789abcdef01234567',
    format='{status}[ ({unread_count})][ {update_error}]'
)

Settings

  • format (default: {status}[ {unread}][ {update_error}]) – format string
  • status (default: {'none': 'GitHub', 'minor': 'GitHub', 'major': 'GitHub', 'critical': 'GitHub'}) – Dictionary mapping statuses to the text which represents that status type. This defaults to GitHub for all status types.
  • colors (default: {'none': '#28a745', 'minor': '#dbab09', 'major': '#e36209', 'critical': '#dc3545'}) – Dictionary mapping statuses to the color used to display the status text
  • refresh_icon (default: ) – Text to display (in addition to any text currently shown by the module) when refreshing the GitHub status. NOTE: Depending on how quickly the update is performed, the icon may not be displayed.
  • update_error (default: !) – Value for the {update_error} formatter when an error is encountered while checking GitHub status
  • keyring_backend (default: empty) – alternative keyring backend for retrieving credentials
  • username (default: empty)
  • password (default: empty)
  • access_token (default: empty)
  • unread_marker (default: ) – Defines the string that the {unread} formatter shows when there are pending notifications
  • notify_status (default: False) – Set to True to display a desktop notification on status changes
  • notify_unread (default: False) – Set to True to display a desktop notification when new notifications are detected
  • unread_notification_template (default: You have %d new notification(s)) – String with no more than one %d, which will be replaced by the number of new unread notifications. Useful for those with non-English locales who would like the notification to be in their native language. The %d can be omitted if desired.
  • api_methods_url (default: https://www.githubstatus.com/api/v2/summary.json) – URL from which to retrieve the API endpoint URL which this module will use to check the GitHub Status
  • status_url (default: https://www.githubstatus.com) – The URL to the status page (opened when the module is double-clicked with the right mouse button
  • notifications_url (default: https://github.com/notifications) – The URL to the GitHub notifications page (opened when the module is double-clicked with the left mouse button
  • interval (default: 600) – interval in seconds between module updates
  • on_leftclick (default: ['perform_update']) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle click (see Callbacks)
  • on_rightclick (default: ['show_status_notification']) – 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: ['launch_notifications_url']) – Callback called on double left click (see Callbacks)
  • on_doublemiddleclick (default: empty) – Callback called on double middle click (see Callbacks)
  • on_doublerightclick (default: ['launch_status_url']) – 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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]
Module name: gpu_mem (class i3pystatus.gpu_mem.GPUMemory)

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 when warn percentage is exceeded
  • alert_color (default: #FF0000) – defines the color used when alert percentage is exceeded
  • round_size (default: 1) – defines number of digits in round
  • gpu_number (default: 0) – set the gpu number when you have several GPU
  • interval (default: 5) – interval in seconds between module updates
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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]
Module name: gpu_temp (class i3pystatus.gpu_temp.GPUTemperature)

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
  • display_if (default: True) – snippet that gets evaluated. if true, displays the module output
  • gpu_number (default: 0) – set the gpu number when you have several GPU
  • 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_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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_usage.GPUUsage[source]
Module name: gpu_usage (class i3pystatus.gpu_usage.GPUUsage)

Shows GPU load in percent

Currently Nvidia only and nvidia-smi required

Available formatters

  • {usage}

Settings

  • format (default: {usage}%) – 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 when warn percentage is exceeded
  • alert_color (default: #FF0000) – defines the color used when alert percentage is exceeded
  • gpu_number (default: 0) – set the gpu number when you have several GPU
  • interval (default: 5) – interval in seconds between module updates
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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.group.Group[source]
Module name: group (class i3pystatus.group.Group)

Module for grouping modules together Cycles trough groups by means of scrolling

group = Group()
group.register("network",
    interface="eth0",
    divisor=1024,
    start_color='white',
    format_up="{bytes_recv}K / {bytes_sent}K"
)
group.register("network",
    interface="eth0",
    color_up='#FFFFFF',
    format_up="{v4}"
)
status.register(group)

Settings

  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: ['cycle_module', 1]) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: ['cycle_module', -1]) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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.
on_click(button, **kwargs)[source]

Capture scrollup and scorlldown to move in groups Pass everthing else to the module itself

class i3pystatus.iinet.IINet[source]
Module name: iinet (class i3pystatus.iinet.IINet)

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
  • {used} - GB of your quota used

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_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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]
Module name: keyboard_locks (class i3pystatus.keyboard_locks.Keyboard_locks)

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_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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.lastfm.LastFM[source]
Module name: lastfm (class i3pystatus.lastfm.LastFM)

Displays currently playing song as reported by last.fm. Get your API key from http://www.last.fm/api.

Settings

  • apikey (required) – API key used to make calls to last.fm.
  • user (required) – Name of last.fm user to track.
  • playing_format (default: {artist} - {track}) – Output format when a song is playing
  • stopped_format (default: empty) – Output format when nothing is playing
  • playing_color (default: FFFFFF)
  • stopped_color (default: 000000)
  • interval (default: 5)
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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]
Module name: load (class i3pystatus.load.Load)

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: 1) – 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_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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]
Module name: mail (class i3pystatus.mail.Mail)

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_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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]
Module name: makewatch (class i3pystatus.makewatch.MakeWatch)

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_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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]
Module name: mem (class i3pystatus.mem.Mem)

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 when warn percentage is 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_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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]
Module name: mem_bar (class i3pystatus.mem_bar.MemBar)

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 when warn percentage is 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_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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.moc.Moc[source]
Module name: moc (class i3pystatus.moc.Moc)

Display various information from MOC (music on console)

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

Settings

  • format (default: {status} {song_elapsed}/{song_length} {artist} - {title}) – formatp string
  • format_not_running (default: Not running) – Text to show if MOC is not running
  • color (default: #ffffff) – The color of the text
  • color_not_running (default: #ffffff) – The color of the text, when MOC is not running
  • status (default: {'pause': '▷', 'play': '▶', 'stop': '◾'}) – Dictionary mapping status to output
  • interval (default: 1) – interval in seconds between module updates
  • on_leftclick (default: toggle_pause) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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]
Module name: modsde (class i3pystatus.modsde.ModsDeChecker)

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_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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]
Module name: moon (class i3pystatus.moon.MoonPhase)

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} {moonicon})
  • status (default: {'New Moon': 'NM', 'Waxing Crescent': 'WaxCres', 'First Quarter': 'FQ', 'Waxing Gibbous': 'WaxGib', 'Full Moon': 'FM', 'Waning Gibbous': 'WanGib', 'Last Quarter': 'LQ', 'Waning Crescent': 'WanCres'}) – Current moon phase
  • illum (default: <function MoonPhase.illum at 0x7f8450393048>) – Percentage that is illuminated
  • color (default: {'New Moon': '#00BDE5', 'Waxing Crescent': '#138DD8', 'First Quarter': '#265ECC', 'Waxing Gibbous': '#392FBF', 'Full Moon': '#4C00B3', 'Waning Gibbous': '#871181', 'Last Quarter': '#C32250', 'Waning Crescent': '#FF341F'}) – Set color
  • moonicon (default: {'New Moon': '🌑', 'Waxing Crescent': '🌒', 'First Quarter': '🌓', 'Waxing Gibbous': '🌔', 'Full Moon': '🌕', 'Waning Gibbous': '🌖', 'Last Quarter': '🌗', 'Waning Crescent': '🌘'}) – Set icon
  • interval (default: 7200) – interval in seconds between module updates
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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]
Module name: mpd (class i3pystatus.mpd.MPD)

Displays various information from MPD (the music player daemon)

Available formatters (uses formatp)

  • {title} — (the title of the current song)
  • {album} — (the album of the current song, can be an empty string (e.g. for online streams))
  • {artist} — (can be empty, too)
  • {album_artist} — (can be empty)
  • {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)

Available callbacks

  • switch_playpause — Plays if paused or stopped, otherwise pauses. Emulates mpc toggle.
  • stop — Stops playback. Emulates mpc stop.
  • next_song — Goes to next track in the playlist. Emulates mpc next.
  • previous_song — Goes to previous track in the playlist. Emulates mpc prev.
  • mpd_command — Send a command directly to MPD’s socket. The command is the second element of the list. Documentation for available commands can be found at https://www.musicpd.org/doc/protocol/command_reference.html

Example module registration with callbacks:

status.register("mpd",
    on_leftclick="switch_playpause",
    on_rightclick=["mpd_command", "stop"],
    on_middleclick=["mpd_command", "shuffle"],
    on_upscroll=["mpd_command", "seekcur -10"],
    on_downscroll=["mpd_command", "seekcur +10"])

Note that next_song and previous_song, and their mpd_command equivalents, are ignored while mpd is stopped.

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: {'pause': '▷', 'play': '▶', 'stop': '◾'}) – Dictionary mapping pause, play and stop to output
  • color (default: #FFFFFF) – The color of the text
  • color_map (default: {}) – The mapping from state to 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', '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
  • password (default: empty) – A password for access to MPD. (This is sent in cleartext to the server.)
  • interval (default: 1) – interval in seconds between module updates
  • on_leftclick (default: switch_playpause) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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]
Module name: net_speed (class i3pystatus.net_speed.NetSpeed)

Attempts to provide an estimation of internet speeds. Requires: speedtest-cli/modularize-2 speedtest-cli/modularize-2 can be installed using pip: pip install git+https://github.com/sivel/speedtest-cli.git@modularize-2

Settings

  • units (default: bits) – Valid values are B, b, bytes, or bits
  • format (default: ↓{speed_down:.1f}{down_units} ↑{speed_up:.1f}{up_units} ({hosting_provider}))
  • color (default: #FFFFFF)
  • interval (default: 300) – interval in seconds between module updates
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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.
form_b(n: float) → tuple[source]

formats a bps as bps/kbps/mbps/gbps etc handles whether its meant to be in bytes :param n: input float :rtype tuple: :return: tuple of float-number of mbps etc, str-units

class i3pystatus.network.Network[source]
Module name: network (class i3pystatus.network.Network)

Displays network information for an interface. formatp support if u wanna display recv/send speed separate in dynamic color mode, please enable pango hint.

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
  • {freq_divisor} — Frequency divisor
  • {quality} — Link quality in percent
  • {quality_bar} —Bar graphically representing link quality

Network Traffic Formatters (requires PyPI package psutil):

  • {interface} — the configured network interface
  • {network_graph_recv} – Unicode graph representing incoming network traffic
  • {network_graph_sent} – Unicode graph representing outgoing network traffic
  • {bytes_sent} — bytes sent per second (divided by divisor | auto calculated if auto_units == True)
  • {bytes_recv} — bytes received per second (divided by divisor | auto calculated if auto_units == True)
  • {packets_sent} — packets sent per second
  • {packets_recv} — packets received per second
  • {rx_tot_Mbytes} — total Mbytes received
  • {tx_tot_Mbytes} — total Mbytes sent
  • {rx_tot} — total traffic recieved (rounded to nearest unit: KB, MB, GB)
  • {tx_tot} — total traffic sent (rounded to nearest unit: KB, MB, GB)

Settings

  • format_up (default: {interface} {network_graph_recv}{bytes_recv}KB/s) – format string
  • format_active_up (default: {}) – Dictionary containing format strings for auto-detected interfaces. Each key can be either a full interface name, or a pattern matching a interface, eg ‘e*’ for ethernet interfaces. Fallback to format_up if no pattern could be matched.
  • 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’)
  • graph_direction (default: left-to-right) – left-to-right/right-to-left
  • separate_color (default: False) – display recv/send color separate in dynamic color mode.Note: only network speed formatters will display with range color
  • coloring_type (default: recv) – Whether to use the sent or received kb/s for dynamic coloring with non-separate colors. Allowed values ‘recv’ or ‘sent’
  • divisor (default: 1024) – divide all byte values by this value
  • recv_limit (default: 2048) – Expected max KiB/s. This value controls the drawing color of receive speed
  • sent_limit (default: 1024) – Expected max KiB/s. similar with receive_limit
  • freq_divisor (default: 1) – divide Wifi frequency by this value
  • ignore_interfaces (default: ['lo']) – Array of interfaces to ignore when cycling through on click, eg, [‘lo’]
  • round_size (default: 0) – 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
  • next_if_down (default: False) – Change to next interface if current one is down
  • detect_active (default: False) – Attempt to detect the active interface
  • auto_units (default: False) – if true, unit of measurement is switched automatically (KB/MB/GB/...)
  • interval (default: 1) – interval in seconds between module updates
  • on_leftclick (default: nm-connection-editor) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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]
Module name: now_playing (class i3pystatus.now_playing.NowPlaying)

Shows currently playing track information. Supports media players that conform to the Media Player Remote Interfacing Specification.

  • Requires python-dbus from your distro package manager, or dbus-python from PyPI.

Left click on the module to play/pause, and right click to go 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)

Available callbacks

  • playpause — Plays if paused or stopped, otherwise pauses.
  • next_song — Goes to next track in the playlist.
  • player_command — Invoke a command with the MediaPlayer2.Player interface. The method name and its arguments are appended as list elements.
  • player_prop — Get or set a property of the MediaPlayer2.Player interface. Append the property name to get, or the name and a value to set.

MediaPlayer2.Player methods and properties are documented at https://specifications.freedesktop.org/mpris-spec/latest/Player_Interface.html

Your player may not support the full interface.

Example module registration with callbacks:

status.register("now_playing",
    on_leftclick=["player_command", "PlayPause"],
    on_rightclick=["player_command", "Stop"],
    on_middleclick=["player_prop", "Shuffle", True],
    on_upscroll=["player_command", "Seek", -10000000],
    on_downscroll=["player_command", "Seek", +10000000])

Settings

  • player (default: empty) – Player name. If not set, compatible players will be detected automatically.
  • status (default: {'pause': '▷', 'play': '▶', 'stop': '◾'}) – 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_middleclick (default: empty) – Callback called on middle click (see Callbacks)
  • on_rightclick (default: next_song) – Callback called on right click (see Callbacks)
  • on_upscroll (default: volume_up) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: volume_down) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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]
Module name: online (class i3pystatus.online.Online)

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) – Update interval
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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.openfiles.Openfiles[source]
Module name: openfiles (class i3pystatus.openfiles.Openfiles)

Displays the current/max open files.

Settings

  • filenr_path (default: /proc/sys/fs/file-nr) – Location to file-nr (usually /proc/sys/fs/file-nr
  • color (default: FFFFFF)
  • format (default: open/max: {openfiles}/{maxfiles})
  • interval (default: 30) – interval in seconds between module updates
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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]
Module name: openstack_vms (class i3pystatus.openstack_vms.Openstack_vms)

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_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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]
Module name: openvpn (class i3pystatus.openvpn.OpenVPN)

Monitor OpenVPN connections.

Note

This module currently only supports systemd. Additionally, as of OpenVPN 2.4 the unit names have changed, as the OpenVPN server and client now have distinct unit files (openvpn-server@.service and openvpn-client@.service, respectively). Those who have updated to OpenVPN 2.4 will need to manually set the status_command, vpn_up_command, and vpn_down_command.

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
  • use_new_service_name (default: False) – Use new openvpn service names (openvpn 2.4^)
  • vpn_up_command (default: sudo /bin/systemctl start openvpn@%(vpn_name)s.service) – Command to bring up the VPN - default requires editing /etc/sudoers
  • vpn_down_command (default: sudo /bin/systemctl stop openvpn@%(vpn_name)s.service) – Command to bring up the VPN - default requires editing /etc/sudoers
  • 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_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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.pagerduty.PagerDuty[source]
Module name: pagerduty (class i3pystatus.pagerduty.PagerDuty)

Module to get the current incidents in PD Requires pypd

Formatters:

  • {num_incidents} - current number of incidents unresolved
  • {num_acknowledged_incidents} - as it sounds
  • {num_triggered_incidents} - number of unacknowledged incidents

Example:

status.register(
    'pagerduty',
    api_key='mah_api_key',
    user_id='LKJ19QW'
)

Settings

  • format (default: {num_triggered_incidents} triggered  {num_acknowledged_incidents} acknowledged)
  • api_key (required) – pagerduty api key
  • color (default: #AA0000) – module text color
  • interval (default: 60) – refresh interval
  • user_id (default: empty) – your pagerduty user id, shows up in the url when viewing your profile https://subdomain.pagerduty.com/users/<user_id>
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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]
Module name: parcel (class i3pystatus.parcel.ParcelTracker)

Used to track parcel/shipments.

Supported carriers: DHL, UPS, DPD, Itella

  • parcel.UPS(“<id_code>”)
  • parcel.DHL(“<id_code>”)
  • parcel.DPD(“<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_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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]
Module name: pianobar (class i3pystatus.pianobar.Pianobar)

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_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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.ping.Ping[source]
Module name: ping (class i3pystatus.ping.Ping)

This module display the ping value between your computer and a host.

switch_state callback can disable the Ping when desired. host propertie can be changed for set a specific host.

Available formatters

  • {ping} the ping value in milliseconds.

Settings

  • color (default: #FFFFFF)
  • format (default: {ping} ms)
  • color_disabled (default: empty) – color when disabled
  • color_bad (default: #FFFF00) – color when latency is above threshold
  • color_down (default: #FF0000) – color when ping fail
  • format_disabled (default: empty) – format string when disabled
  • format_down (default: down) – format string when ping fail
  • latency_threshold (default: 120) – latency threshold in ms
  • host (default: 8.8.8.8) – host to ping
  • interval (default: 5) – interval in seconds between module updates
  • on_leftclick (default: switch_state) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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]
Module name: plexstatus (class i3pystatus.plexstatus.Plexstatus)

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

If you dont have an apikey you will need to follow this
https://support.plex.tv/hc/en-us/articles/204059436-Finding-your-account-token-X-Plex-Token

Formatters

  • {title} - title currently being streamed
  • {platform} - plex recognised platform of the streamer
  • {product} - plex product name on the streamer (Plex Web, Plex Media Player)
  • {address} - address of the streamer
  • {streamer_os} - operating system on the streaming device

Settings

  • format (default: {platform}: {title})
  • color (default: #00FF00)
  • apikey (required) – Your Plex API authentication key
  • 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
  • stream_divider (default: -) – divider between stream info when multiple streams are active
  • format_no_streams (default: empty) – String that is shown if nothing is being streamed
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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]
Module name: pomodoro (class i3pystatus.pomodoro.Pomodoro)

This plugin shows Pomodoro timer.

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

Example color settings.

color_map = {
    'stopped': '#2ECCFA',
    'running': '#FFFF00',
    'break': '#37FF00'
}

Settings

  • sound (default: empty) – 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
  • inactive_format (default: Start Pomodoro) – format string to display when no timer is running
  • color (default: empty) – dictionary containing a mapping of statuses to colours
  • interval (default: 1) – interval in seconds between module updates
  • on_leftclick (default: start) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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]
Module name: pulseaudio (class i3pystatus.pulseaudio.PulseAudio)

Shows volume of default PulseAudio sink (output).

Example configuration

The example configuration below uses only unicode to display the volume (tested with otf-font-awesome)

status.register(
    "pulseaudio",
    color_unmuted='#aa3300,
    color_muted='#aa0500',
    format_muted='',
    format='{volume_bar}',
    vertical_bar_width=1,
    vertical_bar_glyphs=['  ', ' ', '']
)

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
  • {selected} — show the format_selected string if selected sink is the configured one

Settings

  • format (default: ♪: {volume})
  • format_muted (default: empty) – optional format string to use when muted
  • format_selected (default: `` 🗸``) – string used to mark this sink if selected
  • muted (default: M)
  • unmuted (default: empty)
  • color_muted (default: #FF0000)
  • color_unmuted (default: #FFFFFF)
  • step (default: 5) – percentage to increment volume on scroll
  • sink (default: empty) – sink name to use, None means pulseaudio default
  • move_sink_inputs (default: True) – Move all sink inputs when we change the default sink
  • 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
  • vertical_bar_glyphs (default: empty) – custom array output as vertical bar instead of unicode bars
  • on_leftclick (default: pavucontrol) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle 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: change_sink) – Callback called on double left click (see Callbacks)
  • on_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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, eol, _)[source]

Updates self.output

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

A sink property changed, calls request_update

class i3pystatus.pyload.pyLoad[source]
Module name: pyload (class i3pystatus.pyload.pyLoad)

Shows pyLoad status

Available formatters

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

Settings

  • address (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_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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.random_password.RandomPassword[source]
Module name: random_password (class i3pystatus.random_password.RandomPassword)

Generates a random password and copies it to the clipboard. Useful if you use any password manager and you want to generate a password in the moment and save it later in you manager’s database.

Uses SystemRandom class as a cryptographically secure pseudo-number generator - <https://docs.python.org/3/library/random.html#random.SystemRandom>

  • Requires xsel or xclip for copying to the clipboard.
  • Generates a new password with a left click by default.
  • Generates a password with a default length of 12 and with lowercase, uppercase, digits and special symbols.

Available formatters

  • {length} — length of generated password

Settings

  • format (default: ) – Format string to be displayed in the status bar
  • length (default: 12) – Length of the generated password
  • charset (default: ['lowercase', 'uppercase', 'digits', 'special']) – Dictionary containing character types to be included in the password
  • cliptool (default: empty) – Currently supports xsel and xclip
  • color (default: empty) – HTML color hex code #RRGGBB
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle 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: generate_password) – Callback called on double left click (see Callbacks)
  • on_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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]
Module name: reddit (class i3pystatus.reddit.Reddit)

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

PRAW must be configured for this module to work. https://praw.readthedocs.io/en/latest/

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.
  • 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’.
  • time_filter (default: all) – ‘all’, ‘day’,’hour’, ‘month’, ‘week’, ‘year’
  • 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: {'new_mail': '✉', 'no_mail': ''}) – New message indicator.
  • on_leftclick (default: open_permalink) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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.redshift.Redshift[source]
Module name: redshift (class i3pystatus.redshift.Redshift)

Show status and control redshift - http://jonls.dk/redshift/.

This module runs an instance of redshift by itself, since it needs to parse its output, so you should remove redshift/redshift-gtk from your i3 config before using this module.

Requires redshift installed.

Available formatters

  • {inhibit} — show if redshift is currently On or Off (using toggle_inhibit callback)
  • {latitude} — location latitude
  • {longitude} — location longitude
  • {period} — current period (Day or Night)
  • {temperature} — current screen temperature in Kelvin scale (K)

Settings

  • color (default: #ffffff) – Text color
  • error_color (default: #ff0000) – Text color when an error occurs
  • format (default: {inhibit} {temperature}K)
  • format_inhibit (default: ['On', 'Off']) – List of 2 strings for {inhibit}, the first is shown when Redshift is On and the second is shown when Off
  • redshift_parameters (default: []) – List of parameters to pass to redshift binary
  • interval (default: 5) – interval in seconds between module updates
  • on_leftclick (default: toggle_inhibit) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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.
toggle_inhibit()[source]

Enable/disable redshift

class i3pystatus.regex.Regex[source]
Module name: regex (class i3pystatus.regex.Regex)

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_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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]
Module name: runwatch (class i3pystatus.runwatch.RunWatch)

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

Available formatters

  • {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_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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.sabnzbd.sabnzbd[source]
Module name: sabnzbd (class i3pystatus.sabnzbd.sabnzbd)

Displays the current status of SABnzbd.

A leftclick pauses/resumes downloading. A rightclick opens SABnzbd inside a browser.

Available formatters

Settings

  • format (default: {speed} - {timeleft}) – format string used for output
  • format_paused (default: {status}) – format string used if SABnzbd is paused
  • host (default: 127.0.0.1) – address of the server running SABnzbd
  • port (default: 8080) – port that SABnzbd is running on
  • api_key (default: empty) – api key of SABnzbd
  • color (default: #FFFFFF) – default color
  • color_paused (default: #FF0000) – color if SABnzbd is paused
  • color_downloading (default: #00FF00) – color if downloading
  • interval (default: 5) – interval in seconds between module updates
  • on_leftclick (default: pause_resume) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle click (see Callbacks)
  • on_rightclick (default: open_browser) – 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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.
init()[source]

Initialize the URL used to connect to SABnzbd.

is_downloading()[source]

Return True if downloads are running.

is_paused()[source]

Return True if downloads are currently paused.

open_browser()[source]

Open the URL of SABnzbd inside a browser.

pause_resume()[source]

Toggle between pausing or resuming downloading.

run()[source]

Connect to SABnzbd and get the data.

class i3pystatus.scores.Scores[source]
Module name: scores (class i3pystatus.scores.Scores)

This is a generic score checker, which must use at least one configured score backend.

Followed games can be scrolled through with the mouse/trackpad. Left-clicking on the module will refresh the scores, while right-clicking it will cycle through the configured backends. Double-clicking the module with the left button will launch the league-specific (MLB Gameday / NHL GameCenter / etc.) URL for the game. If there is not an active game, double-clicking will launch the league-specific scoreboard URL containing all games for the current day.

Double-clicking with the right button will reset the current backend to the first game in the scroll list. This is useful for quickly switching back to a followed team’s game after looking at other game scores.

Scores for the previous day’s games will be shown until 10am Eastern Time (US), after which time the current day’s games will be shown.

Available formatters

Formatters are set in the backend instances, see the Score Backends for more information.

This module supports the formatp extended string format syntax. This allows for values to be hidden when they evaluate as False (e.g. when a formatter is blank (an empty string). The default values for the format strings set in the score backends (format_pregame, format_in_progress, etc.) make heavy use of formatp, hiding many formatters when they are blank.

Usage example

from i3pystatus import Status
from i3pystatus.scores import mlb, nhl

status = Status()

status.register(
    'scores',
    hints={'markup': 'pango'},
    colorize_teams=True,
    favorite_icon='<span size="small" color="#F5FF00">★</span>',
    backends=[
        mlb.MLB(
            teams=['CWS', 'SF'],
            format_no_games='No games today :(',
            inning_top='⬆',
            inning_bottom='⬇',
        ),
        nhl.NHL(teams=['CHI']),
        nba.NBA(
            teams=['GSW'],
            all_games=False,
        ),
        epl.EPL(),
    ],
)

status.run()

To enable colorized team name/city/abbbreviation, colorize_teams must be set to True. This also requires that i3bar is configured to use Pango, and that the hints param is set for the module and includes a markup key, as in the example above. To ensure that i3bar is configured to use Pango, the font param in your i3 config file must start with pango:.

If a teams param is not specified for the backend, then all games for the current day will be tracked, and will be ordered by the start time of the game. Otherwise, only games from explicitly-followed teams will be tracked, and will be in the same order as listed. If ALL is part of the list, then games from followed teams will be first in the scroll list, followed by all remaining games in order of start time.

Therefore, in the above example, only White Sox and Giants games would be tracked, while in the below example all games would be tracked, with White Sox and Giants games appearing first in the scroll list and the remaining games appearing after them, in order of start time.

from i3pystatus import Status
from i3pystatus.scores import mlb

status = Status()

status.register(
    'scores',
    hints={'markup': 'pango'},
    colorize_teams=True,
    favorite_icon='<span size="small" color="#F5FF00">★</span>',
    backends=[
        mlb.MLB(
            teams=['CWS', 'SF', 'ALL'],
            team_colors={
                'NYM': '#1D78CA',
            },
        ),
    ],
)

status.run()

Troubleshooting

If the module gets stuck during an update (i.e. the refresh_icon does not go away), then the update thread probably encountered a traceback. This traceback will (by default) be logged to ~/.i3pystatus-<pid> where <pid> is the PID of the thread. However, it may be more convenient to manually set the logfile to make the location of the log data reliable and avoid clutter in your home directory. For example:

import logging
from i3pystatus import Status
from i3pystatus.scores import mlb, nhl

status = Status(
    logfile='/home/username/var/i3pystatus.log',
)

status.register(
    'scores',
    log_level=logging.DEBUG,
    backends=[
        mlb.MLB(
            teams=['CWS', 'SF'],
            log_level=logging.DEBUG,
        ),
        nhl.NHL(
            teams=['CHI'],
            log_level=logging.DEBUG,
        ),
        nba.NBA(
            teams=['CHI'],
            log_level=logging.DEBUG,
        ),
    ],
)

status.run()

Note

The log_level must be set separately in both the module and the backend instances (as shown above), otherwise the backends will still use the default log level.

Settings

  • backends (default: []) – List of backend instances
  • interval (default: 300) – Update interval (in seconds)
  • favorite_icon (default: ) – Value for the {away_favorite} and {home_favorite} formatter when the displayed game is being played by a followed team
  • color (default: empty) – Color to be used for non-colorized text (defaults to the i3bar color)
  • color_no_games (default: empty) – Color to use when no games are scheduled for the currently-displayed backend (defaults to the i3bar color)
  • colorize_teams (default: False) – Dislay team city, name, and abbreviation in the team’s color (as defined in the backend‘s team_colors attribute)
  • scroll_arrow (default: ) – Value used for the {scroll} formatter to indicate that more than one game is being tracked for the currently-displayed backend
  • refresh_icon (default: ) – Text to display (in addition to any text currently shown by the module) when refreshing scores. NOTE: Depending on how quickly the update is performed, the icon may not be displayed.
  • on_leftclick (default: ['check_scores', 'click event']) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle click (see Callbacks)
  • on_rightclick (default: ['cycle_backend', 1]) – Callback called on right click (see Callbacks)
  • on_upscroll (default: ['scroll_game', 1]) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: ['scroll_game', -1]) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: ['launch_web']) – Callback called on double left click (see Callbacks)
  • on_doublemiddleclick (default: empty) – Callback called on double middle click (see Callbacks)
  • on_doublerightclick (default: ['reset_backend']) – 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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.scratchpad.Scratchpad[source]
Module name: scratchpad (class i3pystatus.scratchpad.Scratchpad)

Display the amount of windows and indicate urgency hints on scratchpad (async).

fork from scratchpad_async of py3status by cornerman

Requires the PyPI package i3ipc.

Available formaters

  • {number} — amount of windows on scratchpad

@author jok @license BSD

Settings

  • format (default: {number} ) – format string.
  • always_show (default: True) – whether the indicator should be shown if there are no scratchpad windows
  • color_urgent (default: #900000) – color of urgent
  • color (default: #FFFFFF) – text color
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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.sensu.SensuCheck[source]
Module name: sensu (class i3pystatus.sensu.SensuCheck)

Pool sensu api events

Available formatters

  • {status} OK if not events else numbers of events
  • {last_event} Display the output of the most recent event (with priority on error event)

Settings

  • api_url (required) – URL of Sensu API. e.g: http://localhost/sensu/
  • api_username (default: empty)
  • api_password (default: empty)
  • format (default: {status})
  • color_error (default: #ff0000)
  • color_warn (default: #f9ba46)
  • color_ok (default: #00ff00)
  • last_event_label (default: Last:) – Label to put before the last event output (default ‘Last:’)
  • max_event_field (default: 50) – Defines max length of the last_event message field (default: 50)
  • interval (default: 5) – interval in seconds between module updates
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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]
Module name: sge (class i3pystatus.sge.SGETracker)

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_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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]
Module name: shell (class i3pystatus.shell.Shell)

Shows output of shell command

Available formatters

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

Settings

  • command (required) – command to be executed
  • ignore_empty_stdout (default: False) – Let the block be empty
  • 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_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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]
Module name: solaar (class i3pystatus.solaar.Solaar)

Shows status and load percentage of logitech’s unifying device

Available formatters

  • {output} — percentage of battery and status

Settings

  • nameOfDevice (required) – name of the logitech’s unifying 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_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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.sonos.Sonos[source]
Module name: sonos (class i3pystatus.sonos.Sonos)

Controls and displays information from Sonos devices.

A devices is found by IP, by name, or automatically if no IP or name is supplied.

Available formatters

  • {player_name} — player name
  • {volume} — volume from 0 to 100
  • {muted} — “M” if muted, else “”
  • {title} — the title of the current song
  • {artist} — the artist of the current song
  • {album} — the album of the current song
  • {duration} — duration of the current song (%M:%S)
  • {position} — position in the current song (%M:%S)
  • {state} — Playing, Paused, Stopped

Requires: soco (can be installed using pip)

Settings

  • ip (default: empty) – Speaker IP address.
  • name (default: empty) – Speaker name (used if no IP is given).
  • format (default: {state}: {artist} - {title} [{muted}{volume:.0f}%]) – Format used when playing or paused.
  • color (default: #FFFFFF) – Color used when playing or paused.
  • format_no_music (default: No music) – Format used when stopped.
  • color_no_music (default: #888888) – Color used when stopped.
  • format_no_connection (default: No connection) – Format used if no player is connected.
  • color_no_connection (default: #888888) – Color used if no player is connected.
  • hide_no_connection (default: False) – Hide output if no player is connected.
  • interval (default: 1) – interval in seconds between module updates
  • on_leftclick (default: play_pause) – Callback called on left click (see Callbacks)
  • on_middleclick (default: toggle_mute) – Callback called on middle click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: incr_vol) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: decr_vol) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: next_song) – Callback called on double left click (see Callbacks)
  • on_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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.spaceapi.SpaceAPI[source]
Module name: spaceapi (class i3pystatus.spaceapi.SpaceAPI)

Show if a hackerspace is open

Available formatters

  • {state}
  • {message}
  • {lastchange}

Settings

  • url (required) – spaceapi endpoint
  • format (default: S: {state}) – format string used for output.
  • color_open (default: #00FF00) – color if hackerspace is opened
  • color_closed (default: #FF0000) – color if hackerspace is closed
  • interval (default: 10) – update interval
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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]
Module name: spotify (class i3pystatus.spotify.Spotify)

Get Spotify info using dbus interface. Based on now_playing module.

Settings

  • player (default: spotify) – Player name. If not set, compatible players will be detected automatically.
  • status (default: {'pause': '▷', 'play': '▶', 'stop': '◾'}) – 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_middleclick (default: empty) – Callback called on middle click (see Callbacks)
  • on_rightclick (default: next_song) – Callback called on right click (see Callbacks)
  • on_upscroll (default: volume_up) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: volume_down) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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.swap.Swap[source]
Module name: swap (class i3pystatus.swap.Swap)

Shows swap load

Available formatters

  • {free}
  • {percent_used}
  • {used}
  • {total}

Requires psutil (from PyPI)

Settings

  • format (default: {free} MiB) – format string used for output.
  • format_no_swap (default: No swap) – format string used when no swap is enabled, set to None to use default format
  • hide_if_empty (default: False) – hide swap block when swap is not used
  • 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 when warn percentage is exceeded
  • alert_color (default: #FF0000) – defines the color used when alert percentage is exceeded
  • color_no_swap (default: #FFFFFF) – defines the color used when no swap is enabled, set to None to use default color
  • 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_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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.syncthing.Syncthing[source]
Module name: syncthing (class i3pystatus.syncthing.Syncthing)

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_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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.taskwarrior.Taskwarrior[source]
Module name: taskwarrior (class i3pystatus.taskwarrior.Taskwarrior)

Check Taskwarrior for pending tasks Requires json

Available formatters (uses formatp)

  • {ready} — contains number of tasks returned by ready_filter
  • {urgent} — contains number of tasks returned by urgent_filter
  • {next} — contains the description of next task
  • {project} — contains the projects the next task belongs to

Available callbacks

  • get_next_task — Display the next most urgent task.
  • get_prev_task — Display the previous most urgent task.
  • reset_next_task — Display the most urgent task, resetting any switching by other callbacks.

Settings

  • format (default: Task: {next}) – format string
  • ready_filter (default: +READY) – Filters to get ready tasks example: +READY
  • urgent_filter (default: +TODAY) – Filters to get urgent tasks example: +TODAY
  • enable_mark_done (default: False) – Enable right click mark task as done
  • color_urgent (default: #FF0000) – #FF0000
  • color_ready (default: #78EAF2) – #78EAF2
  • interval (default: 5) – interval in seconds between module updates
  • on_leftclick (default: reset_next_task) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle click (see Callbacks)
  • on_rightclick (default: mark_task_as_done) – Callback called on right click (see Callbacks)
  • on_upscroll (default: get_prev_task) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: get_next_task) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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.temp.Temperature[source]
Module name: temp (class i3pystatus.temp.Temperature)

Shows CPU temperature of Intel processors.

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

Requires colour module from PyPi

Modes of operation

If lm_sensors_enabled is set to False, the module operates in default mode. This means that:
  • only the {temp} formatter is available
  • alert_temp is honored
If lm_sensors_enabled is set to True, the module operates in lm_sensors mode. This means that:
  • pysensors must be installed (https://github.com/bastienleonard/pysensors)
  • CPU sensors are discovered dynamically (supporting a sensor per core and multiple CPUs)
  • alert_temp is ignored. The warning or critical values reported by the sensor are used instead (see urgent_on)

lm_sensors installation

In order to take advantage of the lm_sensors library and tools, it must first be installed and configured.

On Arch this is as simple as:

pacman -S lm_sensors

On Ubuntu:

sudo apt-get update && sudo apt-get install lm-sensors libsensors4-dev

The Arch Wiki has a good page on the library - https://wiki.archlinux.org/index.php/lm_sensors

lm_sensors_mode formatters

When lm_sensors_enabled is True the formatters are created dynamically. In order to discover the formatters that are available, it is best to run the sensors command:

⇒ sensors
coretemp-isa-0000
Adapter: ISA adapter
Physical id 0:  +48.0°C  (high = +80.0°C, crit = +99.0°C)
Core 0:         +48.0°C  (high = +80.0°C, crit = +99.0°C)
Core 1:         +46.0°C  (high = +80.0°C, crit = +99.0°C)
Core 2:         +43.0°C  (high = +80.0°C, crit = +99.0°C)
Core 3:         +47.0°C  (high = +80.0°C, crit = +99.0°C)

The module replaces spaces in sensor names with underscores, therefore from the above output we can identify the following sensor formatters:

  • Physical_id_0
  • Core_0
  • Core_1
  • Core_2
  • Core_3

For each sensor a vertical bar is also generated. In this example we would also have the following bars:

  • Physical_id_0_bar
  • Core_0_bar
  • Core_1_bar
  • Core_2_bar
  • Core_3_bar

Thus, this format string would be valid: “{Physical_id_0}°C {Core_0_bar}{Core_1_bar}{Core_2_bar}{Core_3_bar}”

Pango Markup and lm_sensors_mode

When Pango Markup is enabled and dynamic_color is True, each sensor’s formatter color is displayed independently. The color is determined by the proximity of the sensors current value to it’s critical value.

Example Configuration

Here is an example configuration based on the sensor values discovered above:

status.register("temp",
                format="{Physical_id_0}°C {Core_0_bar}{Core_1_bar}{Core_2_bar}{Core_3_bar}",
                hints={"markup": "pango"},
                lm_sensors_enabled=True,
                dynamic_color=True)

Settings

  • format (default: {temp} °C) – format string used for output. {temp} is the temperature in degrees celsius
  • display_if (default: True) – snippet that gets evaluated. if true, displays the module output
  • lm_sensors_enabled (default: False) – whether or not lm_sensors should be used for obtaining CPU temperature information
  • urgent_on (default: warning) – whether to flag as urgent when temperature exceeds urgent value or critical value (requires lm_sensors_enabled)
  • dynamic_color (default: False) – whether to set the color dynamically (overrides alert_color)
  • 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_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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.
format_sensor(sensor)[source]

Format a sensor value. If pango is enabled color is per sensor.

format_sensor_bar(sensor)[source]

Build and format a sensor bar. If pango is enabled bar color is per sensor.

get_output_original()[source]

Build the output the original way. Requires no third party libraries.

get_output_sensors()[source]

Build the output using lm_sensors. Requires sensors Python module (see docs).

get_urgent(sensors)[source]

Determine if any sensors should set the urgent flag.

class i3pystatus.teslacharge.TeslaCharge[source]
Module name: teslacharge (class i3pystatus.teslacharge.TeslaCharge)

Displays the current charge/range of your Tesla vehicle. There is a ton of data that could be displayed, so read this module to see the full list of datapoints that can be displayed. Requires: tesla_api

Settings

  • email (required) – Email address used to login to your Tesla account.
  • password (required) – Password for accessing your Tesla account.
  • units (default: miles) – Miles (default) or km
  • interval (default: 900) – Poll frequency. Polling too often can drain the battery
  • format_with_charge (default: {name}: {charge_state_icon}{charge_rate} {battery_level}%/{charge_limit_soc}% ({battery_range})) – Display format while car is charging
  • format_without_charge (default: {name}: {battery_level}%/{charge_limit_soc}% ({battery_range})) – Display format while car is not charging
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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]
Module name: text (class i3pystatus.text.Text)

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_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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]
Module name: timer (class i3pystatus.timer.Timer)

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_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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.timewarrior.Timewarrior[source]
Module name: timewarrior (class i3pystatus.timewarrior.Timewarrior)

Show current Timewarrior tracking Requires json dateutil

Formaters:

  • {tags} — contains tags of current track
  • {start} - contains start of track
  • {duration} — contains time of current track

Settings

  • format (default: {duration}) – format string
  • duration_format (default: {years}y{months}m{days}d{hours}h{minutes}m{seconds}s) – duration format string
  • enable_stop (default: True) – Allow right click to stop tracking
  • enable_continue (default: True) – ALlow right click to continue tracking
  • color_running (default: #00FF00) – #00FF00
  • color_stopped (default: #F00000) – #F00000
  • interval (default: 5) – interval in seconds between module updates
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle click (see Callbacks)
  • on_rightclick (default: stop_or_continue) – 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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.tlp.Tlp[source]
Module name: tlp (class i3pystatus.tlp.Tlp)

Shows the current mode of TLP (Linux power management tool), either battery, AC or unknown.

Available formatters

  • {output} - one of the strings configured through the *_text settings

Settings

  • last_pwr_file (default: /run/tlp/last_pwr) – path to the TLP ‘last pwr’ file, default is /run/tlp/last_pwr
  • bat_color (default: #00FF00) – color of text when TLP is in battery mode
  • ac_color (default: #FFAA00) – color of text when TLP is in AC mode
  • na_color (default: #FF0000) – color of text when TLP is in unknown mode
  • bat_text (default: BAT) – text to show when TLP is in battery mode
  • ac_text (default: AC) – text to show when TLP is in AC mode
  • na_text (default: N/A) – text to show when TLP is in unknown mode
  • format (default: {output})
  • interval (default: 5) – interval in seconds between module updates
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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.travisci.TravisCI[source]
Module name: travisci (class i3pystatus.travisci.TravisCI)

Get current status of travis builds Requires travispy dateutil.parser

Formatters:

  • {repo_slug} - repository owner/repository name
  • {repo_status} - repository status
  • {repo_name} - repository name
  • {repo_owner} - repository owner
  • {last_build_finished} - date of the last finished build
  • {last_build_duration} - duration of the last build

Examples

status_color_map = {
    'passed': '#00FF00',
    'failed': '#FF0000',
    'errored': '#FFAA00',
    'cancelled': '#EEEEEE',
    'started': '#0000AA',

}
repo_status_map={
    'passed': '<span color="#00af00">passed</span>',
    'started': '<span color="#0000af">started</span>',
    'failed': '<span color="#af0000">failed</span>',
}

Settings

  • format (default: {repo_owner}/{repo_name}-{repo_status} [({last_build_finished}({last_build_duration}))])
  • github_token (required) – github personal access token
  • repo_slug (required) – repository identifier eg. “enkore/i3pystatus”
  • time_format (default: %m/%d) – passed directly to .strftime() for last_build_finished
  • repo_status_map (default: empty) – map representing how to display status
  • duration_format (default: %m:%S) – last_build_duration format string
  • status_color_map (default: empty) – color for all text based on status
  • color (default: #DDDDDD) – color for all text not otherwise colored
  • interval (default: 5) – interval in seconds between module updates
  • on_leftclick (default: open_build_webpage) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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.uname.Uname[source]
Module name: uname (class i3pystatus.uname.Uname)

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_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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]
Module name: updates (class i3pystatus.updates.Updates)

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.

Right clicking shows a desktop notification with a summary count and a list of available updates.

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 capital 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 (required) – 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.
  • format_summary (default: empty) – Format for the summary line of notifications. By default the same as format.
  • notification_icon (default: software-update-available) – Icon shown when reporting the list of updates. Default is software-update-available, and can be None for no icon.
  • color (default: #00DD00)
  • color_no_updates (default: empty)
  • 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_middleclick (default: empty) – Callback called on middle click (see Callbacks)
  • on_rightclick (default: report) – 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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]
Module name: uptime (class i3pystatus.uptime.Uptime)

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_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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]
Module name: vk (class i3pystatus.vk.Vk)

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_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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]
Module name: weather (class i3pystatus.weather.Weather)

This is a generic weather-checker which must use a configured weather backend. For list of all available backends see Weather Backends.

Double-clicking on the module will launch the forecast page for the location being checked, and single-clicking will trigger an update.

Available formatters

  • {city} — Location of weather observation
  • {condition} — Current weather condition (Rain, Snow, Overcast, etc.)
  • {icon} — Icon representing the current weather condition
  • {observation_time} — Time of weather observation (supports strftime format flags)
  • {current_temp} — Current temperature, excluding unit
  • {low_temp} — Forecasted low temperature, excluding unit
  • {high_temp} — Forecasted high temperature, excluding unit (may be empty in the late afternoon)
  • {temp_unit} — Either °C or °F, depending on whether metric or
  • {feelslike} — “Feels Like” temperature, excluding unit
  • {dewpoint} — Dewpoint temperature, excluding unit imperial units are being used
  • {wind_speed} — Wind speed, excluding unit
  • {wind_unit} — Either kph or mph, depending on whether metric or imperial units are being used
  • {wind_direction} — Wind direction
  • {wind_gust} — Speed of wind gusts in mph/kph, excluding unit
  • {pressure} — Barometric pressure, excluding unit
  • {pressure_unit}mb or in, depending on whether metric or imperial units are being used
  • {pressure_trend}+ if rising, - if falling, or an empty string if the pressure is steady (neither rising nor falling)
  • {visibility} — Visibility distance, excluding unit
  • {visibility_unit} — Either km or mi, depending on whether metric or imperial units are being used
  • {humidity} — Current humidity, excluding percentage symbol
  • {uv_index} — UV Index
  • {update_error} — When the configured weather backend encounters an error during an update, this formatter will be set to the value of the backend’s update_error config value. Otherwise, this formatter will be an empty string.

This module supports the formatp extended string format syntax. This allows for values to be hidden when they evaluate as False. The default format string value for this module makes use of this syntax to conditionally show the value of the update_error config value when the backend encounters an error during an update.

See the following links for usage examples for the available weather backends:

Troubleshooting

If an error is encountered while updating, the {update_error} formatter will be set, and (provided it is in your format string) will show up next to the forecast to alert you to the error. The error message will (by default be logged to ~/.i3pystatus-<pid> where <pid> is the PID of the update thread. However, it may be more convenient to manually set the logfile to make the location of the log data predictable and avoid clutter in your home directory. Additionally, using the DEBUG log level can be helpful in revealing why the module is not working as expected. For example:

import logging
from i3pystatus import Status
from i3pystatus.weather import weathercom

status = Status(logfile='/home/username/var/i3pystatus.log')

status.register(
    'weather',
    format='{condition} {current_temp}{temp_unit}[ {icon}][ Hi: {high_temp}][ Lo: {low_temp}][ {update_error}]',
    colorize=True,
    hints={'markup': 'pango'},
    update_error='<span color="#ff0000">!</span>',
    log_level=logging.DEBUG,
    backend=weathercom.Weathercom(
        location_code='94107:4:US',
        units='imperial',
        log_level=logging.DEBUG,
    ),
)

Note

The log level must be set separately in both the module and backend contexts.

Settings

  • colorize (default: False) – Vary the color depending on the current conditions.
  • color_icons (default: {'Fair': ('☼', '#ffcc00'), 'Fog': ('', '#949494'), 'Cloudy': ('☁', '#f8f8ff'), 'Partly Cloudy': ('☁', '#f8f8ff'), 'Rainy': ('⛈', '#cbd2c0'), 'Thunderstorm': ('⚡', '#cbd2c0'), 'Sunny': ('☀', '#ffff00'), 'Snow': ('☃', '#ffffff'), 'default': ('', None)}) – Dictionary mapping weather conditions to tuples containing a UTF-8 code for the icon, and the color to be used.
  • color (default: empty) – Display color (or fallback color if colorize is True). If not specified, falls back to default i3bar color.
  • backend (required) – Weather backend instance
  • refresh_icon (default: ) – Text to display (in addition to any text currently shown by the module) when refreshing weather data. NOTE: Depending on how quickly the update is performed, the icon may not be displayed.
  • online_interval (default: empty) – seconds between updates when online (defaults to interval)
  • offline_interval (default: 300) – seconds between updates when offline (default: 300)
  • format (default: {current_temp}{temp_unit}[ {update_error}])
  • interval (default: 1800) – interval in seconds between module updates
  • on_leftclick (default: ['check_weather']) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle 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: ['launch_web']) – Callback called on double left click (see Callbacks)
  • on_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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.
check_weather()[source]

Check the weather using the configured backend

get_color_data(condition)[source]

Disambiguate similarly-named weather conditions, and return the icon and color that match.

class i3pystatus.weekcal.WeekCal[source]
Module name: weekcal (class i3pystatus.weekcal.WeekCal)

Displays the days of the current week as they would be represented on a calendar sheet, with the current day highlighted. By default, the current day of week is displayed in the front, and the month and year are displayed in the back.

Example: Sat  16 17 18 19 20[21]22  May 2016

Settings

  • startofweek (default: 0) – First day of the week (0 = Monday, 6 = Sunday), defaults to 0.
  • prefixformat (default: %a) – Prefix in strftime-format
  • suffixformat (default: %b %Y) – Suffix in strftime-format
  • todayhighlight (default: ('[', ']')) – Characters to highlight today’s date
  • interval (default: 30) – interval in seconds between module updates
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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.whosonlocation.WOL[source]
Module name: whosonlocation (class i3pystatus.whosonlocation.WOL)

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_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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.window_title.WindowTitle[source]
Module name: window_title (class i3pystatus.window_title.WindowTitle)

Display the current window title with async update. Uses asynchronous update via i3 IPC events. Provides instant title update only when it required.

fork from window_tile_async of py3status by Anon1234 https://github.com/Anon1234

Requires the PyPI package i3ipc.

Available formaters

  • {title} — title of current focused window
  • {class_name} - name of application class

@author jok @license BSD

Settings

  • format (default: {title}) – format string.
  • always_show (default: False) – do not hide the title when it can be already visible
  • empty_title (default: empty) – string that will be shown instead of the title when the title is hidden
  • max_width (default: 79) – maximum width of title
  • color (default: #FFFFFF) – text color
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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]
Module name: xkblayout (class i3pystatus.xkblayout.Xkblayout)

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"])

Requires xkbgroup (from PyPI)

Available formatters

  • {num} — current group number
  • {name} — current group name
  • {symbol} — current group symbol
  • {variant} — current group variant
  • {count} — number of all groups
  • {names} — names of all groups
  • {symbols} — symbols of all groups
  • {variants} — variants of all groups

Settings

  • color (default: #FFFFFF) – RGB hexadecimal color code specifuer, defaults to #FFFFFF
  • format (default: {symbol}) – Format string
  • layouts (default: []) – List of layouts
  • uppercase (default: True) – Flag for uppercase output
  • interval (default: 1) – interval in seconds between module updates
  • on_leftclick (default: ['change_layout', 1]) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle click (see Callbacks)
  • on_rightclick (default: empty) – Callback called on right click (see Callbacks)
  • on_upscroll (default: ['change_layout', 1]) – Callback called on scrolling up (see Callbacks)
  • on_downscroll (default: ['change_layout', -1]) – Callback called on scrolling down (see Callbacks)
  • on_doubleleftclick (default: empty) – Callback called on double left click (see Callbacks)
  • on_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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.yubikey.Yubikey[source]
Module name: yubikey (class i3pystatus.yubikey.Yubikey)

This module allows you to lock and unlock your Yubikey in order to avoid the OTP to be triggered accidentally.

@author Daniel Theodoro <daniel.theodoro AT gmail.com>

Settings

  • format (default: Yubikey: 🔒) – Format string
  • unlocked_format (default: Yubikey: 🔓) – Format string when the key is unlocked
  • timeout (default: 5) – How long the Yubikey will be unlocked (default: 5)
  • color (default: #00FF00) – Standard color
  • unlock_color (default: #FF0000) – Set the color used when the Yubikey is unlocked
  • interval (default: 1) – interval in seconds between module updates
  • on_leftclick (default: ['set_lock', True]) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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]
Module name: zabbix (class i3pystatus.zabbix.Zabbix)

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
  • groups (default: empty) – Provide groupids(e.g [‘102’, ‘10’])
  • filter (default: empty) – Provide API-Filter(e.g {‘status’: ‘1’})
  • min_severity (default: 2) – Specify min severity (0-5)
  • format (default: {default})
  • on_leftclick (default: empty) – Callback called on left click (see Callbacks)
  • on_middleclick (default: empty) – Callback called on middle 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_doublemiddleclick (default: empty) – Callback called on double middle 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)
  • on_otherclick (default: empty) – Callback called on other click (see Callbacks)
  • on_doubleotherclick (default: empty) – Callback called on double other click (see Callbacks)
  • on_change (default: empty) – Callback called when output is changed (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.ews.ExchangeMailAccount[source]
class i3pystatus.mail.ews.ExchangeMailAccount

Checks for mail on an Exchange account.

Requires the python exchangelib library - https://github.com/ecederstrand/exchangelib.

Settings

  • host (default: empty) – The url to connect to. If unset, autodiscover is tried with the email address domain. If set, autodiscover is disabled.
  • username (required)
  • password (required)
  • email_address (required)
  • keyring_backend (default: empty) – alternative keyring backend for retrieving credentials
  • account (default: empty) – Account name
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.mail.imap.IMAP[source]
class i3pystatus.mail.imap.IMAP

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]
class i3pystatus.mail.maildir.MaildirMail

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]
class i3pystatus.mail.mbox.MboxMail

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]
class i3pystatus.mail.notmuchmail.Notmuch

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

Settings

  • db_path (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]
class i3pystatus.mail.thunderbird.Thunderbird

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.

Score Backends

class i3pystatus.scores.epl.EPL[source]
class i3pystatus.scores.epl.EPL

Backend to retrieve scores from the English Premier League. For usage examples, see here.

Promotion / Relegation

Due to promotion/relegation, the team_colors configuration will eventuall become out of date. When this happens, it will be necessary to manually set the colors for the newly-promoted teams until the source for this module is updated. An example of setting colors for newly promoted teams can be seen below:

from i3pystatus import Status
from i3pystatus.scores import epl

status = Status()

status.register(
    'scores',
    hints={'markup': 'pango'},
    colorize_teams=True,
    backends=[
        epl.EPL(
            teams=['LIV'],
            team_colors={
                'ABC': '#1D78CA',
                'DEF': '#8AFEC3',
                'GHI': '#33FA6D',
            },
        ),
    ],
)

status.run()

Available formatters

  • {home_name} — Name of home team (e.g. Tottenham Hotspur)
  • {home_name_short} — Shortened team name (e.g. Spurs)
  • {home_abbrev} — 2 or 3-letter abbreviation for home team’s city (e.g.
    TOT)
  • {home_score} — Home team’s current score
  • {home_wins} — Home team’s number of wins
  • {home_losses} — Home team’s number of losses
  • {home_draws} — Home team’s number of draws
  • {home_points} — Home team’s number of standings points
  • {home_favorite} — Displays the value for the scores module’s favorite attribute, if the home team is one of the teams being followed. Otherwise, this formatter will be blank.
  • {away_name} — Name of away team (e.g. Manchester United)
  • {away_name_short} — Name of away team’s city (e.g. Man Utd)
  • {away_abbrev} — 2 or 3-letter abbreviation for away team’s name (e.g.
    MUN)
  • {away_score} — Away team’s current score
  • {away_wins} — Away team’s number of wins
  • {away_losses} — Away team’s number of losses
  • {away_draws} — Away team’s number of draws
  • {away_points} — Away team’s number of standings points
  • {away_favorite} — Displays the value for the scores module’s favorite attribute, if the away team is one of the teams being followed. Otherwise, this formatter will be blank.
  • {minute} — Current minute of game when in progress
  • {start_time} — Start time of game in system’s localtime (supports strftime formatting, e.g. {start_time:%I:%M %p})

Team abbreviations

  • ARS — Arsenal
  • AVL — Aston Villa
  • BOU — Bournemouth
  • CHE — Chelsea
  • CRY — Crystal Palace
  • EVE — Everton
  • LEI — Leicester City
  • LIV — Liverpool
  • MCI — Manchester City
  • MUN — Manchester United
  • NEW — Newcastle United
  • NOR — Norwich City
  • SOU — Southampton
  • STK — Stoke City
  • SUN — Sunderland Association
  • SWA — Swansea City
  • TOT — Tottenham Hotspur
  • WAT — Watford
  • WBA — West Bromwich Albion
  • WHU — West Ham United

Settings

  • favorite_teams (default: []) – List of abbreviations of favorite teams. Games for these teams will appear first in the scroll list. A detailed description of how games are ordered can be found here.
  • all_games (default: True) – If set to True, all games will be present in the scroll list. If set to False, then only games from favorite_teams will be present in the scroll list.
  • display_order (default: ['in_progress', 'final', 'pregame']) – When all_games is set to True, this option will dictate the order in which games from teams not in favorite_teams are displayed
  • format_no_games (default: EPL: No games) – Format used when no tracked games are scheduled for the current day (does not support formatter placeholders)
  • format_pregame (default: [{scroll} ]EPL: [{away_favorite} ]{away_abbrev} ({away_points}, {away_wins}-{away_losses}-{away_draws}) at [{home_favorite} ]{home_abbrev} ({home_points}, {home_wins}-{home_losses}-{home_draws}) {start_time:%H:%M %Z}) – Format used when the game has not yet started
  • format_in_progress (default: [{scroll} ]EPL: [{away_favorite} ]{away_abbrev} {away_score}[ ({away_power_play})], [{home_favorite} ]{home_abbrev} {home_score}[ ({home_power_play})] ({minute})) – Format used when the game is in progress
  • format_final (default: [{scroll} ]EPL: [{away_favorite} ]{away_abbrev} {away_score} ({away_points}, {away_wins}-{away_losses}-{away_draws}) at [{home_favorite} ]{home_abbrev} {home_score} ({home_points}, {home_wins}-{home_losses}-{home_draws}) (Final)) – Format used when the game is complete
  • team_colors (default: {'ARS': '#ED1B22', 'AVL': '#94BEE5', 'BOU': '#CB0B0F', 'CHE': '#195FAF', 'CRY': '#195FAF', 'EVE': '#004F9E', 'LEI': '#304FB6', 'LIV': '#D72129', 'MCI': '#74B2E0', 'MUN': '#DD1921', 'NEW': '#06B3EB', 'NOR': '#00A651', 'SOU': '#DB1C26', 'STK': '#D81732', 'SUN': '#BC0007', 'SWA': '#B28250', 'TOT': '#DADADA', 'WAT': '#E4D500', 'WBA': '#B43C51', 'WHU': '#9DE4FA'}) – Dictionary mapping team abbreviations to hex color codes. If overridden, the passed values will be merged with the defaults, so it is not necessary to define all teams if specifying this value.
  • date (default: empty) – Date for which to display game scores, in YYYY-MM-DD format. If unspecified, the date will be determined by the return value of an API call to the context_url. Due to API limitations, the date can presently only be overridden to another date in the current week. This option exists primarily for troubleshooting purposes.
  • live_url (default: http://live.premierleague.com/#/gameweek/%s/matchday/%s/match/%s) – URL string to launch EPL Live Match Centre. This value should not need to be changed.
  • scoreboard_url (default: http://live.premierleague.com/) – Link to the EPL scoreboard page. Like live_url, this value should not need to be changed.
  • api_url (default: http://live.premierleague.com/syndicationdata/competitionId=%s/seasonId=%s/gameWeekId=%s/scores.json) – Alternate URL string from which to retrieve score data. Like live_url, this value should not need to be changed.
  • stats_url (default: http://live.premierleague.com/syndicationdata/competitionId=%s/seasonId=%s/matchDayId=%s/league-table.json) – Alternate URL string from which to retrieve team statistics. Like live_url, this value should not need to be changed.
  • match_details_url (default: http://live.premierleague.com/syndicationdata/competitionId=%s/seasonId=%s/matchDayId=%s/matchId=%s/match-details.json) – Alternate URL string from which to retrieve match details. Like live_url, this value should not need to be changed.
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.scores.mlb.MLB[source]
class i3pystatus.scores.mlb.MLB

Backend to retrieve MLB scores. For usage examples, see here.

Available formatters

  • {home_name} — Name of home team
  • {home_city} — Name of home team’s city
  • {home_abbrev} — 2 or 3-letter abbreviation for home team’s city
  • {home_score} — Home team’s current score
  • {home_wins} — Home team’s number of wins
  • {home_losses} — Home team’s number of losses
  • {home_favorite} — Displays the value for the scores module’s favorite attribute, if the home team is one of the teams being followed. Otherwise, this formatter will be blank.
  • {away_name} — Name of away team
  • {away_city} — Name of away team’s city
  • {away_abbrev} — 2 or 3-letter abbreviation for away team’s city
  • {away_score} — Away team’s current score
  • {away_wins} — Away team’s number of wins
  • {away_losses} — Away team’s number of losses
  • {away_favorite} — Displays the value for the scores module’s favorite attribute, if the away team is one of the teams being followed. Otherwise, this formatter will be blank.
  • {top_bottom} — Displays the value of either inning_top or inning_bottom based on whether the game is in the top or bottom of an inning.
  • {inning} — Current inning
  • {outs} — Number of outs in current inning
  • {venue} — Name of ballpark where game is being played
  • {start_time} — Start time of game in system’s localtime (supports strftime formatting, e.g. {start_time:%I:%M %p})
  • {delay} — Reason for delay, if game is currently delayed. Otherwise, this formatter will be blank.
  • {postponed} — Reason for postponement, if game has been postponed. Otherwise, this formatter will be blank.
  • {extra_innings} — When a game lasts longer than 9 innings, this formatter will show that number of innings. Otherwise, it will blank.

Team abbreviations

  • ARI — Arizona Diamondbacks
  • ATL — Atlanta Braves
  • BAL — Baltimore Orioles
  • BOS — Boston Red Sox
  • CHC — Chicago Cubs
  • CIN — Cincinnati Reds
  • CLE — Cleveland Indians
  • COL — Colorado Rockies
  • CWS — Chicago White Sox
  • DET — Detroit Tigers
  • HOU — Houston Astros
  • KC — Kansas City Royals
  • LAA — Los Angeles Angels of Anaheim
  • LAD — Los Angeles Dodgers
  • MIA — Miami Marlins
  • MIL — Milwaukee Brewers
  • MIN — Minnesota Twins
  • NYY — New York Yankees
  • NYM — New York Mets
  • OAK — Oakland Athletics
  • PHI — Philadelphia Phillies
  • PIT — Pittsburgh Pirates
  • SD — San Diego Padres
  • SEA — Seattle Mariners
  • SF — San Francisco Giants
  • STL — St. Louis Cardinals
  • TB — Tampa Bay Rays
  • TEX — Texas Rangers
  • TOR — Toronto Blue Jays
  • WSH — Washington Nationals

Settings

  • favorite_teams (default: []) – List of abbreviations of favorite teams. Games for these teams will appear first in the scroll list. A detailed description of how games are ordered can be found here.
  • all_games (default: True) – If set to True, all games will be present in the scroll list. If set to False, then only games from favorite_teams will be present in the scroll list.
  • display_order (default: ['in_progress', 'suspended', 'final', 'postponed', 'pregame']) – When all_games is set to True, this option will dictate the order in which games from teams not in favorite_teams are displayed
  • format_no_games (default: MLB: No games) – Format used when no tracked games are scheduled for the current day (does not support formatter placeholders)
  • format_pregame (default: [{scroll} ]MLB: [{away_favorite} ]{away_abbrev} ({away_wins}-{away_losses}) at [{home_favorite} ]{home_abbrev} ({home_wins}-{home_losses}) {start_time:%H:%M %Z}[ ({delay} Delay)]) – Format used when the game has not yet started
  • format_in_progress (default: [{scroll} ]MLB: [{away_favorite} ]{away_abbrev} {away_score}, [{home_favorite} ]{home_abbrev} {home_score} ({top_bottom} {inning}, {outs} Out)[ ({delay} Delay)]) – Format used when the game is in progress
  • format_final (default: [{scroll} ]MLB: [{away_favorite} ]{away_abbrev} {away_score} ({away_wins}-{away_losses}) at [{home_favorite} ]{home_abbrev} {home_score} ({home_wins}-{home_losses}) (Final[/{extra_innings}])) – Format used when the game is complete
  • format_postponed (default: [{scroll} ]MLB: [{away_favorite} ]{away_abbrev} ({away_wins}-{away_losses}) at [{home_favorite} ]{home_abbrev} ({home_wins}-{home_losses}) (PPD: {postponed})) – Format used when the game has been postponed
  • format_suspended (default: [{scroll} ]MLB: [{away_favorite} ]{away_abbrev} {away_score} ({away_wins}-{away_losses}) at [{home_favorite} ]{home_abbrev} {home_score} ({home_wins}-{home_losses}) (Suspended: {suspended})) – Format used when the game has been suspended
  • inning_top (default: Top) – Value for the {top_bottom} formatter when game is in the top half of an inning
  • inning_bottom (default: Bot) – Value for the {top_bottom} formatter when game is in the bottom half of an inning
  • team_colors (default: {'ARI': '#A71930', 'ATL': '#CE1141', 'BAL': '#DF4601', 'BOS': '#BD3039', 'CHC': '#004EC1', 'CIN': '#C6011F', 'CLE': '#E31937', 'COL': '#5E5EB6', 'CWS': '#DADADA', 'DET': '#FF6600', 'HOU': '#EB6E1F', 'KC': '#0046DD', 'LAA': '#BA0021', 'LAD': '#005A9C', 'MIA': '#00A3E0', 'MIL': '#0747CC', 'MIN': '#D31145', 'NYY': '#0747CC', 'NYM': '#FF5910', 'OAK': '#006659', 'PHI': '#E81828', 'PIT': '#FFCC01', 'SD': '#285F9A', 'SEA': '#2E8B90', 'SF': '#FD5A1E', 'STL': '#B53B30', 'TB': '#8FBCE6', 'TEX': '#C0111F', 'TOR': '#0046DD', 'WSH': '#C70003'}) – Dictionary mapping team abbreviations to hex color codes. If overridden, the passed values will be merged with the defaults, so it is not necessary to define all teams if specifying this value.
  • date (default: empty) – Date for which to display game scores, in YYYY-MM-DD format. If unspecified, the current day’s games will be displayed starting at 10am Eastern time, with last evening’s scores being shown before then. This option exists primarily for troubleshooting purposes.
  • live_url (default: https://www.mlb.com/gameday/%s) – Alternate URL string to launch MLB Gameday. This value should not need to be changed
  • scoreboard_url (default: http://m.mlb.com/scoreboard) – Link to the MLB.com scoreboard page. Like live_url, this value should not need to be changed.
  • api_url (default: https://statsapi.mlb.com/api/v1/schedule?sportId=1,51&date=%04d-%02d-%02d&gameTypes=E,S,R,A,F,D,L,W&hydrate=team(),linescore(matchup,runners),stats,game(content(media(featured,epg),summary),tickets),seriesStatus(useOverride=true)&useLatestGames=false&language=en&leagueId=103,104,420) – Alternate URL string from which to retrieve score data. Like live_url* this value should not need to be changed.
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.scores.nba.NBA[source]
class i3pystatus.scores.nba.NBA

Backend to retrieve NBA scores. For usage examples, see here.

Available formatters

  • {home_name} — Name of home team
  • {home_city} — Name of home team’s city
  • {home_abbrev} — 3-letter abbreviation for home team’s city
  • {home_score} — Home team’s current score
  • {home_wins} — Home team’s number of wins
  • {home_losses} — Home team’s number of losses
  • {home_seed} — During the playoffs, shows the home team’s playoff seed. When not in the playoffs, this formatter will be blank.
  • {home_favorite} — Displays the value for the scores module’s favorite attribute, if the home team is one of the teams being followed. Otherwise, this formatter will be blank.
  • {away_name} — Name of away team
  • {away_city} — Name of away team’s city
  • {away_abbrev} — 2 or 3-letter abbreviation for away team’s city
  • {away_score} — Away team’s current score
  • {away_wins} — Away team’s number of wins
  • {away_losses} — Away team’s number of losses
  • {away_seed} — During the playoffs, shows the away team’s playoff seed. When not in the playoffs, this formatter will be blank.
  • {away_favorite} — Displays the value for the scores module’s favorite attribute, if the away team is one of the teams being followed. Otherwise, this formatter will be blank.
  • {time_remaining} — Time remaining in the current quarter/OT period
  • {quarter} — Number of the current quarter
  • {venue} — Name of arena where game is being played
  • {start_time} — Start time of game in system’s localtime (supports strftime formatting, e.g. {start_time:%I:%M %p})
  • {overtime} — If the game ended in overtime, this formatter will show OT. If the game ended in regulation, or has not yet completed, this formatter will be blank.

Team abbreviations

  • ATL — Atlanta Hawks
  • BKN — Brooklyn Nets
  • BOS — Boston Celtics
  • CHA — Charlotte Hornets
  • CHI — Chicago Bulls
  • CLE — Cleveland Cavaliers
  • DAL — Dallas Mavericks
  • DEN — Denver Nuggets
  • DET — Detroit Pistons
  • GSW — Golden State Warriors
  • HOU — Houston Rockets
  • IND — Indiana Pacers
  • MIA — Miami Heat
  • MEM — Memphis Grizzlies
  • MIL — Milwaukee Bucks
  • LAC — Los Angeles Clippers
  • LAL — Los Angeles Lakers
  • MIN — Minnesota Timberwolves
  • NOP — New Orleans Pelicans
  • NYK — New York Knicks
  • OKC — Oklahoma City Thunder
  • ORL — Orlando Magic
  • PHI — Philadelphia 76ers
  • PHX — Phoenix Suns
  • POR — Portland Trailblazers
  • SAC — Sacramento Kings
  • SAS — San Antonio Spurs
  • TOR — Toronto Raptors
  • UTA — Utah Jazz
  • WAS — Washington Wizards

Settings

  • favorite_teams (default: []) – List of abbreviations of favorite teams. Games for these teams will appear first in the scroll list. A detailed description of how games are ordered can be found here.
  • all_games (default: True) – If set to True, all games will be present in the scroll list. If set to False, then only games from favorite_teams will be present in the scroll list.
  • display_order (default: ['in_progress', 'final', 'pregame']) – When all_games is set to True, this option will dictate the order in which games from teams not in favorite_teams are displayed
  • format_no_games (default: NBA: No games) – Format used when no tracked games are scheduled for the current day (does not support formatter placeholders)
  • format_pregame (default: [{scroll} ]NBA: [{away_favorite} ][{away_seed} ]{away_abbrev} ({away_wins}-{away_losses}) at [{home_favorite} ][{home_seed} ]{home_abbrev} ({home_wins}-{home_losses}) {start_time:%H:%M %Z}) – Format used when the game has not yet started
  • format_in_progress (default: [{scroll} ]NBA: [{away_favorite} ]{away_abbrev} {away_score}[ ({away_power_play})], [{home_favorite} ]{home_abbrev} {home_score}[ ({home_power_play})] ({time_remaining} {quarter})) – Format used when the game is in progress
  • format_final (default: [{scroll} ]NBA: [{away_favorite} ]{away_abbrev} {away_score} ({away_wins}-{away_losses}) at [{home_favorite} ]{home_abbrev} {home_score} ({home_wins}-{home_losses}) (Final[/{overtime}])) – Format used when the game is complete
  • team_colors (default: {'ATL': '#E2383F', 'BKN': '#DADADA', 'BOS': '#178D58', 'CHA': '#00798D', 'CHI': '#CD1041', 'CLE': '#FDBA31', 'DAL': '#006BB7', 'DEN': '#5593C3', 'DET': '#207EC0', 'GSW': '#DEB934', 'HOU': '#CD1042', 'IND': '#FFBB33', 'MIA': '#A72249', 'MEM': '#628BBC', 'MIL': '#4C7B4B', 'LAC': '#ED174C', 'LAL': '#FDB827', 'MIN': '#35749F', 'NOP': '#A78F59', 'NYK': '#F68428', 'OKC': '#F05033', 'ORL': '#1980CB', 'PHI': '#006BB7', 'PHX': '#E76120', 'POR': '#B03037', 'SAC': '#7A58A1', 'SAS': '#DADADA', 'TOR': '#CD112C', 'UTA': '#4B7059', 'WAS': '#E51735'}) – Dictionary mapping team abbreviations to hex color codes. If overridden, the passed values will be merged with the defaults, so it is not necessary to define all teams if specifying this value.
  • date (default: empty) – Date for which to display game scores, in YYYY-MM-DD format. If unspecified, the current day’s games will be displayed starting at 10am Eastern time, with last evening’s scores being shown before then. This option exists primarily for troubleshooting purposes.
  • live_url (default: http://www.nba.com/gametracker/#/%s/lp) – URL string to launch NBA Game Tracker. This value should not need to be changed.
  • scoreboard_url (default: http://www.nba.com/scores) – Link to the NBA.com scoreboard page. Like live_url, this value should not need to be changed.
  • api_url (default: http://data.nba.com/data/10s/json/cms/noseason/scoreboard/%04d%02d%02d/games.json) – Alternate URL string from which to retrieve score data. Like, live_url, this value should not need to be changed.
  • standings_url (default: http://data.nba.com/data/json/cms/%s/league/standings.json) – Alternate URL string from which to retrieve team standings. Like live_url, this value should not need to be changed.
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.scores.nhl.NHL[source]
class i3pystatus.scores.nhl.NHL

Backend to retrieve NHL scores. For usage examples, see here.

Available formatters

  • {home_name} — Name of home team
  • {home_city} — Name of home team’s city
  • {home_abbrev} — 3-letter abbreviation for home team’s city
  • {home_score} — Home team’s current score
  • {home_wins} — Home team’s number of wins
  • {home_losses} — Home team’s number of losses
  • {home_otl} — Home team’s number of overtime losses
  • {home_favorite} — Displays the value for the scores module’s favorite attribute, if the home team is one of the teams being followed. Otherwise, this formatter will be blank.
  • {home_empty_net} — Shows the value from the empty_net parameter when the home team’s net is empty.
  • {away_name} — Name of away team
  • {away_city} — Name of away team’s city
  • {away_abbrev} — 2 or 3-letter abbreviation for away team’s city
  • {away_score} — Away team’s current score
  • {away_wins} — Away team’s number of wins
  • {away_losses} — Away team’s number of losses
  • {away_otl} — Away team’s number of overtime losses
  • {away_favorite} — Displays the value for the scores module’s favorite attribute, if the away team is one of the teams being followed. Otherwise, this formatter will be blank.
  • {away_empty_net} — Shows the value from the empty_net parameter when the away team’s net is empty.
  • {period} — Current period
  • {venue} — Name of arena where game is being played
  • {start_time} — Start time of game in system’s localtime (supports strftime formatting, e.g. {start_time:%I:%M %p})
  • {overtime} — If the game ended in overtime or a shootout, this formatter will show OT kor SO. If the game ended in regulation, or has not yet completed, this formatter will be blank.

Playoffs

In the playoffs, losses are not important (as the losses will be equal to the other team’s wins). Therefore, it is a good idea during the playoffs to manually set format strings to exclude information on team losses. For example:

from i3pystatus import Status
from i3pystatus.scores import nhl

status = Status()
status.register(
    'scores',
    hints={'markup': 'pango'},
    colorize_teams=True,
    favorite_icon='<span size="small" color="#F5FF00">★</span>',
    backends=[
        nhl.NHL(
            favorite_teams=['CHI'],
            format_pregame = '[{scroll} ]NHL: [{away_favorite} ]{away_abbrev} ({away_wins}) at [{home_favorite} ]{home_abbrev} ({home_wins}) {start_time:%H:%M %Z}',
            format_final = '[{scroll} ]NHL: [{away_favorite} ]{away_abbrev} {away_score} ({away_wins}) at [{home_favorite} ]{home_abbrev} {home_score} ({home_wins}) (Final[/{overtime}])',
        ),
    ],
)

Team abbreviations

  • ANA — Anaheim Ducks
  • ARI — Arizona Coyotes
  • BOS — Boston Bruins
  • BUF — Buffalo Sabres
  • CAR — Carolina Hurricanes
  • CBJ — Columbus Blue Jackets
  • CGY — Calgary Flames
  • CHI — Chicago Blackhawks
  • COL — Colorado Avalanche
  • DAL — Dallas Stars
  • DET — Detroit Red Wings
  • EDM — Edmonton Oilers
  • FLA — Florida Panthers
  • LAK — Los Angeles Kings
  • MIN — Minnesota Wild
  • MTL — Montreal Canadiens
  • NJD — New Jersey Devils
  • NSH — Nashville Predators
  • NYI — New York Islanders
  • NYR — New York Rangers
  • OTT — Ottawa Senators
  • PHI — Philadelphia Flyers
  • PIT — Pittsburgh Penguins
  • SJS — San Jose Sharks
  • STL — St. Louis Blues
  • TBL — Tampa Bay Lightning
  • TOR — Toronto Maple Leafs
  • VAN — Vancouver Canucks
  • VGK — Vegas Golden Knights
  • WPG — Winnipeg Jets
  • WSH — Washington Capitals

Settings

  • favorite_teams (default: []) – List of abbreviations of favorite teams. Games for these teams will appear first in the scroll list. A detailed description of how games are ordered can be found here.
  • all_games (default: True) – If set to True, all games will be present in the scroll list. If set to False, then only games from favorite_teams will be present in the scroll list.
  • display_order (default: ['in_progress', 'final', 'pregame']) – When all_games is set to True, this option will dictate the order in which games from teams not in favorite_teams are displayed
  • format_no_games (default: NHL: No games) – Format used when no tracked games are scheduled for the current day (does not support formatter placeholders)
  • format_pregame (default: [{scroll} ]NHL: [{away_favorite} ]{away_abbrev} ({away_wins}-{away_losses}-{away_otl}) at [{home_favorite} ]{home_abbrev} ({home_wins}-{home_losses}-{home_otl}) {start_time:%H:%M %Z}) – Format used when the game has not yet started
  • format_in_progress (default: [{scroll} ]NHL: [{away_favorite} ]{away_abbrev} {away_score}[ ({away_power_play})][ ({away_empty_net})], [{home_favorite} ]{home_abbrev} {home_score}[ ({home_power_play})][ ({home_empty_net})] ({time_remaining} {period})) – Format used when the game is in progress
  • format_final (default: [{scroll} ]NHL: [{away_favorite} ]{away_abbrev} {away_score} ({away_wins}-{away_losses}-{away_otl}) at [{home_favorite} ]{home_abbrev} {home_score} ({home_wins}-{home_losses}-{home_otl}) (Final[/{overtime}])) – Format used when the game is complete
  • empty_net (default: EN) – Value for the {away_empty_net} or {home_empty_net} formatter when the net is empty. When the net is not empty, these formatters will be empty strings.
  • team_colors (default: {'ANA': '#B4A277', 'ARI': '#AC313A', 'BOS': '#F6BD27', 'BUF': '#1568C5', 'CAR': '#FA272E', 'CBJ': '#1568C5', 'CGY': '#D23429', 'CHI': '#CD0E24', 'COL': '#9F415B', 'DAL': '#058158', 'DET': '#E51937', 'EDM': '#2F6093', 'FLA': '#E51837', 'LAK': '#DADADA', 'MIN': '#176B49', 'MTL': '#C8011D', 'NJD': '#CC0000', 'NSH': '#FDB71A', 'NYI': '#F8630D', 'NYR': '#1576CA', 'OTT': '#C50B2F', 'PHI': '#FF690B', 'PIT': '#FFB81C', 'SJS': '#007888', 'STL': '#1764AD', 'TBL': '#296AD5', 'TOR': '#296AD5', 'VAN': '#0454FA', 'VGK': '#B4975A', 'WPG': '#1568C5', 'WSH': '#E51937'}) – Dictionary mapping team abbreviations to hex color codes. If overridden, the passed values will be merged with the defaults, so it is not necessary to define all teams if specifying this value.
  • date (default: empty) – Date for which to display game scores, in YYYY-MM-DD format. If unspecified, the current day’s games will be displayed starting at 10am Eastern time, with last evening’s scores being shown before then. This option exists primarily for troubleshooting purposes.
  • live_url (default: https://www.nhl.com/gamecenter/%s) – URL string to launch NHL GameCenter. This value should not need to be changed.
  • scoreboard_url (default: https://www.nhl.com/scores) – Link to the NHL.com scoreboard page. Like live_url, this value should not need to be changed.
  • api_url (default: https://statsapi.web.nhl.com/api/v1/schedule?startDate=%04d-%02d-%02d&endDate=%04d-%02d-%02d&expand=schedule.teams,schedule.linescore,schedule.broadcasts.all&site=en_nhl&teamId=) – Alternate URL string from which to retrieve score data. Like live_url, this value should not need to be changed.
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.

Update Backends

class i3pystatus.updates.aptget.AptGet[source]
class i3pystatus.updates.aptget.AptGet

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.auracle.Auracle[source]
class i3pystatus.updates.auracle.Auracle

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

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

Settings

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

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.dnf.Dnf[source]
class i3pystatus.updates.dnf.Dnf

Gets updates for RPM-based distributions using the DNF API

The notification body consists of the package name and version for each available update.

Note

Users running i3pystatus from a virtualenv may see the updates display as ? due to an inability to import the dnf module. To ensure that i3pystatus can access the DNF Python bindings, the virtualenv should be created with --system-site-packages.

If using pyenv-virtualenv, the virtualenv must additionally be created to use the system Python binary:

$ pyenv virtualenv --system-site-packages --python=/usr/bin/python3 pyenv_name

To invoke i3pystatus with this virtualenv, your bar section in ~/.config/i3/config would look like this:

bar {
    position top
    status_command PYENV_VERSION=pyenv_name python /path/to/i3pystatus/script.py
}

Settings

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

Gets update count for distributions using PackageKit.

At the moment, it works with english localization, only.

Settings

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

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

Settings

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

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()])

To count both pacman and aur packages, pass False in the constructor:

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.
class i3pystatus.updates.yay.Yay[source]
class i3pystatus.updates.yay.Yay

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

from i3pystatus.updates import pacman, yay
status.register("updates", backends = [pacman.Pacman(), yay.Yay()])

To count both pacman and aur packages, pass False in the constructor:

from i3pystatus.updates import yay
status.register("updates", backends = [yay.Yay(False)])

Settings

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

Weather Backends

class i3pystatus.weather.weathercom.Weathercom[source]
class i3pystatus.weather.weathercom.Weathercom

This module gets the weather from weather.com. The location_code parameter should be set to the location code from weather.com. To obtain this code, search for your location on weather.com, and when you go to the forecast page, the code you need will be everything after the last slash in the URL (e.g. 94107:4:US, or 8b7867695971473a260df2c5d49ff92dc9079dcb673c545f5f107f5c4ab30732).

Usage example

from i3pystatus import Status
from i3pystatus.weather import weathercom

status = Status(logfile='/home/username/var/i3pystatus.log')

status.register(
    'weather',
    format='{condition} {current_temp}{temp_unit}[ {icon}][ Hi: {high_temp}][ Lo: {low_temp}][ {update_error}]',
    interval=900,
    colorize=True,
    hints={'markup': 'pango'},
    backend=weathercom.Weathercom(
        location_code='94107:4:US',
        units='imperial',
        update_error='<span color="#ff0000">!</span>',
    ),
)

status.run()

See here for a list of formatters which can be used.

Settings

  • location_code (required) – Location code from www.weather.com
  • units (default: metric) – ‘metric’ or ‘imperial’
  • update_error (default: !) – Value for the {update_error} formatter when an error is encountered while checking weather data
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
check_weather()[source]

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

class i3pystatus.weather.wunderground.Wunderground[source]
class i3pystatus.weather.wunderground.Wunderground

This module retrieves weather data from Weather Underground.

Note

Previous versions of this module required an API key to work. Weather Underground has since discontinued their API, and this module has been rewritten to reflect that.

Finding your weather station

To use this module, you must provide a weather station code (as the location_code option). To find your weather station, first search for your city and click to view the current conditions. Below the city name you will see the station name, and to the right of that a CHANGE link. Clicking that link will display a map, where you can find the station closest to you. Clicking on that station will take you back to the current conditions page. The weather station code will now be the last part of the URL. For example:

https://www.wunderground.com/weather/us/ma/cambridge/KMACAMBR4

In this case, the weather station code would be KMACAMBR4.

Usage example

from i3pystatus import Status
from i3pystatus.weather import wunderground

status = Status(logfile='/home/username/var/i3pystatus.log')

status.register(
    'weather',
    format='{condition} {current_temp}{temp_unit}[ {icon}][ Hi: {high_temp}][ Lo: {low_temp}][ {update_error}]',
    colorize=True,
    hints={'markup': 'pango'},
    backend=wunderground.Wunderground(
        location_code='KMACAMBR4',
        units='imperial',
        update_error='<span color="#ff0000">!</span>',
    ),
)

status.run()

See here for a list of formatters which can be used.

Settings

  • location_code (required) – Location code from wunderground.com
  • units (default: metric) – ‘metric’ or ‘imperial’
  • update_error (default: !) – Value for the {update_error} formatter when an error is encountered while checking weather data
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
check_weather()[source]

Query the desired station and return the weather data

get_api_key()[source]

Grab the API key out of the page source from the home page

Calendar Backends

Generic calendar interface. Requires the PyPI package colour.

Available formatters

  • {title} - the title or summary of the event
  • {remaining_time} - how long until this event is due

Additional formatters may be provided by the backend, consult their documentation for details.

Settings

  • {update_interval} - how often (in seconds) the calendar backend should be called to update events
  • {dynamic_color} - when set, the color shifts as the event approaches
  • {urgent_blink} - when set, urgent is toggled every second when within urgent_seconds of the event
  • {urgent_seconds} - how many seconds before the event to begin blinking
  • {skip_recurring} - when set, recurring events are skipped

Here is an example of configuring the calendar module to use the Lightning backend:

status.register("calendar",
            format="{title} {remaining}",
            update_interval=10,
            urgent_blink=True,
            backend=Lightning(database_path=path, days=2))

class i3pystatus.calendar.google.Google[source]
class i3pystatus.calendar.google.Google

Calendar backend for interacting with Google Calendar.

Requires the Google Calendar API package - https://developers.google.com/google-apps/calendar/quickstart/python. Additionally requires the colour, httplib2, oauth2client, pytz, google-api-python-client and dateutil modules.

The first time this module is ran, you will need to specify the location of credentials.json (as credentials_json) acquired from: https://developers.google.com/google-apps/calendar/quickstart/python this will open a browser window for auth, and save a token to credential_path. you will need to reload i3poystatus afterwards

If you already have a token credentials_json is not required (though highly recomended incase your token gets broken)

Available formatters

  • {kind} — type of event
  • {status} — eg, confirmed
  • {htmlLink} — link to the calendar event

Settings

  • credential_path (required) – Path to save credentials to (auto generated the first time this module is ran)
  • credentials_json (default: empty) – path to credentials.json (generated by google)
  • days (default: 7) – Only show events between now and this many days in the future
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
get_timerange_formatted(now)[source]

Return two ISO8601 formatted date strings, one for timeMin, the other for timeMax (to be consumed by get_events)

refresh_events()[source]

Retrieve the next N events from Google.

class i3pystatus.calendar.khal_calendar.Khal[source]
class i3pystatus.calendar.khal_calendar.Khal

Backend for Khal. Requires khal to be installed.

Available formatters * {calendar} — Calendar event is from.

Settings

  • config_path (default: empty) – Path to your khal.conf
  • calendars (default: empty) – Restrict to these calendars pass as a list)
  • days (default: 7) – Check for the next X days
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.
class i3pystatus.calendar.lightning.Lightning[source]
class i3pystatus.calendar.lightning.Lightning

Backend for querying the Thunderbird’s Lightning database. Requires pytz and dateutil.

Available formatters

  • {location} — Where the event occurs

Settings

  • database_path (required) – Path to local.sqlite.
  • days (default: 7) – Only show events between now and this many days in the future
  • log_level (default: 30) – Set to true to log error to .i3pystatus-<pid> file.