py3status Documentation Release 3.23 ultrabug Jan 07, 2020 Contents: 1 Introduction 1 1.1 About...................................................1 1.2 Philosophy................................................1 1.3 Installation................................................2 1.4 Support..................................................3 1.5 Usage...................................................3 2 Configuration 5 2.1 Loading a py3status module and ordering modules output.......................6 2.2 Configuring a py3status module.....................................6 2.3 py3status configuration section.....................................6 2.4 Configuration obfuscation........................................ 10 2.5 Configuring colors............................................ 11 2.6 Configuring thresholds.......................................... 12 2.7 Formatter................................................. 13 2.8 Urgent.................................................. 14 2.9 Grouping Modules............................................ 15 2.10 Custom click events........................................... 17 2.11 Special on_click commands....................................... 18 2.12 Module data and on_click commands.................................. 18 2.13 Environment Variables.......................................... 18 2.14 Inline Shell Code............................................. 19 2.15 Refreshing modules on udev events with on_udev dynamic options.................. 20 2.16 Request Settings............................................. 21 3 Modules 23 3.1 air_quality................................................ 23 3.2 apt_updates................................................ 25 3.3 arch_updates............................................... 26 3.4 async_script............................................... 26 3.5 aws_bill.................................................. 27 3.6 backlight................................................. 28 3.7 battery_level............................................... 28 3.8 bitcoin_price............................................... 30 3.9 bluetooth................................................. 30 3.10 check_tcp................................................. 31 3.11 clementine................................................ 32 i 3.12 clock................................................... 32 3.13 cmus................................................... 34 3.14 coin_balance............................................... 35 3.15 coin_market............................................... 37 3.16 conky................................................... 39 3.17 deadbeef................................................. 44 3.18 diskdata.................................................. 45 3.19 do_not_disturb.............................................. 46 3.20 dpms................................................... 47 3.21 dropboxd_status............................................. 48 3.22 emerge_status.............................................. 49 3.23 exchange_rate.............................................. 49 3.24 external_script.............................................. 50 3.25 fedora_updates.............................................. 51 3.26 file_status................................................. 51 3.27 frame................................................... 52 3.28 getjson.................................................. 53 3.29 github................................................... 54 3.30 gitlab................................................... 56 3.31 glpi.................................................... 57 3.32 google_calendar............................................. 57 3.33 gpmdp.................................................. 60 3.34 graphite.................................................. 60 3.35 group................................................... 61 3.36 hamster.................................................. 63 3.37 hddtemp................................................. 63 3.38 hueshift.................................................. 65 3.39 i3block.................................................. 66 3.40 i3pystatus................................................. 67 3.41 icinga2.................................................. 68 3.42 imap................................................... 69 3.43 insync................................................... 70 3.44 kdeconnector............................................... 70 3.45 keyboard_layout............................................. 72 3.46 keyboard_locks.............................................. 73 3.47 khal_calendar............................................... 73 3.48 lm_sensors................................................ 74 3.49 loadavg.................................................. 76 3.50 mail.................................................... 79 3.51 mega_sync................................................ 81 3.52 moc.................................................... 82 3.53 mpd_status................................................ 83 3.54 mpris................................................... 85 3.55 net_iplist................................................. 87 3.56 net_rate.................................................. 88 3.57 netdata.................................................. 89 3.58 networkmanager............................................. 89 3.59 ns_checker................................................ 90 3.60 nvidia_smi................................................ 91 3.61 online_status............................................... 92 3.62 pingdom................................................. 93 3.63 player_control.............................................. 94 3.64 pomodoro................................................. 95 3.65 process_status.............................................. 96 ii 3.66 rainbow.................................................. 96 3.67 rate_counter............................................... 97 3.68 rss_aggregator.............................................. 98 3.69 rt..................................................... 99 3.70 scratchpad................................................ 100 3.71 screenshot................................................ 101 3.72 scroll................................................... 101 3.73 selinux.................................................. 102 3.74 spaceapi................................................. 102 3.75 speedtest................................................. 103 3.76 spotify.................................................. 105 3.77 sql.................................................... 106 3.78 static_string................................................ 108 3.79 sysdata.................................................. 108 3.80 systemd.................................................. 110 3.81 systemd_suspend_inhibitor....................................... 111 3.82 taskwarrior................................................ 112 3.83 thunderbird_todos............................................ 112 3.84 timer................................................... 115 3.85 timewarrior................................................ 115 3.86 tor_rate.................................................. 118 3.87 transmission............................................... 119 3.88 twitch................................................... 121 3.89 uname.................................................. 122 3.90 uptime.................................................. 122 3.91 usbguard................................................. 123 3.92 velib_metropole............................................. 124 3.93 vnstat................................................... 126 3.94 volume_status.............................................. 127 3.95 vpn_status................................................ 128 3.96 wanda_the_fish.............................................. 129 3.97 weather_owm............................................... 130 3.98 whatismyip................................................ 133 3.99 whoami.................................................. 134 3.100 wifi.................................................... 135 3.101 window.................................................. 136 3.102 wwan................................................... 137 3.103 wwan_status............................................... 140 3.104 xkb_input................................................. 141 3.105 xrandr................................................... 143 3.106 xrandr_rotate............................................... 145 3.107 xscreensaver............................................... 146 3.108 xsel.................................................... 147 3.109 yandexdisk_status............................................ 147 3.110 yubikey.................................................. 148 4 py3-cmd 149 4.1 Commands available........................................... 149 4.2 Calling commands from i3........................................ 150 5 Writing custom py3status modules 153 5.1 Importing custom modules........................................ 153 5.2 Publishing custom modules on PyPI................................... 153 5.3 Example 1: The basics - Hello World!.................................. 154 iii 5.4 Example 2: Configuration parameters.................................. 155 5.5 Example 3: Click events......................................... 156 5.6 Example 4: Status string