py3status Documentation Release 3.6 ultrabug Aug 22, 2017 Contents: 1 Introduction 1 1.1 About...................................................1 1.2 Philosophy................................................1 1.3 Installation................................................2 1.4 Support..................................................2 1.5 Usage...................................................2 2 Modules 5 2.1 air_quality................................................5 2.2 apt_updates................................................6 2.3 arch_updates...............................................7 2.4 aws_bill..................................................7 2.5 backlight.................................................8 2.6 battery_level...............................................9 2.7 bitcoin_price............................................... 10 2.8 bluetooth................................................. 11 2.9 check_tcp................................................. 11 2.10 clementine................................................ 12 2.11 clock................................................... 12 2.12 cmus................................................... 14 2.13 coin_balance............................................... 16 2.14 coin_market............................................... 17 2.15 deadbeef................................................. 19 2.16 diskdata.................................................. 19 2.17 do_not_disturb.............................................. 21 2.18 dpms................................................... 21 2.19 dropboxd_status............................................. 22 2.20 exchange_rate.............................................. 23 2.21 external_script.............................................. 23 2.22 fedora_updates.............................................. 24 2.23 file_status................................................. 24 2.24 frame................................................... 25 2.25 getjson.................................................. 26 2.26 github................................................... 27 2.27 glpi.................................................... 28 2.28 gpmdp.................................................. 29 i 2.29 graphite.................................................. 29 2.30 group................................................... 30 2.31 hamster.................................................. 32 2.32 i3block.................................................. 32 2.33 icinga2.................................................. 34 2.34 imap................................................... 34 2.35 insync................................................... 35 2.36 kdeconnector............................................... 35 2.37 keyboard_layout............................................. 37 2.38 keyboard_locks.............................................. 37 2.39 moc.................................................... 38 2.40 mpd_status................................................ 39 2.41 mpris................................................... 40 2.42 net_iplist................................................. 42 2.43 net_rate.................................................. 43 2.44 netdata.................................................. 44 2.45 ns_checker................................................ 45 2.46 nvidia_temp............................................... 45 2.47 online_status............................................... 46 2.48 pingdom................................................. 47 2.49 player_control.............................................. 47 2.50 pomodoro................................................. 48 2.51 process_status.............................................. 49 2.52 rainbow.................................................. 49 2.53 rate_counter............................................... 50 2.54 rss_aggregator.............................................. 51 2.55 rt..................................................... 52 2.56 scratchpad_async............................................. 53 2.57 scratchpad_counter............................................ 53 2.58 screenshot................................................ 54 2.59 selinux.................................................. 54 2.60 spaceapi................................................. 55 2.61 spotify.................................................. 56 2.62 static_string................................................ 57 2.63 sysdata.................................................. 57 2.64 systemd.................................................. 58 2.65 taskwarrior................................................ 59 2.66 timer................................................... 59 2.67 tor_rate.................................................. 60 2.68 twitch_streaming............................................. 61 2.69 uname.................................................. 61 2.70 uptime.................................................. 62 2.71 vnstat................................................... 63 2.72 volume_status.............................................. 63 2.73 vpn_status................................................ 65 2.74 weather_yahoo.............................................. 65 2.75 whatismyip................................................ 67 2.76 whoami.................................................. 67 2.77 wifi.................................................... 68 2.78 window_title............................................... 69 2.79 window_title_async........................................... 69 2.80 wwan_status............................................... 70 2.81 xrandr................................................... 71 2.82 xrandr_rotate............................................... 72 ii 2.83 xscreensaver............................................... 73 2.84 xsel.................................................... 73 2.85 yandexdisk_status............................................ 74 3 Using modules 77 3.1 Loading a py3status module and ordering modules output....................... 77 3.2 Configuring a py3status module..................................... 78 3.3 py3status configuration section..................................... 78 3.4 Configuration obfuscation........................................ 78 3.5 Configuring colors............................................ 79 3.6 Configuring thresholds.......................................... 80 3.7 Urgent.................................................. 80 3.8 Grouping Modules............................................ 81 3.9 Custom click events........................................... 83 3.10 Special on_click commands....................................... 84 3.11 Module data and on_click commands.................................. 84 4 py3-cmd 85 4.1 Commands available........................................... 85 4.2 Calling commands from i3........................................ 86 5 Writing custom py3status modules 87 5.1 Example 1: The basics - Hello World!.................................. 87 5.2 Example 2: Configuration parameters.................................. 88 5.3 Example 3: Click events......................................... 89 5.4 Example 4: Status string placeholders.................................. 90 5.5 Example 5: Using color constants.................................... 91 5.6 Module methods............................................. 92 5.7 Py3 module helper............................................ 93 5.8 Composites................................................ 93 5.9 Module documentation.......................................... 94 5.10 Deprecation of configuration parameters................................ 95 5.11 Updating of configuration parameters.................................. 98 5.12 Module testing.............................................. 98 6 py3 module helper 101 6.1 Constants................................................. 101 6.2 Exceptions................................................ 101 6.3 Methods................................................. 102 7 Developing and Contributing 109 7.1 What you will need............................................ 109 7.2 Setting up a development environment................................. 109 7.3 Python versions............................................. 110 7.4 Pytest................................................... 110 7.5 Travis CI................................................. 110 7.6 Coding in containers........................................... 111 7.7 Building documentation......................................... 111 7.8 Contributions............................................... 111 iii iv CHAPTER 1 Introduction Using py3status, you can take control of your i3bar easily by: • using one of the available Modules shipped with py3status • grouping multiple modules and automatically or manually cycle their display • writing your own modules and have their output displayed on your bar • handling click events on your i3bar and play with them in no time • seeing your clock tick every second whatever your i3status interval No extra configuration file needed, just install & enjoy! About You will love py3status if you’re using i3wm and are frustrated by the i3status limitations on your i3bar such as: • you cannot hack into it easily • you want more than the built-in modules and their limited configuration • you cannot pipe the result of one of more scripts or commands in your bar easily