[modules] Add contributions to (hopefully!) all modules

modules/contrib/amixer.py

@@ -2,6 +2,8 @@
 
 Parameters:
     * amixer.device: Device to use, defaults to "Master,0"
+
+contributed by `zetxx <https://github.com/zetxx>`_ - many thanks!
 """
 import re
 

modules/contrib/apt.py

@@ -5,6 +5,7 @@ Requires the following packages:
 
     * aptitude
 
+contributed by `qba10 <https://github.com/qba10>`_ - many thanks!
 """
 
 import re

modules/contrib/arch-update.py

@@ -3,6 +3,7 @@
 Requires the following executable:
     * checkupdates (from pacman-contrib)
 
+contributed by `lucassouto <https://github.com/lucassouto>`_ - many thanks!
 """
 
 import logging

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 <https://github.com/brunosmmm>`_ - many thanks!
 """
 
 

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 <https://github.com/martindoublem>`_ - many thanks!
 """
 
 

modules/contrib/caffeine.py

@@ -7,6 +7,8 @@ Requires the following executables:
     * xdotool
     * xprop (as dependency for xdotool)
     * notify-send
+
+contributed by `TheEdgeOfRage <https://github.com/TheEdgeOfRage>`_ - many thanks!
 """
 
 import logging

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 <https://github.com/somospocos>`_ - many thanks!
 """
 
 import psutil

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 <https://github.com/AntouanK>`_ - many thanks!
 """
 
 import requests

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 <https://github.com/frankzhao>`_ - many thanks!
 """
 
 from __future__ import absolute_import

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 <https://github.com/joshbarrass>`_ - many thanks!
 """
 import sys
 

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 <https://github.com/wwmoraes>`_ - many thanks!
 """
 
 import dbus

modules/contrib/docker_ps.py

@@ -5,6 +5,7 @@
 Requires the following python packages:
     * docker
 
+contributed by `jlopezzarza <https://github.com/jlopezzarza>`_ - many thanks!
 """
 
 import docker

modules/contrib/dunst.py

@@ -1,6 +1,9 @@
 # pylint: disable=C0111,R0903
 
-"""Toggle dunst notifications."""
+"""Toggle dunst notifications.
+
+contributed by `eknoes <https://github.com/eknoes>`_ - many thanks!
+"""
 
 import core.module
 import core.widget

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 <https://github.com/Ryunaq>`_ - many thanks!
 """
 
 import requests

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 <https://github.com/yvesh>`_ - many thanks!
 """
 
 import shutil

modules/contrib/gpmdp.py

@@ -4,6 +4,8 @@
 
 Requires the following executable:
     * gpmdp-remote
+
+contributed by `TheEdgeOfRage <https://github.com/TheEdgeOfRage>`_ - many thanks!
 """
 
 import core.module

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 <https://github.com/somospocos>`_ - many thanks!
 """
 
 import socket

modules/contrib/hostname.py

@@ -1,6 +1,9 @@
 # pylint: disable=C0111,R0903
 
-"""Displays the system hostname."""
+"""Displays the system hostname.
+
+contributed by `varkokonyi <https://github.com/varkokonyi>`_ - many thanks!
+"""
 
 import platform
 

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 <https://github.com/valkheim>`_ - many thanks!
 """
 
 from requests import head

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 <https://github.com/freed00m>`_ - many thanks!
 """
 
 import core.module

modules/contrib/layout-xkbswitch.py

@@ -2,6 +2,8 @@
 
 Requires the following executable:
     * xkb-switch
+
+contributed by `somospocos <https://github.com/somospocos>`_ - many thanks!
 """
 
 import core.module

modules/contrib/layout.py

@@ -4,6 +4,8 @@
 
 Requires the following executable:
     * setxkbmap
+
+contributed by `Pseudonick47 <https://github.com/Pseudonick47>`_ - many thanks!
 """
 
 import core.module

modules/contrib/libvirtvms.py

@@ -2,6 +2,8 @@
 
 Required the following python packages:
         * libvirt
+
+contributed by `maxpivo <https://github.com/maxpivo>`_ - many thanks!
 """
 
 import sys

modules/contrib/mocp.py

@@ -22,6 +22,8 @@ Parameters:
        * %cs        CurrentSec
        * %b         Bitrate
        * %r         Sample rate
+
+contributed by `chrugi <https://github.com/chrugi>`_ - many thanks!
 """
 
 import core.module

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 <https://github.com/alrayyes>`_ - many thanks!
 """
 
 from collections import defaultdict

modules/contrib/network_traffic.py

@@ -3,6 +3,8 @@
 
 """Displays network traffic
    * No extra configuration needed
