py3status Documentation Release 3.5 ultrabug Apr 08, 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 arch_updates...............................................6 2.3 aws_bill..................................................7 2.4 backlight.................................................7 2.5 battery_level...............................................8 2.6 bitcoin_price...............................................9 2.7 bluetooth................................................. 10 2.8 check_tcp................................................. 11 2.9 clementine................................................ 11 2.10 clock................................................... 12 2.11 coin_balance............................................... 13 2.12 deadbeef................................................. 15 2.13 diskdata.................................................. 16 2.14 do_not_disturb.............................................. 17 2.15 dpms................................................... 17 2.16 dropboxd_status............................................. 18 2.17 exchange_rate.............................................. 19 2.18 external_script.............................................. 19 2.19 fedora_updates.............................................. 20 2.20 file_status................................................. 20 2.21 frame................................................... 21 2.22 getjson.................................................. 22 2.23 github................................................... 23 2.24 glpi.................................................... 24 2.25 gpmdp.................................................. 25 2.26 graphite.................................................. 26 2.27 group................................................... 27 2.28 hamster.................................................. 28 i 2.29 icinga2.................................................. 28 2.30 imap................................................... 29 2.31 insync................................................... 30 2.32 kdeconnector............................................... 30 2.33 keyboard_layout............................................. 32 2.34 keyboard_locks.............................................. 32 2.35 mpd_status................................................ 33 2.36 mpris................................................... 34 2.37 net_iplist................................................. 36 2.38 net_rate.................................................. 37 2.39 netdata.................................................. 38 2.40 ns_checker................................................ 38 2.41 nvidia_temp............................................... 39 2.42 online_status............................................... 40 2.43 pingdom................................................. 40 2.44 player_control.............................................. 41 2.45 pomodoro................................................. 42 2.46 process_status.............................................. 43 2.47 rainbow.................................................. 43 2.48 rate_counter............................................... 44 2.49 rss_aggregator.............................................. 45 2.50 rt..................................................... 46 2.51 scratchpad_async............................................. 47 2.52 scratchpad_counter............................................ 47 2.53 screenshot................................................ 47 2.54 selinux.................................................. 48 2.55 spaceapi................................................. 49 2.56 spotify.................................................. 49 2.57 static_string................................................ 50 2.58 sysdata.................................................. 50 2.59 systemd.................................................. 51 2.60 taskwarrior................................................ 52 2.61 timer................................................... 53 2.62 tor_rate.................................................. 53 2.63 twitch_streaming............................................. 54 2.64 uname.................................................. 55 2.65 uptime.................................................. 55 2.66 vnstat................................................... 56 2.67 volume_status.............................................. 57 2.68 vpn_status................................................ 58 2.69 weather_yahoo.............................................. 59 2.70 whatismyip................................................ 60 2.71 whoami.................................................. 61 2.72 wifi.................................................... 61 2.73 window_title............................................... 62 2.74 window_title_async........................................... 63 2.75 wwan_status............................................... 63 2.76 xrandr................................................... 64 2.77 xrandr_rotate............................................... 65 2.78 xscreensaver............................................... 66 2.79 xsel.................................................... 67 2.80 yandexdisk_status............................................ 67 3 Using modules 69 ii 3.1 Loading a py3status module and ordering modules output....................... 69 3.2 Configuring a py3status module..................................... 70 3.3 py3status configuration section..................................... 70 3.4 Configuration obfuscation........................................ 70 3.5 Configuring colors............................................ 71 3.6 Configuring thresholds.......................................... 72 3.7 Grouping Modules............................................ 72 3.8 Custom click events........................................... 74 3.9 Special on_click commands....................................... 75 3.10 Module data and on_click commands.................................. 76 4 Writing custom py3status modules 77 4.1 Example 1: The basics - Hello World!.................................. 77 4.2 Example 2: Configuration parameters.................................. 78 4.3 Example 3: Click events......................................... 79 4.4 Example 4: Status string placeholders.................................. 80 4.5 Example 5: Using color constants.................................... 81 4.6 Module methods............................................. 82 4.7 Py3 module helper............................................ 83 4.8 Composites................................................ 83 4.9 Module documentation.......................................... 84 4.10 Deprecation of configuration parameters................................ 85 4.11 Updating of configuration parameters.................................. 88 4.12 Module testing.............................................. 88 5 py3 module helper 91 5.1 Constants................................................. 91 5.2 Exceptions................................................ 91 5.3 Methods................................................. 92 6 Developing and Contributing 97 6.1 What you will need............................................ 97 6.2 Setting up a developement environment................................. 97 6.3 Python versions............................................. 98 6.4 Pytest................................................... 98 6.5 Travis CI................................................. 98 6.6 Coding in containers........................................... 99 6.7 Building documentation......................................... 99 6.8 Contributions............................................... 99 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 Philosophy • no added configuration file, use the standard i3status.conf • rely on i3status’ strengths and its existing configuration as much as possible • be extensible, it must be easy for users to add their own stuff/output by writing a simple python class which will be loaded and executed dynamically • easily allow interactivity with the i3bar 1 py3status Documentation, Release 3.5 • add some built-in enhancement/transformation of basic i3status modules output • support python 2.7 and python 3.x Installation Distro Helpful Command Useful Note $ pacaur