Py3status Documentation Release 3.12
Total Page：16
File Type：pdf, Size：1020Kb
py3status Documentation Release 3.12 ultrabug Aug 09, 2018 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................................................7 2.3 arch_updates...............................................7 2.4 aws_bill..................................................8 2.5 backlight.................................................9 2.6 battery_level...............................................9 2.7 bitcoin_price............................................... 11 2.8 bluetooth................................................. 12 2.9 check_tcp................................................. 12 2.10 clementine................................................ 13 2.11 clock................................................... 13 2.12 cmus................................................... 15 2.13 coin_balance............................................... 17 2.14 coin_market............................................... 18 2.15 deadbeef................................................. 20 2.16 diskdata.................................................. 21 2.17 do_not_disturb.............................................. 22 2.18 dpms................................................... 23 2.19 dropboxd_status............................................. 23 2.20 exchange_rate.............................................. 24 2.21 external_script.............................................. 24 2.22 fedora_updates.............................................. 25 2.23 file_status................................................. 26 2.24 frame................................................... 27 2.25 getjson.................................................. 28 2.26 github................................................... 29 2.27 gitlab................................................... 30 2.28 glpi.................................................... 31 i 2.29 google_calendar............................................. 32 2.30 gpmdp.................................................. 34 2.31 graphite.................................................. 35 2.32 group................................................... 36 2.33 hamster.................................................. 37 2.34 hddtemp................................................. 38 2.35 i3block.................................................. 39 2.36 i3pystatus................................................. 40 2.37 icinga2.................................................. 41 2.38 imap................................................... 42 2.39 insync................................................... 43 2.40 kdeconnector............................................... 43 2.41 keyboard_layout............................................. 45 2.42 keyboard_locks.............................................. 46 2.43 moc.................................................... 46 2.44 mpd_status................................................ 48 2.45 mpris................................................... 49 2.46 net_iplist................................................. 51 2.47 net_rate.................................................. 52 2.48 netdata.................................................. 53 2.49 ns_checker................................................ 53 2.50 nvidia_temp............................................... 54 2.51 online_status............................................... 55 2.52 pingdom................................................. 55 2.53 player_control.............................................. 56 2.54 pomodoro................................................. 57 2.55 process_status.............................................. 58 2.56 rainbow.................................................. 58 2.57 rate_counter............................................... 59 2.58 rss_aggregator.............................................. 60 2.59 rt..................................................... 61 2.60 scratchpad_async............................................. 62 2.61 scratchpad_counter............................................ 62 2.62 screenshot................................................ 63 2.63 selinux.................................................. 63 2.64 spaceapi................................................. 64 2.65 spotify.................................................. 65 2.66 static_string................................................ 66 2.67 sysdata.................................................. 66 2.68 systemd.................................................. 67 2.69 taskwarrior................................................ 68 2.70 thunderbird_todos............................................ 68 2.71 timer................................................... 71 2.72 tor_rate.................................................. 72 2.73 transmission............................................... 73 2.74 twitch................................................... 75 2.75 uname.................................................. 76 2.76 uptime.................................................. 76 2.77 vnstat................................................... 77 2.78 volume_status.............................................. 78 2.79 vpn_status................................................ 80 2.80 weather_owm............................................... 80 2.81 weather_yahoo.............................................. 84 2.82 whatismyip................................................ 86 ii 2.83 whoami.................................................. 87 2.84 wifi.................................................... 88 2.85 window_title............................................... 89 2.86 window_title_async........................................... 89 2.87 wwan................................................... 90 2.88 wwan_status............................................... 93 2.89 xrandr................................................... 94 2.90 xrandr_rotate............................................... 96 2.91 xscreensaver............................................... 97 2.92 xsel.................................................... 97 2.93 yandexdisk_status............................................ 98 2.94 yubikey.................................................. 98 3 Using modules 101 3.1 Loading a py3status module and ordering modules output....................... 101 3.2 Configuring a py3status module..................................... 102 3.3 py3status configuration section..................................... 102 3.4 Configuration obfuscation........................................ 102 3.5 Configuring colors............................................ 103 3.6 Configuring thresholds.......................................... 104 3.7 Urgent.................................................. 105 3.8 Grouping Modules............................................ 105 3.9 Custom click events........................................... 107 3.10 Special on_click commands....................................... 108 3.11 Module data and on_click commands.................................. 108 3.12 Environment Variables.......................................... 108 3.13 Inline Shell Code............................................. 109 4 py3-cmd 111 4.1 Commands available........................................... 111 4.2 Calling commands from i3........................................ 112 5 Writing custom py3status modules 113 5.1 Example 1: The basics - Hello World!.................................. 113 5.2 Example 2: Configuration parameters.................................. 114 5.3 Example 3: Click events......................................... 115 5.4 Example 4: Status string placeholders.................................. 116 5.5 Example 5: Using color constants.................................... 117 5.6 Module methods............................................. 118 5.7 Py3 module helper............................................ 119 5.8 Composites................................................ 119 5.9 Module data storage........................................... 120 5.10 Module documentation.......................................... 120 5.11 Deprecation of configuration parameters................................ 121 5.12 Updating of configuration parameters.................................. 124 5.13 Module testing.............................................. 125 6 py3 module helper 127 6.1 Constants................................................. 127 6.2 Exceptions................................................ 127 6.3 Methods................................................. 128 7 Developing and Contributing 135 7.1 What you will need............................................ 135 7.2 Setting up a development environment................................. 135 iii 7.3 Python versions............................................. 136 7.4 Pytest................................................... 136 7.5 Travis CI................................................. 136 7.6 Coding in containers........................................... 137 7.7 Building documentation......................................... 137 7.8 Profiling py3status...........................................