+
+contributed by `izn <https://github.com/izn>`_ - many thanks!
 """
 
 import psutil

modules/contrib/notmuch_count.py

@@ -11,6 +11,8 @@ Errors:
 
 Dependencies:
     notmuch (https://notmuchmail.org/)
+
+contributed by `abdoulayeYATERA <https://github.com/abdoulayeYATERA>`_ - many thanks!
 """
 
 import os

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 <https://github.com/RileyRedpath>`_ - many thanks!
 """
 
 import core.module

modules/contrib/pacman.py

@@ -8,6 +8,8 @@ Parameters:
 Requires the following executables:
     * fakeroot
     * pacman
+
+contributed by `Pseudonick47 <https://github.com/Pseudonick47>`_ - many thanks!
 """
 
 import os

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 <https://github.com/bbernhard>`_ - many thanks!
 """
 
 import requests

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 <https://github.com/martindoublem>`_, inspired by `karthink <https://github.com/karthink>`_ - many thanks!
 """
 
 from __future__ import absolute_import

modules/contrib/prime.py

@@ -23,6 +23,7 @@ Parameters:
 Requires the following executable:
     * prime-select
 
+contributed by `jeffeb3 <https://github.com/jeffeb3>`_ - many thanks!
 """
 
 import core.module

modules/contrib/progress.py

@@ -11,6 +11,8 @@ Parameters:
 
 Requires the following executable:
    * progress
+
+contributed by `remi-dupre <https://github.com/remi-dupre>`_ - many thanks!
 """
 
 import core.module

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 <https://github.com/lonesomebyte537>`_ - many thanks!
 """
 
 import feedparser

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 <https://github.com/mijoharas>`_ - many thanks!
 """
 
 import re

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 <https://github.com/rrhuffy>`_ - many thanks!
 """
 
 import os

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 <https://github.com/cacyss0807>`_ - many thanks!
 """
 
 import logging

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 <https://github.com/rad4day>`_ - many thanks!
 """
 
 import requests

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 <https://github.com/yvesh>`_ - many thanks!
 """
 
 import sys

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 <https://github.com/msoulier>`_ - many thanks!
 """
 
 import json

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 <https://github.com/lonesomebyte537>`_ - many thanks!
 """
 
 from suntime import Sun, SunTimeException

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 <https://github.com/bbernhard>`_ - many thanks!
 """
 
 import logging

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 <https://github.com/chdorb>`_ - many thanks!
 """
 
 from taskw import TaskWarrior

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 <https://github.com/UltimatePancake>`_ - many thanks!
 """
 
 import threading

modules/contrib/todo.py

@@ -4,6 +4,9 @@
 
 Parameters:
     * todo.file: File to read TODOs from (defaults to ~/Documents/todo.txt)
+
+
+contributed by `codingo <https://github.com/codingo>`_ - many thanks!
 """
 
 import os.path

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 <https://github.com/meain>`_ - many thanks!
 """
 
 import re

modules/contrib/twmn.py

@@ -1,6 +1,9 @@
 # pylint: disable=C0111,R0903
 
-"""Toggle twmn notifications."""
+"""Toggle twmn notifications.
+
+contributed by `Pseudonick47 <https://github.com/Pseudonick47>`_ - many thanks!
+"""
 
 import core.module
 import core.widget

modules/contrib/uptime.py

@@ -1,6 +1,9 @@
 # pylint: disable=C0111,R0903
 
-"""Displays the system uptime."""
+"""Displays the system uptime.
+
+contributed by `ccoors <https://github.com/ccoors>`_ - many thanks!
+"""
 
 from datetime import timedelta
 

modules/contrib/vpn.py

@@ -13,6 +13,8 @@
 
            e.g: to import a openvpn profile via nmcli:
            `sudo nmcli connection import type openvpn file </path/to/your/openvpn/profile.ovpn>`
+
+contributed by `bbernhard <https://github.com/bbernhard>`_ - many thanks!
 """
 
 import logging

modules/contrib/watson.py

@@ -4,6 +4,8 @@
 
 Requires the following executable:
     * watson
+
+contributed by `bendardenne <https://github.com/bendardenne>`_ - many thanks!
 """
 
 import logging

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 <https://github.com/TheEdgeOfRage>`_ - many thanks!
 """
 
 import core.module

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 <https://github.com/whzup>`_ - many thanks!
+"""
 
 import core.module
 import core.widget

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 <https://github.com/EmmaTinten>`_ - many thanks!
 """
 
 import yubico

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 <https://github.com/adam-dej>`_ - many thanks!
 """
 
 import time

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 <https://github.com/martindoublem>`_ - many thanks!
 """
 
 import dbus

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 <https://github.com/martindoublem>`_ - many thanks!
 """
 
 import os

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 <https://github.com/TheEdgeOfRage>`_ - many thanks!
 """
 
 import glob

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 <https://github.com/TheEdgeOfRage>`_ - many thanks!
 """
 
 from collections import defaultdict

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 <https://github.com/pierre87>`_ - many thanks!
+"""
 
 import platform
 

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 <https://github.com/bbernhard>`_ for the idea!
 """