diff --git a/docs/modules.rst b/docs/modules.rst index 6c7fcb7..c16b814 100644 --- a/docs/modules.rst +++ b/docs/modules.rst @@ -19,6 +19,8 @@ Parameters: * battery.showpowerconsumption: If set to 'true', show current power consumption (defaults to False) * battery.compact-devices : If set to 'true', compacts multiple batteries into a single entry (default to False) +(partially) contributed by `martindoublem `_ - many thanks! + .. image:: ../screenshots/battery.png battery-upower @@ -31,6 +33,8 @@ Parameters: * battery-upower.critical : Critical threshold in % of remaining charge (defaults to 10) * battery-upower.showremaining : If set to true (default) shows the remaining time until the batteries are completely discharged +contributed by `martindoublem `_ - many thanks! + brightness ~~~~~~~~~~ @@ -39,6 +43,8 @@ Displays the brightness of a display Parameters: * brightness.step: The amount of increase/decrease on scroll in % (defaults to 2) +contributed by `TheEdgeOfRage `_ - many thanks! + .. image:: ../screenshots/brightness.png cmus @@ -62,6 +68,8 @@ Parameters: * cmus.server: The address of the cmus server, either a UNIX socket or host[:port]. Connects to the local instance by default. * cmus.passwd: The password to use for the TCP/IP connection. +contributed by `TheEdgeOfRage `_ - many thanks! + .. image:: ../screenshots/cmus.png cpu @@ -139,6 +147,8 @@ kernel Shows Linux kernel version information +contributed by `pierre87 `_ - many thanks! + .. image:: ../screenshots/kernel.png layout-xkb @@ -248,6 +258,7 @@ Parameters: 'auto' uses whatever redshift is configured to do * redshift.lat : latitude if location is set to 'manual' * redshift.lon : longitude if location is set to 'manual' + * redshift.show_transition: information about the transitions (x% day) defaults to True .. image:: ../screenshots/redshift.png @@ -312,6 +323,8 @@ Parameters: * vault.offx: x-axis offset of popup menu (defaults to 0) * vault.offy: y-axis offset of popup menu (defaults to 0) +Many thanks to `bbernhard `_ for the idea! + .. image:: ../screenshots/vault.png xrandr @@ -346,6 +359,8 @@ get volume level Parameters: * amixer.device: Device to use, defaults to "Master,0" +contributed by `zetxx `_ - many thanks! + .. image:: ../screenshots/amixer.png apt @@ -356,6 +371,8 @@ Requires the following packages: * aptitude +contributed by `qba10 `_ - many thanks! + arch-update ~~~~~~~~~~~ @@ -364,6 +381,8 @@ Check updates to Arch Linux. Requires the following executable: * checkupdates (from pacman-contrib) +contributed by `lucassouto `_ - many thanks! + bluetooth ~~~~~~~~~ @@ -377,6 +396,8 @@ Parameters: * bluetooth.dbus_destination_path : dbus destination path (defaults to /) * bluetooth.right_click_popup : use popup menu when right-clicked (defaults to True) +contributed by `brunosmmm `_ - many thanks! + .. image:: ../screenshots/bluetooth.png bluetooth2 @@ -389,6 +410,8 @@ python-dbus to count the number of connections Parameters: * bluetooth.manager : application to launch on click (blueman-manager) +contributed by `martindoublem `_ - many thanks! + caffeine ~~~~~~~~ @@ -400,6 +423,8 @@ Requires the following executables: * xprop (as dependency for xdotool) * notify-send +contributed by `TheEdgeOfRage `_ - many thanks! + .. image:: ../screenshots/caffeine.png cpu2 @@ -438,6 +463,8 @@ Parameters: Note: if you are getting 'n/a' for CPU temperature / fan speed, then you're lacking the aforementioned pattern settings or they have wrong values. +contributed by `somospocos `_ - many thanks! + currency ~~~~~~~~ @@ -456,6 +483,8 @@ Parameters: Note: source and destination names right now must correspond to the names used by the API of https://markets.ft.com +contributed by `AntouanK `_ - many thanks! + .. image:: ../screenshots/currency.png datetimetz @@ -474,6 +503,8 @@ Parameters: * timetz.locale : alias for datetimetz.locale * timetz.timezone : alias for datetimetz.timezone +contributed by `frankzhao `_ - many thanks! + datetz ~~~~~~ @@ -518,6 +549,8 @@ Parameters: Available options for deadbeef.previous, deadbeef.next and deadbeef.pause are: LEFT_CLICK, RIGHT_CLICK, MIDDLE_CLICK, SCROLL_UP, SCROLL_DOWN +contributed by `joshbarrass `_ - many thanks! + deezer ~~~~~~ @@ -536,6 +569,8 @@ Parameters: Available options for deezer.previous, deezer.next and deezer.pause are: LEFT_CLICK, RIGHT_CLICK, MIDDLE_CLICK, SCROLL_UP, SCROLL_DOWN +contributed by `wwmoraes `_ - many thanks! + dnf ~~~ @@ -557,11 +592,15 @@ Displays the number of docker containers running Requires the following python packages: * docker +contributed by `jlopezzarza `_ - many thanks! + dunst ~~~~~ Toggle dunst notifications. +contributed by `eknoes `_ - many thanks! + .. image:: ../screenshots/dunst.png getcrypto @@ -579,6 +618,8 @@ Parameters: * getcrypto.getltc: 0 for not getting price of LTC, 1 for getting it (default). * getcrypto.getcur: Set the currency to display the price in, usd is the default. +contributed by `Ryunaq `_ - many thanks! + .. image:: ../screenshots/getcrypto.png github @@ -593,6 +634,8 @@ Parameters: * github.token: GitHub user access token, the token needs to have the 'notifications' scope. * github.interval: Interval in minutes between updates, default is 5. +contributed by `yvesh `_ - many thanks! + .. image:: ../screenshots/github.png gpmdp @@ -603,17 +646,23 @@ Displays information about the current song in Google Play music player. Requires the following executable: * gpmdp-remote +contributed by `TheEdgeOfRage `_ - many thanks! + hddtemp ~~~~~~~ Fetch hard drive temeperature data from a hddtemp daemon that runs on localhost and default port (7634) +contributed by `somospocos `_ - many thanks! + hostname ~~~~~~~~ Displays the system hostname. +contributed by `varkokonyi `_ - many thanks! + http_status ~~~~~~~~~~~ @@ -624,6 +673,8 @@ Parameters: * http__status.target: Target to retrieve the HTTP status from * http__status.expect: Expected HTTP status +contributed by `valkheim `_ - many thanks! + .. image:: ../screenshots/http_status.png indicator @@ -635,6 +686,8 @@ Parameters: * indicator.include: Comma-separated list of interface prefixes to include (defaults to 'numlock,capslock') * indicator.signalstype: If you want the signali type color to be 'critical' or 'warning' (defaults to 'warning') +contributed by `freed00m `_ - many thanks! + .. image:: ../screenshots/indicator.png layout @@ -645,6 +698,8 @@ Displays and changes the current keyboard layout Requires the following executable: * setxkbmap +contributed by `Pseudonick47 `_ - many thanks! + .. image:: ../screenshots/layout.png layout-xkbswitch @@ -655,6 +710,8 @@ Displays and changes the current keyboard layout Requires the following executable: * xkb-switch +contributed by `somospocos `_ - many thanks! + libvirtvms ~~~~~~~~~~ @@ -663,6 +720,8 @@ Displays count of running libvirt VMs. Required the following python packages: * libvirt +contributed by `maxpivo `_ - many thanks! + mocp ~~~~ @@ -688,6 +747,8 @@ Parameters: * %b Bitrate * %r Sample rate +contributed by `chrugi `_ - many thanks! + mpd ~~~ @@ -734,13 +795,17 @@ Parameters: * mpd.host: MPD host to connect to. (mpc behaviour by default) * mpd.layout: Space-separated list of widgets to add. Possible widgets are the buttons/toggles mpd.prev, mpd.next, mpd.shuffle and mpd.repeat, and the main display with play/pause function mpd.main. +contributed by `alrayyes `_ - many thanks! + .. image:: ../screenshots/mpd.png network_traffic ~~~~~~~~~~~~~~~ Displays network traffic -* No extra configuration needed + * No extra configuration needed + +contributed by `izn `_ - many thanks! notmuch_count ~~~~~~~~~~~~~ @@ -757,6 +822,8 @@ Errors: Dependencies: notmuch (https://notmuchmail.org/) +contributed by `abdoulayeYATERA `_ - many thanks! + nvidiagpu ~~~~~~~~~ @@ -768,6 +835,8 @@ Parameters: Requires nvidia-smi +contributed by `RileyRedpath `_ - many thanks! + octoprint ~~~~~~~~~ @@ -792,6 +861,8 @@ Requires the following executables: * fakeroot * pacman +contributed by `Pseudonick47 `_ - many thanks! + .. image:: ../screenshots/pacman.png pihole @@ -803,6 +874,8 @@ Parameters: * pihole.address : pi-hole address (e.q: http://192.168.1.3) * pihole.pwhash : pi-hole webinterface password hash (can be obtained from the /etc/pihole/SetupVars.conf file) +contributed by `bbernhard `_ - many thanks! + pomodoro ~~~~~~~~ @@ -821,6 +894,8 @@ Parameters: not support command chaining (see https://github.com/tobi-wan-kenobi/bumblebee-status/issues/532 for a detailled explanation) +contributed by `martindoublem `_, inspired by `karthink `_ - many thanks! + prime ~~~~~ @@ -847,6 +922,8 @@ Parameters: Requires the following executable: * prime-select +contributed by `jeffeb3 `_ - many thanks! + progress ~~~~~~~~ @@ -863,6 +940,8 @@ Parameters: Requires the following executable: * progress +contributed by `remi-dupre `_ - many thanks! + publicip ~~~~~~~~ @@ -889,6 +968,8 @@ Parameters: * rss.feeds : Space-separated list of RSS URLs * rss.length : Maximum length of the module, default is 60 +contributed by `lonesomebyte537 `_ - many thanks! + sensors ~~~~~~~ @@ -904,6 +985,9 @@ Parameters: * sensors.match_number: (fallback) which of the matches you want (default -1: last match). * sensors.show_freq: whether to show CPU frequency. (default: true) + +contributed by `mijoharas `_ - many thanks! + .. image:: ../screenshots/sensors.png shell @@ -931,6 +1015,8 @@ Parameters: running scripts to avoid bumblebee-status freezes (defaults to False) +contributed by `rrhuffy `_ - many thanks! + shortcut ~~~~~~~~ @@ -950,6 +1036,9 @@ Parameters: * shortcut.labels: List of widgets' labels (text) * shortcut.delim : Commands and labels delimiter (; semicolon by default) + +contributed by `cacyss0807 `_ - many thanks! + .. image:: ../screenshots/shortcut.png smartstatus @@ -959,7 +1048,8 @@ Displays HDD smart status of different drives or all drives Parameters: * smartstatus.display: how to display (defaults to 'combined', other choices: 'seperate' or 'singles') - * smartstauts.drives: in the case of singles which drives to display, separated comma list value, multiple accepted (defaults to 'sda', example:'sda,sdc') + * smartstatus.drives: in the case of singles which drives to display, separated comma list value, multiple accepted (defaults to 'sda', example:'sda,sdc') + * smartstatus.show_names: boolean in the form of "True" or "False" to show the name of the drives in the form of sda, sbd, combined or none at all. spaceapi ~~~~~~~~ @@ -986,6 +1076,8 @@ Format Strings: to say 'Open/Closed' depending on the boolean you would write '%%state.open%Open%Closed%%' +contributed by `rad4day `_ - many thanks! + spotify ~~~~~~~ @@ -1004,6 +1096,9 @@ Parameters: Available options for spotify.previous, spotify.next and spotify.pause are: LEFT_CLICK, RIGHT_CLICK, MIDDLE_CLICK, SCROLL_UP, SCROLL_DOWN + +contributed by `yvesh `_ - many thanks! + .. image:: ../screenshots/spotify.png stock @@ -1018,6 +1113,9 @@ Parameters: * stock.symbols : Comma-separated list of symbols to fetch * stock.change : Should we fetch change in stock value (defaults to True) + +contributed by `msoulier `_ - many thanks! + .. image:: ../screenshots/stock.png sun @@ -1033,6 +1131,10 @@ Parameters: * cpu.lat : Latitude of your location * cpu.lon : Longitude of your location +(if none of those are set, location is determined automatically via location APIs) + +contributed by `lonesomebyte537 `_ - many thanks! + system ~~~~~~ @@ -1056,6 +1158,8 @@ Parameters: * system.suspend: specify a command for suspending (defaults to 'i3exit suspend') * system.hibernate: specify a command for hibernating (defaults to 'i3exit hibernate') +contributed by `bbernhard `_ - many thanks! + taskwarrior ~~~~~~~~~~~ @@ -1067,6 +1171,9 @@ Requires the following library: Parameters: * taskwarrior.taskrc : path to the taskrc file (defaults to ~/.taskrc) + +contributed by `chdorb `_ - many thanks! + .. image:: ../screenshots/taskwarrior.png timetz @@ -1091,6 +1198,9 @@ Parameters: * title.placeholder : Placeholder text to be placed if title was truncated. Defaults to '...'. * title.scroll : Boolean flag for scrolling title. Defaults to False + +contributed by `UltimatePancake `_ - many thanks! + .. image:: ../screenshots/title.png todo @@ -1101,6 +1211,9 @@ Displays the number of todo items from a text file Parameters: * todo.file: File to read TODOs from (defaults to ~/Documents/todo.txt) + +contributed by `codingo `_ - many thanks! + .. image:: ../screenshots/todo.png traffic @@ -1118,6 +1231,8 @@ Parameters: char shows 2 seconds. If set, enables up/down traffic graphs +contributed by `meain `_ - many thanks! + .. image:: ../screenshots/traffic.png twmn @@ -1125,11 +1240,15 @@ twmn Toggle twmn notifications. +contributed by `Pseudonick47 `_ - many thanks! + uptime ~~~~~~ Displays the system uptime. +contributed by `ccoors `_ - many thanks! + .. image:: ../screenshots/uptime.png vpn @@ -1137,17 +1256,19 @@ vpn Displays the VPN profile that is currently in use. -Left click opens a popup menu that lists all available VPN profiles and allows to establish -a VPN connection using that profile. + Left click opens a popup menu that lists all available VPN profiles and allows to establish + a VPN connection using that profile. -Prerequisites: - * tk python library (usually python-tk or python3-tk, depending on your distribution) - * nmcli needs to be installed and configured properly. - To quickly test, whether nmcli is working correctly, type 'nmcli -g NAME,TYPE,DEVICE con' which - lists all the connection profiles that are configured. Make sure that your VPN profile is in that list! + Prerequisites: + * tk python library (usually python-tk or python3-tk, depending on your distribution) + * nmcli needs to be installed and configured properly. + To quickly test, whether nmcli is working correctly, type 'nmcli -g NAME,TYPE,DEVICE con' which + lists all the connection profiles that are configured. Make sure that your VPN profile is in that list! - e.g: to import a openvpn profile via nmcli: - `sudo nmcli connection import type openvpn file ` + e.g: to import a openvpn profile via nmcli: + `sudo nmcli connection import type openvpn file ` + +contributed by `bbernhard `_ - many thanks! watson ~~~~~~ @@ -1157,6 +1278,8 @@ Displays the status of watson (time-tracking tool) Requires the following executable: * watson +contributed by `bendardenne `_ - many thanks! + weather ~~~~~~~ @@ -1174,6 +1297,9 @@ Parameters: * weather.showminmax: If set to true, show the minimum and maximum temperature, otherwise hide it (defaults to false) * weather.apikey: API key from http://api.openweathermap.org + +contributed by `TheEdgeOfRage `_ - many thanks! + .. image:: ../screenshots/weather.png xkcd @@ -1181,6 +1307,8 @@ xkcd Opens a random xkcd comic in the browser. +contributed by `whzup `_ - many thanks! + yubikey ~~~~~~~ @@ -1191,6 +1319,9 @@ Requires: https://github.com/Yubico/python-yubico The output indicates that a YubiKey is not connected or it displays the corresponding serial number. + +contributed by `EmmaTinten `_ - many thanks! + zpool ~~~~~ @@ -1219,4 +1350,6 @@ is used, the following (or ekvivalent) must be added to the `sudoers(5)`: Be aware of security implications of doing this! +contributed by `adam-dej `_ - many thanks! + .. image:: ../screenshots/zpool.png diff --git a/docs/other/NOTES.md b/docs/other/NOTES.md index d694294..81c6bf4 100644 --- a/docs/other/NOTES.md +++ b/docs/other/NOTES.md @@ -22,3 +22,4 @@ # documentation Add info about error widget and events for error logging - add module contributor doc +- which location APIs are used? diff --git a/modules/contrib/amixer.py b/modules/contrib/amixer.py index cdce9ca..2fb901b 100644 --- a/modules/contrib/amixer.py +++ b/modules/contrib/amixer.py @@ -2,6 +2,8 @@ Parameters: * amixer.device: Device to use, defaults to "Master,0" + +contributed by `zetxx `_ - many thanks! """ import re diff --git a/modules/contrib/apt.py b/modules/contrib/apt.py index 9d9d755..256ed15 100644 --- a/modules/contrib/apt.py +++ b/modules/contrib/apt.py @@ -5,6 +5,7 @@ Requires the following packages: * aptitude +contributed by `qba10 `_ - many thanks! """ import re diff --git a/modules/contrib/arch-update.py b/modules/contrib/arch-update.py index 44a759b..a55a9a7 100644 --- a/modules/contrib/arch-update.py +++ b/modules/contrib/arch-update.py @@ -3,6 +3,7 @@ Requires the following executable: * checkupdates (from pacman-contrib) +contributed by `lucassouto `_ - many thanks! """ import logging diff --git a/modules/contrib/bluetooth.py b/modules/contrib/bluetooth.py index 7d5b078..64fcc0b 100644 --- a/modules/contrib/bluetooth.py +++ b/modules/contrib/bluetooth.py @@ -8,6 +8,7 @@ Parameters: * bluetooth.dbus_destination_path : dbus destination path (defaults to /) * bluetooth.right_click_popup : use popup menu when right-clicked (defaults to True) +contributed by `brunosmmm `_ - many thanks! """ diff --git a/modules/contrib/bluetooth2.py b/modules/contrib/bluetooth2.py index 796da91..2bcdc32 100644 --- a/modules/contrib/bluetooth2.py +++ b/modules/contrib/bluetooth2.py @@ -4,6 +4,8 @@ python-dbus to count the number of connections Parameters: * bluetooth.manager : application to launch on click (blueman-manager) + +contributed by `martindoublem `_ - many thanks! """ diff --git a/modules/contrib/caffeine.py b/modules/contrib/caffeine.py index dfbfe2f..e6d858e 100644 --- a/modules/contrib/caffeine.py +++ b/modules/contrib/caffeine.py @@ -7,6 +7,8 @@ Requires the following executables: * xdotool * xprop (as dependency for xdotool) * notify-send + +contributed by `TheEdgeOfRage `_ - many thanks! """ import logging diff --git a/modules/contrib/cpu2.py b/modules/contrib/cpu2.py index ce61467..e03a140 100644 --- a/modules/contrib/cpu2.py +++ b/modules/contrib/cpu2.py @@ -31,6 +31,7 @@ Parameters: Note: if you are getting 'n/a' for CPU temperature / fan speed, then you're lacking the aforementioned pattern settings or they have wrong values. +contributed by `somospocos `_ - many thanks! """ import psutil diff --git a/modules/contrib/currency.py b/modules/contrib/currency.py index badd4a3..9ddc776 100644 --- a/modules/contrib/currency.py +++ b/modules/contrib/currency.py @@ -15,6 +15,8 @@ Parameters: * currency.destinationdelimiter: Delimiter used for separating individual rates (defaults to '|') Note: source and destination names right now must correspond to the names used by the API of https://markets.ft.com + +contributed by `AntouanK `_ - many thanks! """ import requests diff --git a/modules/contrib/datetimetz.py b/modules/contrib/datetimetz.py index fc58b24..e4baa4c 100644 --- a/modules/contrib/datetimetz.py +++ b/modules/contrib/datetimetz.py @@ -12,6 +12,8 @@ Parameters: * datetz.locale : alias for datetimetz.locale * timetz.locale : alias for datetimetz.locale * timetz.timezone : alias for datetimetz.timezone + +contributed by `frankzhao `_ - many thanks! """ from __future__ import absolute_import diff --git a/modules/contrib/deadbeef.py b/modules/contrib/deadbeef.py index cb837dc..327972d 100644 --- a/modules/contrib/deadbeef.py +++ b/modules/contrib/deadbeef.py @@ -32,6 +32,7 @@ Parameters: Available options for deadbeef.previous, deadbeef.next and deadbeef.pause are: LEFT_CLICK, RIGHT_CLICK, MIDDLE_CLICK, SCROLL_UP, SCROLL_DOWN +contributed by `joshbarrass `_ - many thanks! """ import sys diff --git a/modules/contrib/deezer.py b/modules/contrib/deezer.py index 7aa612e..cca6d5a 100644 --- a/modules/contrib/deezer.py +++ b/modules/contrib/deezer.py @@ -14,6 +14,8 @@ Parameters: Available options for deezer.previous, deezer.next and deezer.pause are: LEFT_CLICK, RIGHT_CLICK, MIDDLE_CLICK, SCROLL_UP, SCROLL_DOWN + +contributed by `wwmoraes `_ - many thanks! """ import dbus diff --git a/modules/contrib/docker_ps.py b/modules/contrib/docker_ps.py index 3f7e739..e3857d8 100644 --- a/modules/contrib/docker_ps.py +++ b/modules/contrib/docker_ps.py @@ -5,6 +5,7 @@ Requires the following python packages: * docker +contributed by `jlopezzarza `_ - many thanks! """ import docker diff --git a/modules/contrib/dunst.py b/modules/contrib/dunst.py index bf9d72b..c5b8a6a 100644 --- a/modules/contrib/dunst.py +++ b/modules/contrib/dunst.py @@ -1,6 +1,9 @@ # pylint: disable=C0111,R0903 -"""Toggle dunst notifications.""" +"""Toggle dunst notifications. + +contributed by `eknoes `_ - many thanks! +""" import core.module import core.widget diff --git a/modules/contrib/getcrypto.py b/modules/contrib/getcrypto.py index 785dbd0..6137d65 100644 --- a/modules/contrib/getcrypto.py +++ b/modules/contrib/getcrypto.py @@ -11,6 +11,8 @@ Parameters: * getcrypto.geteth: 0 for not getting price of ETH, 1 for getting it (default). * getcrypto.getltc: 0 for not getting price of LTC, 1 for getting it (default). * getcrypto.getcur: Set the currency to display the price in, usd is the default. + +contributed by `Ryunaq `_ - many thanks! """ import requests diff --git a/modules/contrib/github.py b/modules/contrib/github.py index f312f43..8c01afd 100644 --- a/modules/contrib/github.py +++ b/modules/contrib/github.py @@ -8,6 +8,8 @@ Requires the following library: Parameters: * github.token: GitHub user access token, the token needs to have the 'notifications' scope. * github.interval: Interval in minutes between updates, default is 5. + +contributed by `yvesh `_ - many thanks! """ import shutil diff --git a/modules/contrib/gpmdp.py b/modules/contrib/gpmdp.py index 5d5110b..4dfc706 100644 --- a/modules/contrib/gpmdp.py +++ b/modules/contrib/gpmdp.py @@ -4,6 +4,8 @@ Requires the following executable: * gpmdp-remote + +contributed by `TheEdgeOfRage `_ - many thanks! """ import core.module diff --git a/modules/contrib/hddtemp.py b/modules/contrib/hddtemp.py index 44b16b5..a039166 100644 --- a/modules/contrib/hddtemp.py +++ b/modules/contrib/hddtemp.py @@ -2,6 +2,8 @@ """Fetch hard drive temeperature data from a hddtemp daemon that runs on localhost and default port (7634) + +contributed by `somospocos `_ - many thanks! """ import socket diff --git a/modules/contrib/hostname.py b/modules/contrib/hostname.py index e4f72d2..02a22cf 100644 --- a/modules/contrib/hostname.py +++ b/modules/contrib/hostname.py @@ -1,6 +1,9 @@ # pylint: disable=C0111,R0903 -"""Displays the system hostname.""" +"""Displays the system hostname. + +contributed by `varkokonyi `_ - many thanks! +""" import platform diff --git a/modules/contrib/http_status.py b/modules/contrib/http_status.py index 5bc7b69..63e53a9 100644 --- a/modules/contrib/http_status.py +++ b/modules/contrib/http_status.py @@ -6,6 +6,8 @@ Parameters: * http__status.label: Prefix label (optional) * http__status.target: Target to retrieve the HTTP status from * http__status.expect: Expected HTTP status + +contributed by `valkheim `_ - many thanks! """ from requests import head diff --git a/modules/contrib/indicator.py b/modules/contrib/indicator.py index c6778cb..25fc6d7 100644 --- a/modules/contrib/indicator.py +++ b/modules/contrib/indicator.py @@ -5,6 +5,8 @@ Parameters: * indicator.include: Comma-separated list of interface prefixes to include (defaults to 'numlock,capslock') * indicator.signalstype: If you want the signali type color to be 'critical' or 'warning' (defaults to 'warning') + +contributed by `freed00m `_ - many thanks! """ import core.module diff --git a/modules/contrib/layout-xkbswitch.py b/modules/contrib/layout-xkbswitch.py index 58c15b9..767deb9 100644 --- a/modules/contrib/layout-xkbswitch.py +++ b/modules/contrib/layout-xkbswitch.py @@ -2,6 +2,8 @@ Requires the following executable: * xkb-switch + +contributed by `somospocos `_ - many thanks! """ import core.module diff --git a/modules/contrib/layout.py b/modules/contrib/layout.py index 9acd8ed..2525453 100644 --- a/modules/contrib/layout.py +++ b/modules/contrib/layout.py @@ -4,6 +4,8 @@ Requires the following executable: * setxkbmap + +contributed by `Pseudonick47 `_ - many thanks! """ import core.module diff --git a/modules/contrib/libvirtvms.py b/modules/contrib/libvirtvms.py index 97bdcfe..510adae 100644 --- a/modules/contrib/libvirtvms.py +++ b/modules/contrib/libvirtvms.py @@ -2,6 +2,8 @@ Required the following python packages: * libvirt + +contributed by `maxpivo `_ - many thanks! """ import sys diff --git a/modules/contrib/mocp.py b/modules/contrib/mocp.py index cc983c0..aeb7d1f 100644 --- a/modules/contrib/mocp.py +++ b/modules/contrib/mocp.py @@ -22,6 +22,8 @@ Parameters: * %cs CurrentSec * %b Bitrate * %r Sample rate + +contributed by `chrugi `_ - many thanks! """ import core.module diff --git a/modules/contrib/mpd.py b/modules/contrib/mpd.py index 12c57ac..0b335ec 100644 --- a/modules/contrib/mpd.py +++ b/modules/contrib/mpd.py @@ -43,6 +43,8 @@ Parameters: * mpd.host: MPD host to connect to. (mpc behaviour by default) * mpd.layout: Space-separated list of widgets to add. Possible widgets are the buttons/toggles mpd.prev, mpd.next, mpd.shuffle and mpd.repeat, and the main display with play/pause function mpd.main. + +contributed by `alrayyes `_ - many thanks! """ from collections import defaultdict diff --git a/modules/contrib/network_traffic.py b/modules/contrib/network_traffic.py index 36e1124..61192f7 100644 --- a/modules/contrib/network_traffic.py +++ b/modules/contrib/network_traffic.py @@ -3,6 +3,8 @@ """Displays network traffic * No extra configuration needed + +contributed by `izn `_ - many thanks! """ import psutil diff --git a/modules/contrib/notmuch_count.py b/modules/contrib/notmuch_count.py index 3b84ff2..bc8fe7e 100644 --- a/modules/contrib/notmuch_count.py +++ b/modules/contrib/notmuch_count.py @@ -11,6 +11,8 @@ Errors: Dependencies: notmuch (https://notmuchmail.org/) + +contributed by `abdoulayeYATERA `_ - many thanks! """ import os diff --git a/modules/contrib/nvidiagpu.py b/modules/contrib/nvidiagpu.py index 65ca125..4aa9de9 100644 --- a/modules/contrib/nvidiagpu.py +++ b/modules/contrib/nvidiagpu.py @@ -7,6 +7,8 @@ Parameters: Available values are: {name} {temp} {mem_used} {mem_total} {fanspeed} {clock_gpu} {clock_mem} Requires nvidia-smi + +contributed by `RileyRedpath `_ - many thanks! """ import core.module diff --git a/modules/contrib/pacman.py b/modules/contrib/pacman.py index 781af0b..8566112 100644 --- a/modules/contrib/pacman.py +++ b/modules/contrib/pacman.py @@ -8,6 +8,8 @@ Parameters: Requires the following executables: * fakeroot * pacman + +contributed by `Pseudonick47 `_ - many thanks! """ import os diff --git a/modules/contrib/pihole.py b/modules/contrib/pihole.py index e3fe403..7334abf 100644 --- a/modules/contrib/pihole.py +++ b/modules/contrib/pihole.py @@ -5,6 +5,8 @@ Parameters: * pihole.address : pi-hole address (e.q: http://192.168.1.3) * pihole.pwhash : pi-hole webinterface password hash (can be obtained from the /etc/pihole/SetupVars.conf file) + +contributed by `bbernhard `_ - many thanks! """ import requests diff --git a/modules/contrib/pomodoro.py b/modules/contrib/pomodoro.py index a58fdcd..fe5959f 100644 --- a/modules/contrib/pomodoro.py +++ b/modules/contrib/pomodoro.py @@ -14,6 +14,8 @@ Parameters: please use an external wrapper script and invoke that. The module itself does not support command chaining (see https://github.com/tobi-wan-kenobi/bumblebee-status/issues/532 for a detailled explanation) + +contributed by `martindoublem `_, inspired by `karthink `_ - many thanks! """ from __future__ import absolute_import diff --git a/modules/contrib/prime.py b/modules/contrib/prime.py index abca96d..8a096cb 100644 --- a/modules/contrib/prime.py +++ b/modules/contrib/prime.py @@ -23,6 +23,7 @@ Parameters: Requires the following executable: * prime-select +contributed by `jeffeb3 `_ - many thanks! """ import core.module diff --git a/modules/contrib/progress.py b/modules/contrib/progress.py index fcbd8fc..4525d81 100644 --- a/modules/contrib/progress.py +++ b/modules/contrib/progress.py @@ -11,6 +11,8 @@ Parameters: Requires the following executable: * progress + +contributed by `remi-dupre `_ - many thanks! """ import core.module diff --git a/modules/contrib/rss.py b/modules/contrib/rss.py index d85f7a8..628e4d3 100644 --- a/modules/contrib/rss.py +++ b/modules/contrib/rss.py @@ -9,6 +9,8 @@ New stories are highlighted. Parameters: * rss.feeds : Space-separated list of RSS URLs * rss.length : Maximum length of the module, default is 60 + +contributed by `lonesomebyte537 `_ - many thanks! """ import feedparser diff --git a/modules/contrib/sensors.py b/modules/contrib/sensors.py index 93eff76..68b792a 100644 --- a/modules/contrib/sensors.py +++ b/modules/contrib/sensors.py @@ -12,6 +12,9 @@ Parameters: * sensors.match_pattern: (fallback) Line to match against before temperature is read (no default) * sensors.match_number: (fallback) which of the matches you want (default -1: last match). * sensors.show_freq: whether to show CPU frequency. (default: true) + + +contributed by `mijoharas `_ - many thanks! """ import re diff --git a/modules/contrib/shell.py b/modules/contrib/shell.py index 4990b15..d497adc 100644 --- a/modules/contrib/shell.py +++ b/modules/contrib/shell.py @@ -21,6 +21,8 @@ Parameters: previous one didn't finished yet. Useful for long running scripts to avoid bumblebee-status freezes (defaults to False) + +contributed by `rrhuffy `_ - many thanks! """ import os diff --git a/modules/contrib/shortcut.py b/modules/contrib/shortcut.py index ffbebfb..1ffe9d0 100644 --- a/modules/contrib/shortcut.py +++ b/modules/contrib/shortcut.py @@ -15,6 +15,9 @@ Parameters: * shortcut.cmds : List of commands to execute * shortcut.labels: List of widgets' labels (text) * shortcut.delim : Commands and labels delimiter (; semicolon by default) + + +contributed by `cacyss0807 `_ - many thanks! """ import logging diff --git a/modules/contrib/spaceapi.py b/modules/contrib/spaceapi.py index 6665043..bab64c5 100644 --- a/modules/contrib/spaceapi.py +++ b/modules/contrib/spaceapi.py @@ -24,6 +24,8 @@ Format Strings: you would write '%%state.open%%', if you also want to say 'Open/Closed' depending on the boolean you would write '%%state.open%Open%Closed%%' + +contributed by `rad4day `_ - many thanks! """ import requests diff --git a/modules/contrib/spotify.py b/modules/contrib/spotify.py index 53ae024..dc371db 100644 --- a/modules/contrib/spotify.py +++ b/modules/contrib/spotify.py @@ -14,6 +14,9 @@ Parameters: Available options for spotify.previous, spotify.next and spotify.pause are: LEFT_CLICK, RIGHT_CLICK, MIDDLE_CLICK, SCROLL_UP, SCROLL_DOWN + + +contributed by `yvesh `_ - many thanks! """ import sys diff --git a/modules/contrib/stock.py b/modules/contrib/stock.py index d225968..7c13488 100644 --- a/modules/contrib/stock.py +++ b/modules/contrib/stock.py @@ -9,6 +9,9 @@ Requires the following python packages: Parameters: * stock.symbols : Comma-separated list of symbols to fetch * stock.change : Should we fetch change in stock value (defaults to True) + + +contributed by `msoulier `_ - many thanks! """ import json diff --git a/modules/contrib/sun.py b/modules/contrib/sun.py index 4276df2..dddc10d 100644 --- a/modules/contrib/sun.py +++ b/modules/contrib/sun.py @@ -9,6 +9,10 @@ Requires the following python packages: Parameters: * cpu.lat : Latitude of your location * cpu.lon : Longitude of your location + +(if none of those are set, location is determined automatically via location APIs) + +contributed by `lonesomebyte537 `_ - many thanks! """ from suntime import Sun, SunTimeException diff --git a/modules/contrib/system.py b/modules/contrib/system.py index cc88b22..e96ee3f 100644 --- a/modules/contrib/system.py +++ b/modules/contrib/system.py @@ -20,6 +20,8 @@ Parameters: * system.lock: specify a command for locking the screen (defaults to 'i3exit lock') * system.suspend: specify a command for suspending (defaults to 'i3exit suspend') * system.hibernate: specify a command for hibernating (defaults to 'i3exit hibernate') + +contributed by `bbernhard `_ - many thanks! """ import logging diff --git a/modules/contrib/taskwarrior.py b/modules/contrib/taskwarrior.py index b2c058c..0d540b5 100644 --- a/modules/contrib/taskwarrior.py +++ b/modules/contrib/taskwarrior.py @@ -5,6 +5,9 @@ Requires the following library: Parameters: * taskwarrior.taskrc : path to the taskrc file (defaults to ~/.taskrc) + + +contributed by `chdorb `_ - many thanks! """ from taskw import TaskWarrior diff --git a/modules/contrib/title.py b/modules/contrib/title.py index 74338c2..30a3be6 100644 --- a/modules/contrib/title.py +++ b/modules/contrib/title.py @@ -9,6 +9,9 @@ Parameters: * title.max : Maximum character length for title before truncating. Defaults to 64. * title.placeholder : Placeholder text to be placed if title was truncated. Defaults to '...'. * title.scroll : Boolean flag for scrolling title. Defaults to False + + +contributed by `UltimatePancake `_ - many thanks! """ import threading diff --git a/modules/contrib/todo.py b/modules/contrib/todo.py index 15120ed..878b63f 100644 --- a/modules/contrib/todo.py +++ b/modules/contrib/todo.py @@ -4,6 +4,9 @@ Parameters: * todo.file: File to read TODOs from (defaults to ~/Documents/todo.txt) + + +contributed by `codingo `_ - many thanks! """ import os.path diff --git a/modules/contrib/traffic.py b/modules/contrib/traffic.py index a4de0b7..63e327b 100644 --- a/modules/contrib/traffic.py +++ b/modules/contrib/traffic.py @@ -11,6 +11,8 @@ Parameters: * traffic.graphlen: Graph lenth in seconds. Positive even integer. Each char shows 2 seconds. If set, enables up/down traffic graphs + +contributed by `meain `_ - many thanks! """ import re diff --git a/modules/contrib/twmn.py b/modules/contrib/twmn.py index 1a2d5a9..58b2ba1 100644 --- a/modules/contrib/twmn.py +++ b/modules/contrib/twmn.py @@ -1,6 +1,9 @@ # pylint: disable=C0111,R0903 -"""Toggle twmn notifications.""" +"""Toggle twmn notifications. + +contributed by `Pseudonick47 `_ - many thanks! +""" import core.module import core.widget diff --git a/modules/contrib/uptime.py b/modules/contrib/uptime.py index 4a9d21f..12e6839 100644 --- a/modules/contrib/uptime.py +++ b/modules/contrib/uptime.py @@ -1,6 +1,9 @@ # pylint: disable=C0111,R0903 -"""Displays the system uptime.""" +"""Displays the system uptime. + +contributed by `ccoors `_ - many thanks! +""" from datetime import timedelta diff --git a/modules/contrib/vpn.py b/modules/contrib/vpn.py index 8df5359..d9c8793 100644 --- a/modules/contrib/vpn.py +++ b/modules/contrib/vpn.py @@ -13,6 +13,8 @@ e.g: to import a openvpn profile via nmcli: `sudo nmcli connection import type openvpn file ` + +contributed by `bbernhard `_ - many thanks! """ import logging diff --git a/modules/contrib/watson.py b/modules/contrib/watson.py index ac56c8f..7887328 100644 --- a/modules/contrib/watson.py +++ b/modules/contrib/watson.py @@ -4,6 +4,8 @@ Requires the following executable: * watson + +contributed by `bendardenne `_ - many thanks! """ import logging diff --git a/modules/contrib/weather.py b/modules/contrib/weather.py index 81c86e8..0aa9785 100644 --- a/modules/contrib/weather.py +++ b/modules/contrib/weather.py @@ -14,6 +14,9 @@ Parameters: * weather.showcity: If set to true, show location information, otherwise hide it (defaults to true) * weather.showminmax: If set to true, show the minimum and maximum temperature, otherwise hide it (defaults to false) * weather.apikey: API key from http://api.openweathermap.org + + +contributed by `TheEdgeOfRage `_ - many thanks! """ import core.module diff --git a/modules/contrib/xkcd.py b/modules/contrib/xkcd.py index aa84756..c9a18d0 100644 --- a/modules/contrib/xkcd.py +++ b/modules/contrib/xkcd.py @@ -1,6 +1,9 @@ # pylint: disable=C0111,R0903 -"""Opens a random xkcd comic in the browser.""" +"""Opens a random xkcd comic in the browser. + +contributed by `whzup `_ - many thanks! +""" import core.module import core.widget diff --git a/modules/contrib/yubikey.py b/modules/contrib/yubikey.py index dce01be..6b6a3cb 100644 --- a/modules/contrib/yubikey.py +++ b/modules/contrib/yubikey.py @@ -7,6 +7,8 @@ Requires: https://github.com/Yubico/python-yubico The output indicates that a YubiKey is not connected or it displays the corresponding serial number. + +contributed by `EmmaTinten `_ - many thanks! """ import yubico diff --git a/modules/contrib/zpool.py b/modules/contrib/zpool.py index ff2ed2c..504a027 100644 --- a/modules/contrib/zpool.py +++ b/modules/contrib/zpool.py @@ -22,6 +22,8 @@ is used, the following (or ekvivalent) must be added to the `sudoers(5)`: ``` Be aware of security implications of doing this! + +contributed by `adam-dej `_ - many thanks! """ import time diff --git a/modules/core/battery-upower.py b/modules/core/battery-upower.py index cc8d3ca..9723058 100644 --- a/modules/core/battery-upower.py +++ b/modules/core/battery-upower.py @@ -6,6 +6,8 @@ Parameters: * battery-upower.warning : Warning threshold in % of remaining charge (defaults to 20) * battery-upower.critical : Critical threshold in % of remaining charge (defaults to 10) * battery-upower.showremaining : If set to true (default) shows the remaining time until the batteries are completely discharged + +contributed by `martindoublem `_ - many thanks! """ import dbus diff --git a/modules/core/battery.py b/modules/core/battery.py index d5f5cbe..7843684 100644 --- a/modules/core/battery.py +++ b/modules/core/battery.py @@ -10,6 +10,8 @@ Parameters: * battery.decorate : If set to 'false', hides additional icons (charging, etc.) (defaults to True) * battery.showpowerconsumption: If set to 'true', show current power consumption (defaults to False) * battery.compact-devices : If set to 'true', compacts multiple batteries into a single entry (default to False) + +(partially) contributed by `martindoublem `_ - many thanks! """ import os diff --git a/modules/core/brightness.py b/modules/core/brightness.py index e911db8..eb68a4f 100644 --- a/modules/core/brightness.py +++ b/modules/core/brightness.py @@ -5,6 +5,7 @@ Parameters: * brightness.step: The amount of increase/decrease on scroll in % (defaults to 2) +contributed by `TheEdgeOfRage `_ - many thanks! """ import glob diff --git a/modules/core/cmus.py b/modules/core/cmus.py index 424de49..093c367 100644 --- a/modules/core/cmus.py +++ b/modules/core/cmus.py @@ -18,6 +18,7 @@ Parameters: * cmus.server: The address of the cmus server, either a UNIX socket or host[:port]. Connects to the local instance by default. * cmus.passwd: The password to use for the TCP/IP connection. +contributed by `TheEdgeOfRage `_ - many thanks! """ from collections import defaultdict diff --git a/modules/core/kernel.py b/modules/core/kernel.py index 32b6542..00acb3a 100644 --- a/modules/core/kernel.py +++ b/modules/core/kernel.py @@ -1,6 +1,9 @@ # pylint: disable=C0111,R0903 -"""Shows Linux kernel version information""" +"""Shows Linux kernel version information + +contributed by `pierre87 `_ - many thanks! +""" import platform diff --git a/modules/core/vault.py b/modules/core/vault.py index cd627dc..92e5ba6 100644 --- a/modules/core/vault.py +++ b/modules/core/vault.py @@ -9,6 +9,8 @@ Parameters: * vault.location: Location of the password store (defaults to ~/.password-store) * vault.offx: x-axis offset of popup menu (defaults to 0) * vault.offy: y-axis offset of popup menu (defaults to 0) + +Many thanks to `bbernhard `_ for the idea! """