Module reference¶
System: | clock - disk - load - mem - cpu_usage |
---|---|
Audio: | alsa - pulseaudio |
Hardware: | battery - backlight - temp |
Network: | network - wireless |
Music: | now_playing - mpd |
Websites & stuff: | |
weather - bitcoin - reddit - parcel | |
Other: | mail - pyload - text |
Advanced: | file - regex - runwatch - shell |
Note
List of all modules:
alsa
backlight
battery
bitcoin
clock
cmus
cpu_usage
cpu_usage_bar
cpu_usage_graph
disk
file
keyboard_locks
load
mail
mem
mem_bar
modsde
mpd
network
network_graph
network_traffic
now_playing
parcel
pianobar
pomodoro
pulseaudio
pyload
reddit
regex
runwatch
shell
spotify
temp
text
uname
uptime
weather
wireless
-
class
i3pystatus.alsa.
ALSA
[source]¶ Shows volume of ALSA mixer. You can also use this for inputs, btw.
Requires pyalsaaudio
Available formatters
- {volume} — the current volume in percent
- {muted} — the value of one of the muted or unmuted settings
- {card} — the associated soundcard
- {mixer} — the associated ALSA mixer
Settings
- format (default:
♪: {volume}
) - format_muted (default: empty) – optional format string to use when muted
- mixer (default:
Master
) – ALSA mixer - mixer_id (default:
0
) – ALSA mixer id - card (default:
0
) – ALSA sound card - increment (default:
5
) – integer percentage of max volume to in/decrement volume on mousewheel - muted (default:
M
) - unmuted (default: empty)
- color_muted (default:
#AAAAAA
) - color (default:
#FFFFFF
) - channel (default:
0
) - interval (default:
1
)
-
class
i3pystatus.backlight.
Backlight
[source]¶ Screen backlight info
Available formatters
- {brightness} — current brightness relative to max_brightness
- {max_brightness} — maximum brightness value
- {percentage} — current brightness in percent
Settings
- format (default:
{brightness}/{max_brightness}
) – format string, formatters: brightness, max_brightness, percentage - backlight (default:
acpi_video0
) – backlight, see /sys/class/backlight/ - color (default:
#FFFFFF
) - interval (default:
5
)
-
class
i3pystatus.battery.
BatteryChecker
[source]¶ This class uses the /sys/class/power_supply/…/uevent interface to check for the battery status
Available formatters
- {remaining} — remaining time for charging or discharging, uses TimeWrapper formatting, default format is %E%h:%M
- {percentage} — battery percentage relative to the last full value
- {percentage_design} — absolute battery charge percentage
- {consumption (Watts)} — current power flowing into/out of the battery
- {status}
- {battery_ident} — the same as the setting
- {bar} —bar displaying the percentage graphically
Settings
- battery_ident (default:
BAT0
) – The name of your battery, usually BAT0 or BAT1 - format (default:
{status} {remaining}
) - not_present_text (default:
Battery not present
) – Text displayed if the battery is not present. No formatters are available - alert (default:
False
) – Display a libnotify-notification on low battery - alert_percentage (default:
10
) - alert_format_title (default:
Low battery
) – The title of the notification, all formatters can be used - alert_format_body (default:
Battery {battery_ident} has only {percentage:.2f}% ({remaining:%E%hh:%Mm}) remaining!
) – The body text of the notification, all formatters can be used - path (default: empty) – Override the default-generated path
- status (default:
{'DIS': 'DIS', 'CHR': 'CHR', 'FULL': 'FULL'}
) – A dictionary mapping (‘DIS’, ‘CHR’, ‘FULL’) to alternative names - color (default:
#ffffff
) – The text color - full_color (default:
#00ff00
) – The full color - charging_color (default:
#00ff00
) – The charging color - critical_color (default:
#ff0000
) – The critical color - not_present_color (default:
#ffffff
) – The not present color. - no_text_full (default:
False
) – Don’t display text when battery is full - 100% - interval (default:
5
)
-
class
i3pystatus.bitcoin.
Bitcoin
[source]¶ This module fetches and displays current Bitcoin market prices and optionally monitors transactions to and from a list of user-specified wallet addresses. Market data is pulled from the BitcoinAverage Price Index API <https://bitcoinaverage.com> while transaction data is pulled from blockchain.info <https://blockchain.info/api/blockchain_api>.
Available formatters
- {last_price}
- {ask_price}
- {bid_price}
- {daily_average}
- {volume}
- {status}
- {last_tx_type}
- {last_tx_addr}
- {last_tx_value}
- {balance_btc}
- {balance_fiat}
Settings
- format (default:
฿ {status}{last_price}
) – Format string used for output. - currency (default:
USD
) – Base fiat currency used for pricing. - wallet_addresses (default: empty) – List of wallet address(es) to monitor.
- color (default:
#FFFFFF
) – Standard color - colorize (default:
False
) – Enable color change on price increase/decrease - color_up (default:
#00FF00
) – Color for price increases - color_down (default:
#FF0000
) – Color for price decreases - leftclick (default:
electrum
) – URL to visit or command to run on left click - rightclick (default:
https://bitcoinaverage.com/
) – URL to visit or command to run on right click - interval (default:
600
) – Update interval. - status (default:
{'price_down': '▼', 'price_up': '▲'}
)
-
class
i3pystatus.clock.
Clock
[source]¶ This class shows a clock
format can be passed in four different ways:
- single string, no timezone, just the strftime-format
- one two-tuple, first is the format, second the timezone
- list of strings - no timezones
- list of two tuples, first is the format, second is timezone
Settings
- format (default: empty) – None means to use the default, locale-dependent format. Can cycle between formats with mousewheel
- color (default:
#ffffff
) – RGB hexadecimal code color specifier, default to #ffffff, set to i3Bar to use i3 bar default - interval (default:
1
)
-
class
i3pystatus.cmus.
Cmus
[source]¶ Gets the status and current song info using cmus-remote
Available formatters
- {status} — current status icon (paused/playing/stopped)
- {song_elapsed} — song elapsed time (mm:ss format)
- {song_length} — total song duration (mm:ss format)
- {artist} — artist
- {title} — title
- {album} — album
- {tracknumber} — tracknumber
- {file} — file or url name
- {stream} — song name from stream
- {bitrate} — bitrate
Settings
- format (default:
{status} {song_elapsed}/{song_length} {artist} - {title}
) – format string, available formatters: status, song_elapsed, song_length, artist, title, album, tracknumber, file, stream, bitrate - color (default:
#909090
) - interval (default:
1
)
-
class
i3pystatus.cpu_usage.
CpuUsage
[source]¶ Shows CPU usage. The first output will be inacurate.
Linux only
Available formatters
- {usage} usage average of all cores
- {usage_cpu*} usage of one specific core. replace “*” by core number starting at 0
- {usage_all} usage of all cores separate. usess natsort when available(relevant for more than 10 cores)
Settings
- format (default:
{usage:02}%
) – format string. - format_all (default:
{core}:{usage:02}%
) – format string used for {usage_all} per core. Available formaters are {core} and {usage}. - exclude_average (default:
False
) – If True usage average of all cores will not be in format_all. - interval (default:
5
)
-
class
i3pystatus.cpu_usage_bar.
CpuUsageBar
[source]¶ Shows CPU usage as a bar (made with unicode box characters). The first output will be inacurate.
Linux only
Requires the PyPI package colour.
Available formatters
- {usage_bar} usage average of all cores
- {usage_bar_cpuN} usage of one specific core. replace “N” 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_bar
) – 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’ - interval (default:
5
)
-
class
i3pystatus.cpu_usage_graph.
CpuUsageGraph
[source]¶ Shows CPU usage as a Unicode graph. The first output will be inacurate.
Depends on the PyPI colour module - https://pypi.python.org/pypi/colour/0.0.5
Linux only
Available formatters
- {cpu_graph} graph of cpu usage.
- {usage} usage average of all cores
- {usage_cpu*} usage of one specific core. replace “*” by core number starting at 0
- {usage_all} usage of all cores separate. usess natsort when available(relevant for more than 10 cores)
Settings
- cpu (default:
usage_cpu
) – cpu to monitor, choices are ‘usage_cpu’ for all or ‘usage_cpu*’. Replace ‘*’ by core number starting at 0. - start_color (default:
#00FF00
) – Hex or English name for start of color range, eg ‘#00FF00’ or ‘green’ - end_color (default:
red
) – Hex or English name for end of color range, eg ‘#FF0000’ or ‘red’ - interval (default:
5
)
-
class
i3pystatus.disk.
Disk
[source]¶ Gets
{used}
,{free}
,{available}
and{total}
amount of bytes on the given mounted filesystem.These values can also be expressed as percentages with the
{percentage_used}
,{percentage_free}
and{percentage_avail}
formats.Settings
- format (default:
{free}/{avail}
) - path (required)
- divisor (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 - interval (default:
5
)
- format (default:
-
class
i3pystatus.file.
File
[source]¶ Rip information from text files
components is a dict of pairs of the form:
name => (callable, file)
- Where name is a valid identifier, which is used in the format string to access the value of that component.
- callable is some callable to convert the contents of file. A common choice is float or int.
- file names a file, relative to base_path.
transforms is a optional dict of callables taking a single argument (a dictionary containing the values of all components). The return value is bound to the key.
Settings
- format (required)
- components (required)
- transforms (default:
{}
) - base_path (default:
/
) - color (default:
#FFFFFF
) - interval (default:
5
)
-
class
i3pystatus.keyboard_locks.
Keyboard_locks
[source]¶ Shows the status of CAPS LOCK, NUM LOCK and SCROLL LOCK
Available formatters:
- {caps} — the current status of CAPS LOCK
- {num} — the current status of NUM LOCK
- {scroll} — the current status of SCROLL LOCK
Settings
- format (default:
{caps} {num} {scroll}
) – Format string. Available formaters are {core} and {usage}. - 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
)
-
class
i3pystatus.load.
Load
[source]¶ Shows system load
Settings
- format (default:
{avg1} {avg5}
) – format string used for output. {avg1}, {avg5} and {avg15} are the load average of the last one, five and fifteen minutes, respectively. {tasks} is the number of tasks (i.e. 1/285, which indiciates that one out of 285 total tasks is runnable). - color (default:
#ffffff
) – The text color - critical_limit (default:
1
) – Limit above which the load is considered critical - critical_color (default:
#ff0000
) – The critical color - interval (default:
5
)
- format (default:
-
class
i3pystatus.mail.
Mail
[source]¶ Generic mail checker
The backends setting determines the backends to use. For available backends see Mail Backends.
Settings
- backends – 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:
{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, setemail_client
toi3-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
)
- backends – List of backends (instances of
-
class
i3pystatus.mem.
Mem
[source]¶ Shows memory load
Available formatters
- {avail_mem}
- {percent_used_mem}
- {used_mem}
- {total_mem}
Requires psutil (from PyPI)
Settings
- format (default:
{avail_mem} MiB
) – format string used for output. - divisor (default:
1048576
) – divide all byte values by this value, default 1024**2(mebibytes - warn_percentage (default:
50
) – minimal percentage for warn state - alert_percentage (default:
80
) – minimal percentage for alert state - color (default:
#00FF00
) – standard color - warn_color (default:
#FFFF00
) – defines the color used wann warn percentage ist exceeded - alert_color (default:
#FF0000
) – defines the color used when alert percentage is exceeded - round_size (default:
1
) – defines number of digits in round - interval (default:
5
)
-
class
i3pystatus.mem_bar.
MemBar
[source]¶ Shows memory load as a bar.
Available formatters
- {used_mem_bar}
Requires psutil and colour (from PyPI)
Settings
- format (default:
{used_mem_bar}
) – format string used for output. - warn_percentage (default:
50
) – minimal percentage for warn state - alert_percentage (default:
80
) – minimal percentage for alert state - color (default:
#00FF00
) – standard color - warn_color (default:
#FFFF00
) – defines the color used wann warn percentage ist exceeded - alert_color (default:
#FF0000
) – defines the color used when alert percentage is exceeded - multi_colors (default:
False
) – whether to use range of colors from ‘color’ to ‘alert_color’ based on memory usage. - interval (default:
5
)
-
class
i3pystatus.modsde.
ModsDeChecker
[source]¶ This class returns i3status parsable output of the number of unread posts in any bookmark in the mods.de forums.
Settings
- format (default:
{unread} new posts in bookmarks
) – Use {unread} as the formatter for number of unread posts - offset (default:
0
) – subtract number of posts before output - color (default:
#7181fe
) - username (required)
- password (required)
- interval (default:
5
)
- format (default:
-
class
i3pystatus.mpd.
MPD
[source]¶ Displays various information from MPD (the music player daemon)
Available formatters (uses formatp)
- {title} — (the title of the current song)
- {album} — (the album of the current song, can be an empty string (e.g. for online streams))
- {artist} — (can be empty, too)
- {filename} — (file name with out extension and path; empty unless title is empty)
- {song_elapsed} — (Position in the currently playing song, uses TimeWrapper, default is %m:%S)
- {song_length} — (Length of the current song, same as song_elapsed)
- {pos} — (Position of current song in playlist, one-based)
- {len} — (Songs in playlist)
- {status} — (play, pause, stop mapped through the status dictionary)
- {bitrate} — (Current bitrate in kilobit/s)
- {volume} — (Volume set in MPD)
Left click on the module play/pauses, right click (un)mutes.
Settings
- host (default:
localhost
) - port (default:
6600
) – MPD port - format (default:
{title} {status}
) – formatp string - status (default:
{'stop': '◾', 'play': '▶', 'pause': '▷'}
) – Dictionary mapping pause, play and stop to output - color (default:
#FFFFFF
) – The color of the text - text_len (default:
25
) – Defines max length for title, album and artist, if truncated ellipsis are appended as indicator - truncate_fields (default:
('title', 'album', 'artist')
) – fileds that will be truncated if exceeding text_len - interval (default:
1
)
-
class
i3pystatus.network.
Network
[source]¶ Display network information about a interface.
Requires the PyPI package netifaces.
Available formatters
- {interface} — same as setting
- {name} — same as setting
- {v4} — IPv4 address
- {v4mask} — subnet mask
- {v4cidr} — IPv4 address in cidr notation (i.e. 192.168.2.204/24)
- {v6} — IPv6 address
- {v6mask} — subnet mask
- {v6cidr} — IPv6 address in cidr notation
- {mac} — MAC of interface
Not available addresses (i.e. no IPv6 connectivity) are replaced with empty strings.
Settings
- interface (default:
eth0
) – Interface to obtain information for - format_up (default:
{interface}: {v4}
) - color_up (default:
#00FF00
) - format_down (default:
{interface}
) - color_down (default:
#FF0000
) - 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 - name (default:
eth0
) - interval (default:
5
)
-
class
i3pystatus.network_graph.
NetworkGraph
[source]¶ Shows Network activity as a Unicode graph
Linux only
Requires the PyPI packages psutil and colour.
Available formatters
- {kbs} – Float representing kbs
- {network_graph} – Unicode network graph
Settings
- format (default:
{network_graph}{kbs}KB/s
) – format string - graph_width (default:
15
) – Width of the graph - upper_limit (default:
150.0
) – Expected max kb/s. This value controls how the graph is drawn and in what color - graph_type (default:
input
) – Whether to draw the graph for input or output. Allowed values ‘input’ or ‘output’ - divisor (default:
1024
) – divide all byte values by this value - interface (default:
eth0
) – Interface to watch, eg ‘eth0’ - 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
)
-
class
i3pystatus.network_traffic.
NetworkTraffic
[source]¶ Network traffic per interface, i.e., packets/bytes sent/received per second.
Requires the PyPI packages psutil.
Available formatters
- {interface} — the configured network interface
- {bytes_sent} — bytes sent per second (divided by divisor)
- {bytes_recv} — bytes received per second (divided by divisor)
- {packets_sent} — bytes sent per second (divided by divisor)
- {packets_recv} — bytes received per second (divided by divisor)
Settings
- format (default:
{interface} ↗{bytes_sent}kB/s ↘{bytes_recv}kB/s
) – format string - format_down (default:
{interface} –
) – format string if the interface is down (unless hide_down is set) - hide_down (default:
False
) – whether to not display a interface which is down - interface (default:
eth0
) – network interface - divisor (default:
1024
) – divide all byte values by this value - round_size (default: empty) – defines number of digits in round
- interval (default:
1
)
-
class
i3pystatus.now_playing.
NowPlaying
[source]¶ Shows currently playing track information, supports most media players
Available formatters (uses formatp)
- {title} — (the title of the current song)
- {album} — (the album of the current song, can be an empty string (e.g. for online streams))
- {artist} — (can be empty, too)
- {filename} — (file name with out extension and path; empty unless title is empty)
- {song_elapsed} — (Position in the currently playing song, uses TimeWrapper, default is %m:%S)
- {song_length} — (Length of the current song, same as song_elapsed)
- {status} — (play, pause, stop mapped through the status dictionary)
- {volume} — (Volume)
Left click on the module play/pauses, right click goes to the next track.
Requires python-dbus available from every distros’ package manager.
Settings
- player (default: empty) – Player name
- status (default:
{'stop': '◾', 'play': '▶', 'pause': '▷'}
) – Dictionary mapping pause, play and stop to output text - color (default:
#FFFFFF
) – Text color - format (default:
{title} {status}
) – formatp string - hide_no_player (default:
True
) – Hide output if no player is detected - interval (default:
1
)
-
class
i3pystatus.parcel.
ParcelTracker
[source]¶ Used to track parcel/shipments.
Supported carriers: DHL, UPS, Itella
- parcel.UPS(“<id_code>”)
- parcel.DHL(“<id_code>”)
- parcel.Itella(“<id_code>”[, “en”|”fi”|”sv”]) Second parameter is language. Requires beautiful soup 4 (bs4)
Requires lxml and cssselect.
Settings
- instance – Tracker instance, for example
parcel.UPS('your_id_code')
- format (default:
{name}:{progress}
) - name
- interval (default:
60
)
-
class
i3pystatus.pianobar.
Pianobar
[source]¶ Shows the title and artist name of the current music
In pianobar config file must be setted the fifo and event_command options (see man pianobar for more information)
For the event_cmd use: https://github.com/jlucchese/pianobar/blob/master/contrib/pianobar-song-i3.sh
Mouse events: - Left click play/pauses - Right click plays next song - Scroll up/down changes volume
Settings
- format (required)
- songfile – File generated by pianobar eventcmd
- ctlfile – Pianobar fifo file
- color (default:
#FFFFFF
) – The color of the text - interval (default:
5
)
-
class
i3pystatus.pomodoro.
Pomodoro
[source]¶ This plugin shows Pomodoro timer.
Left click starts/restarts timer. Right click stops it.
Settings
- sound – Path to sound file to play as alarm. Played by “aplay” utility
- pomodoro_duration (default:
1500
) – Working (pomodoro) interval duration in seconds - break_duration (default:
300
) – Short break duration in seconds - long_break_duration (default:
900
) – Long break duration in seconds - short_break_count (default:
3
) – Short break count before first long break - format (default:
☯ {current_pomodoro}/{total_pomodoro} {time}
) – format string, available formatters: current_pomodoro, total_pomodoro, time - interval (default:
1
)
-
class
i3pystatus.pulseaudio.
PulseAudio
[source]¶ Shows volume of default PulseAudio sink (output).
- Requires amixer for toggling mute and incrementing/decrementing volume on scroll.
- Depends on the PyPI colour module - https://pypi.python.org/pypi/colour/0.0.5
Available formatters:
- {volume} — volume in percent (0...100)
- {db} — volume in decibels relative to 100 %, i.e. 100 % = 0 dB, 50 % = -18 dB, 0 % = -infinity dB (the literal value for -infinity is -∞)
- {muted} — the value of one of the muted or unmuted settings
- {volume_bar} — unicode bar showing volume
Settings
- format (default:
♪: {volume}
) - format_muted (default: empty) – optional format string to use when muted
- muted (default:
M
) - unmuted (default: empty)
- color_muted (default:
#FF0000
) - color_unmuted (default:
#FFFFFF
) - step (default:
5
) – percentage to increment volume on scroll - bar_type (default:
vertical
) – type of volume bar. Allowed values are ‘vertical’ or ‘horizontal’ - multi_colors (default:
False
) – whether or not to change the color from ‘color_muted’ to ‘color_unmuted’ based on volume percentage - vertical_bar_width (default:
2
) – how many characters wide the vertical volume_bar should be
-
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)
-
class
i3pystatus.pyload.
pyLoad
[source]¶ Shows pyLoad status
Available formatters
- {captcha} (see captcha_true and captcha_false, which are the values filled in for this formatter)
- {progress} (average over all running downloads)
- {progress_all} (percentage of completed files/links in queue)
- {speed} (kilobytes/s)
- {download} (downloads enabled, also see download_true and download_false)
- {total} (number of downloads)
- {free_space} (free space in download directory in gigabytes)
Settings
- address (default:
http://127.0.0.1:8000
) – Address of pyLoad webinterface - format (default:
{captcha} {progress_all:.1f}% {speed:.1f} kb/s
) - captcha_true (default:
Captcha waiting
) - captcha_false (default: empty)
- download_true (default:
Downloads enabled
) - download_false (default:
Downloads disabled
) - username (required)
- password (required)
- interval (default:
5
)
-
class
i3pystatus.reddit.
Reddit
[source]¶ This module fetches and displays posts and/or user mail/messages from reddit.com. Left-clicking on the display text opens the permalink/comments page using webbrowser.open() while right-clicking opens the URL of the submission directly. Depends on the Python Reddit API Wrapper (PRAW) <https://github.com/praw-dev/praw>.
Available formatters
- {submission_title}
- {submission_author}
- {submission_points}
- {submission_comments}
- {submission_permalink}
- {submission_url}
- {submission_domain}
- {submission_subreddit}
- {message_unread}
- {message_author}
- {message_subject}
- {message_body}
Settings
- format (default:
[{submission_subreddit}] {submission_title} ({submission_domain})
) – Format string used for output. - username (default: empty) – Reddit username.
- password (default: empty) – Reddit password.
- subreddit (default: empty) – Subreddit to monitor. Uses frontpage if unspecified.
- sort_by (default:
hot
) – ‘hot’, ‘new’, ‘rising’, ‘controversial’, or ‘top’. - color (default:
#FFFFFF
) – Standard color. - colorize (default:
True
) – Enable color change on new message. - color_orangered (default:
#FF4500
) – Color for new messages. - mail_brackets (default:
False
) – Display unread message count in square-brackets. - title_maxlen (default:
80
) – Maximum number of characters to display in title. - interval (default:
300
) – Update interval. - status (default:
{'no_mail': '', 'new_mail': '✉'}
) – New message indicator.
-
class
i3pystatus.regex.
Regex
[source]¶ Simple regex file watcher
The groups of the regex are passed to the format string as positional arguments.
Settings
- format (default:
{0}
) – format string used for output - regex (required)
- file – file to search for regex matches
- flags (default:
0
) – Python.re flags - interval (default:
5
)
- format (default:
-
class
i3pystatus.runwatch.
RunWatch
[source]¶ Expands the given path using glob to a pidfile and checks if the process ID found inside is valid (that is, if the process is running). You can use this to check if a specific application, such as a VPN client or your DHCP client is running.
Available formatters are {pid} and {name}.
Settings
- format_up (default:
{name}
) - format_down (default:
{name}
) - color_up (default:
#00FF00
) - color_down (default:
#FF0000
) - path (required)
- name (required)
- interval (default:
5
)
- format_up (default:
-
class
i3pystatus.shell.
Shell
[source]¶ Shows output of shell command
Settings
- command – command to be executed
- color (default:
#FFFFFF
) – standard color - error_color (default:
#FF0000
) – color to use when non zero exit code is returned - interval (default:
5
)
-
class
i3pystatus.spotify.
Spotify
[source]¶ This class shows information from Spotify.
Left click will toggle pause/play of the current song. Right click will skip the song.
Dependent on Playerctl ( https://github.com/acrisci/playerctl ) and GLib
Settings
- format (default:
{artist} - {title}
) – Format string. {artist}, {title}, {album}, {volume}, and {length} are available for output. - color (default:
#ffffff
) – color of the output
- format (default:
-
class
i3pystatus.temp.
Temperature
[source]¶ Shows CPU temperature of Intel processors
AMD is currently not supported as they can only report a relative temperature, which is pretty useless
Settings
- format (default:
{temp} °C
) – format string used for output. {temp} is the temperature in degrees celsius - color (default:
#FFFFFF
) - file (default:
/sys/class/thermal/thermal_zone0/temp
) - interval (default:
5
)
- format (default:
-
class
i3pystatus.text.
Text
[source]¶ Display static, colored text.
Settings
- text (required)
- color (default: empty) – HTML color code #RRGGBB
- cmd_leftclick (default:
test
) – Shell command to execute on left click - cmd_rightclick (default:
test
) – Shell command to execute on right click
-
class
i3pystatus.uname.
Uname
[source]¶ uname(1) like module.
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
-
class
i3pystatus.uptime.
Uptime
[source]¶ Outputs Uptime
Settings
- format (default:
up {uptime}
) – Format string - color (default:
#ffffff
) – String color - alert (default:
False
) – If you want the string to change color - seconds_alert (default:
3600
) – How many seconds necessary to start the alert - color_alert (default:
#ff0000
) – Alert color - interval (default:
5
)
- format (default:
-
class
i3pystatus.weather.
Weather
[source]¶ This module gets the weather from weather.com using pywapi module First, you need to get the code for the location from the www.weather.com
Available formatters
- {current_temp}
- {current_wind}
- {humidity}
Requires pywapi from PyPI.
Settings
- location_code (required)
- colorize (default:
False
) – Enable color with temperature and UTF-8 icons. - units (default:
metric
) – Celsius (metric) or Fahrenheit (imperial) - format (default:
{current_temp}
) - interval (default:
20
)
-
class
i3pystatus.wireless.
Wireless
[source]¶ Display network information about a interface.
Requires the PyPI packages netifaces and basiciw.
This is based on the network module, so all options and formatters are the same, except for these additional formatters and that detached_down doesn’t work.
- {essid} — ESSID of currently connected wifi
- {freq} — Current frequency
- {quality} — Link quality in percent
- {quality_bar} —Bar graphically representing link quality
Settings
- interface (default:
wlan0
) – Interface to obtain information for - format_up (default:
{interface}: {v4}
) - color_up (default:
#00FF00
) - format_down (default:
{interface}
) - color_down (default:
#FF0000
) - 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 - name (default:
eth0
) - interval (default:
5
)
Mail Backends¶
-
class
i3pystatus.imap.
IMAP
[source]¶ Checks for mail on a IMAP server
Settings
- host (required)
- port (default:
993
) - username (required)
- password (required)
- ssl (default:
True
) - mailbox (default:
INBOX
)
-
imap_class
¶ alias of
IMAP4
-
class
i3pystatus.maildir.
MaildirMail
[source]¶ Checks for local mail in Maildir
Settings
- directory (required)