[modules] Add contributions to (hopefully!) all modules
This commit is contained in:
parent
5dcf9f9c9d
commit
21049b9b03
62 changed files with 278 additions and 17 deletions
135
docs/modules.rst
135
docs/modules.rst
|
@ -19,6 +19,8 @@ Parameters:
|
||||||
* battery.showpowerconsumption: If set to 'true', show current power consumption (defaults to False)
|
* 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)
|
* 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!
|
||||||
|
|
||||||
.. image:: ../screenshots/battery.png
|
.. image:: ../screenshots/battery.png
|
||||||
|
|
||||||
battery-upower
|
battery-upower
|
||||||
|
@ -31,6 +33,8 @@ Parameters:
|
||||||
* battery-upower.critical : Critical threshold in % of remaining charge (defaults to 10)
|
* 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
|
* 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!
|
||||||
|
|
||||||
brightness
|
brightness
|
||||||
~~~~~~~~~~
|
~~~~~~~~~~
|
||||||
|
|
||||||
|
@ -39,6 +43,8 @@ Displays the brightness of a display
|
||||||
Parameters:
|
Parameters:
|
||||||
* brightness.step: The amount of increase/decrease on scroll in % (defaults to 2)
|
* brightness.step: The amount of increase/decrease on scroll in % (defaults to 2)
|
||||||
|
|
||||||
|
contributed by `TheEdgeOfRage <https://github.com/TheEdgeOfRage>`_ - many thanks!
|
||||||
|
|
||||||
.. image:: ../screenshots/brightness.png
|
.. image:: ../screenshots/brightness.png
|
||||||
|
|
||||||
cmus
|
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.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.
|
* cmus.passwd: The password to use for the TCP/IP connection.
|
||||||
|
|
||||||
|
contributed by `TheEdgeOfRage <https://github.com/TheEdgeOfRage>`_ - many thanks!
|
||||||
|
|
||||||
.. image:: ../screenshots/cmus.png
|
.. image:: ../screenshots/cmus.png
|
||||||
|
|
||||||
cpu
|
cpu
|
||||||
|
@ -139,6 +147,8 @@ kernel
|
||||||
|
|
||||||
Shows Linux kernel version information
|
Shows Linux kernel version information
|
||||||
|
|
||||||
|
contributed by `pierre87 <https://github.com/pierre87>`_ - many thanks!
|
||||||
|
|
||||||
.. image:: ../screenshots/kernel.png
|
.. image:: ../screenshots/kernel.png
|
||||||
|
|
||||||
layout-xkb
|
layout-xkb
|
||||||
|
@ -248,6 +258,7 @@ Parameters:
|
||||||
'auto' uses whatever redshift is configured to do
|
'auto' uses whatever redshift is configured to do
|
||||||
* redshift.lat : latitude if location is set to 'manual'
|
* redshift.lat : latitude if location is set to 'manual'
|
||||||
* redshift.lon : longitude 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
|
.. image:: ../screenshots/redshift.png
|
||||||
|
|
||||||
|
@ -312,6 +323,8 @@ Parameters:
|
||||||
* vault.offx: x-axis offset of popup menu (defaults to 0)
|
* vault.offx: x-axis offset of popup menu (defaults to 0)
|
||||||
* vault.offy: y-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!
|
||||||
|
|
||||||
.. image:: ../screenshots/vault.png
|
.. image:: ../screenshots/vault.png
|
||||||
|
|
||||||
xrandr
|
xrandr
|
||||||
|
@ -346,6 +359,8 @@ get volume level
|
||||||
Parameters:
|
Parameters:
|
||||||
* amixer.device: Device to use, defaults to "Master,0"
|
* amixer.device: Device to use, defaults to "Master,0"
|
||||||
|
|
||||||
|
contributed by `zetxx <https://github.com/zetxx>`_ - many thanks!
|
||||||
|
|
||||||
.. image:: ../screenshots/amixer.png
|
.. image:: ../screenshots/amixer.png
|
||||||
|
|
||||||
apt
|
apt
|
||||||
|
@ -356,6 +371,8 @@ Requires the following packages:
|
||||||
|
|
||||||
* aptitude
|
* aptitude
|
||||||
|
|
||||||
|
contributed by `qba10 <https://github.com/qba10>`_ - many thanks!
|
||||||
|
|
||||||
arch-update
|
arch-update
|
||||||
~~~~~~~~~~~
|
~~~~~~~~~~~
|
||||||
|
|
||||||
|
@ -364,6 +381,8 @@ Check updates to Arch Linux.
|
||||||
Requires the following executable:
|
Requires the following executable:
|
||||||
* checkupdates (from pacman-contrib)
|
* checkupdates (from pacman-contrib)
|
||||||
|
|
||||||
|
contributed by `lucassouto <https://github.com/lucassouto>`_ - many thanks!
|
||||||
|
|
||||||
bluetooth
|
bluetooth
|
||||||
~~~~~~~~~
|
~~~~~~~~~
|
||||||
|
|
||||||
|
@ -377,6 +396,8 @@ Parameters:
|
||||||
* bluetooth.dbus_destination_path : dbus destination path (defaults to /)
|
* bluetooth.dbus_destination_path : dbus destination path (defaults to /)
|
||||||
* bluetooth.right_click_popup : use popup menu when right-clicked (defaults to True)
|
* bluetooth.right_click_popup : use popup menu when right-clicked (defaults to True)
|
||||||
|
|
||||||
|
contributed by `brunosmmm <https://github.com/brunosmmm>`_ - many thanks!
|
||||||
|
|
||||||
.. image:: ../screenshots/bluetooth.png
|
.. image:: ../screenshots/bluetooth.png
|
||||||
|
|
||||||
bluetooth2
|
bluetooth2
|
||||||
|
@ -389,6 +410,8 @@ python-dbus to count the number of connections
|
||||||
Parameters:
|
Parameters:
|
||||||
* bluetooth.manager : application to launch on click (blueman-manager)
|
* bluetooth.manager : application to launch on click (blueman-manager)
|
||||||
|
|
||||||
|
contributed by `martindoublem <https://github.com/martindoublem>`_ - many thanks!
|
||||||
|
|
||||||
caffeine
|
caffeine
|
||||||
~~~~~~~~
|
~~~~~~~~
|
||||||
|
|
||||||
|
@ -400,6 +423,8 @@ Requires the following executables:
|
||||||
* xprop (as dependency for xdotool)
|
* xprop (as dependency for xdotool)
|
||||||
* notify-send
|
* notify-send
|
||||||
|
|
||||||
|
contributed by `TheEdgeOfRage <https://github.com/TheEdgeOfRage>`_ - many thanks!
|
||||||
|
|
||||||
.. image:: ../screenshots/caffeine.png
|
.. image:: ../screenshots/caffeine.png
|
||||||
|
|
||||||
cpu2
|
cpu2
|
||||||
|
@ -438,6 +463,8 @@ Parameters:
|
||||||
Note: if you are getting 'n/a' for CPU temperature / fan speed, then you're
|
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.
|
lacking the aforementioned pattern settings or they have wrong values.
|
||||||
|
|
||||||
|
contributed by `somospocos <https://github.com/somospocos>`_ - many thanks!
|
||||||
|
|
||||||
currency
|
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
|
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!
|
||||||
|
|
||||||
.. image:: ../screenshots/currency.png
|
.. image:: ../screenshots/currency.png
|
||||||
|
|
||||||
datetimetz
|
datetimetz
|
||||||
|
@ -474,6 +503,8 @@ Parameters:
|
||||||
* timetz.locale : alias for datetimetz.locale
|
* timetz.locale : alias for datetimetz.locale
|
||||||
* timetz.timezone : alias for datetimetz.timezone
|
* timetz.timezone : alias for datetimetz.timezone
|
||||||
|
|
||||||
|
contributed by `frankzhao <https://github.com/frankzhao>`_ - many thanks!
|
||||||
|
|
||||||
datetz
|
datetz
|
||||||
~~~~~~
|
~~~~~~
|
||||||
|
|
||||||
|
@ -518,6 +549,8 @@ Parameters:
|
||||||
Available options for deadbeef.previous, deadbeef.next and deadbeef.pause are:
|
Available options for deadbeef.previous, deadbeef.next and deadbeef.pause are:
|
||||||
LEFT_CLICK, RIGHT_CLICK, MIDDLE_CLICK, SCROLL_UP, SCROLL_DOWN
|
LEFT_CLICK, RIGHT_CLICK, MIDDLE_CLICK, SCROLL_UP, SCROLL_DOWN
|
||||||
|
|
||||||
|
contributed by `joshbarrass <https://github.com/joshbarrass>`_ - many thanks!
|
||||||
|
|
||||||
deezer
|
deezer
|
||||||
~~~~~~
|
~~~~~~
|
||||||
|
|
||||||
|
@ -536,6 +569,8 @@ Parameters:
|
||||||
Available options for deezer.previous, deezer.next and deezer.pause are:
|
Available options for deezer.previous, deezer.next and deezer.pause are:
|
||||||
LEFT_CLICK, RIGHT_CLICK, MIDDLE_CLICK, SCROLL_UP, SCROLL_DOWN
|
LEFT_CLICK, RIGHT_CLICK, MIDDLE_CLICK, SCROLL_UP, SCROLL_DOWN
|
||||||
|
|
||||||
|
contributed by `wwmoraes <https://github.com/wwmoraes>`_ - many thanks!
|
||||||
|
|
||||||
dnf
|
dnf
|
||||||
~~~
|
~~~
|
||||||
|
|
||||||
|
@ -557,11 +592,15 @@ Displays the number of docker containers running
|
||||||
Requires the following python packages:
|
Requires the following python packages:
|
||||||
* docker
|
* docker
|
||||||
|
|
||||||
|
contributed by `jlopezzarza <https://github.com/jlopezzarza>`_ - many thanks!
|
||||||
|
|
||||||
dunst
|
dunst
|
||||||
~~~~~
|
~~~~~
|
||||||
|
|
||||||
Toggle dunst notifications.
|
Toggle dunst notifications.
|
||||||
|
|
||||||
|
contributed by `eknoes <https://github.com/eknoes>`_ - many thanks!
|
||||||
|
|
||||||
.. image:: ../screenshots/dunst.png
|
.. image:: ../screenshots/dunst.png
|
||||||
|
|
||||||
getcrypto
|
getcrypto
|
||||||
|
@ -579,6 +618,8 @@ Parameters:
|
||||||
* getcrypto.getltc: 0 for not getting price of LTC, 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.
|
* getcrypto.getcur: Set the currency to display the price in, usd is the default.
|
||||||
|
|
||||||
|
contributed by `Ryunaq <https://github.com/Ryunaq>`_ - many thanks!
|
||||||
|
|
||||||
.. image:: ../screenshots/getcrypto.png
|
.. image:: ../screenshots/getcrypto.png
|
||||||
|
|
||||||
github
|
github
|
||||||
|
@ -593,6 +634,8 @@ Parameters:
|
||||||
* github.token: GitHub user access token, the token needs to have the 'notifications' scope.
|
* github.token: GitHub user access token, the token needs to have the 'notifications' scope.
|
||||||
* github.interval: Interval in minutes between updates, default is 5.
|
* github.interval: Interval in minutes between updates, default is 5.
|
||||||
|
|
||||||
|
contributed by `yvesh <https://github.com/yvesh>`_ - many thanks!
|
||||||
|
|
||||||
.. image:: ../screenshots/github.png
|
.. image:: ../screenshots/github.png
|
||||||
|
|
||||||
gpmdp
|
gpmdp
|
||||||
|
@ -603,17 +646,23 @@ Displays information about the current song in Google Play music player.
|
||||||
Requires the following executable:
|
Requires the following executable:
|
||||||
* gpmdp-remote
|
* gpmdp-remote
|
||||||
|
|
||||||
|
contributed by `TheEdgeOfRage <https://github.com/TheEdgeOfRage>`_ - many thanks!
|
||||||
|
|
||||||
hddtemp
|
hddtemp
|
||||||
~~~~~~~
|
~~~~~~~
|
||||||
|
|
||||||
Fetch hard drive temeperature data from a hddtemp daemon
|
Fetch hard drive temeperature data from a hddtemp daemon
|
||||||
that runs on localhost and default port (7634)
|
that runs on localhost and default port (7634)
|
||||||
|
|
||||||
|
contributed by `somospocos <https://github.com/somospocos>`_ - many thanks!
|
||||||
|
|
||||||
hostname
|
hostname
|
||||||
~~~~~~~~
|
~~~~~~~~
|
||||||
|
|
||||||
Displays the system hostname.
|
Displays the system hostname.
|
||||||
|
|
||||||
|
contributed by `varkokonyi <https://github.com/varkokonyi>`_ - many thanks!
|
||||||
|
|
||||||
http_status
|
http_status
|
||||||
~~~~~~~~~~~
|
~~~~~~~~~~~
|
||||||
|
|
||||||
|
@ -624,6 +673,8 @@ Parameters:
|
||||||
* http__status.target: Target to retrieve the HTTP status from
|
* http__status.target: Target to retrieve the HTTP status from
|
||||||
* http__status.expect: Expected HTTP status
|
* http__status.expect: Expected HTTP status
|
||||||
|
|
||||||
|
contributed by `valkheim <https://github.com/valkheim>`_ - many thanks!
|
||||||
|
|
||||||
.. image:: ../screenshots/http_status.png
|
.. image:: ../screenshots/http_status.png
|
||||||
|
|
||||||
indicator
|
indicator
|
||||||
|
@ -635,6 +686,8 @@ Parameters:
|
||||||
* indicator.include: Comma-separated list of interface prefixes to include (defaults to 'numlock,capslock')
|
* 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')
|
* 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!
|
||||||
|
|
||||||
.. image:: ../screenshots/indicator.png
|
.. image:: ../screenshots/indicator.png
|
||||||
|
|
||||||
layout
|
layout
|
||||||
|
@ -645,6 +698,8 @@ Displays and changes the current keyboard layout
|
||||||
Requires the following executable:
|
Requires the following executable:
|
||||||
* setxkbmap
|
* setxkbmap
|
||||||
|
|
||||||
|
contributed by `Pseudonick47 <https://github.com/Pseudonick47>`_ - many thanks!
|
||||||
|
|
||||||
.. image:: ../screenshots/layout.png
|
.. image:: ../screenshots/layout.png
|
||||||
|
|
||||||
layout-xkbswitch
|
layout-xkbswitch
|
||||||
|
@ -655,6 +710,8 @@ Displays and changes the current keyboard layout
|
||||||
Requires the following executable:
|
Requires the following executable:
|
||||||
* xkb-switch
|
* xkb-switch
|
||||||
|
|
||||||
|
contributed by `somospocos <https://github.com/somospocos>`_ - many thanks!
|
||||||
|
|
||||||
libvirtvms
|
libvirtvms
|
||||||
~~~~~~~~~~
|
~~~~~~~~~~
|
||||||
|
|
||||||
|
@ -663,6 +720,8 @@ Displays count of running libvirt VMs.
|
||||||
Required the following python packages:
|
Required the following python packages:
|
||||||
* libvirt
|
* libvirt
|
||||||
|
|
||||||
|
contributed by `maxpivo <https://github.com/maxpivo>`_ - many thanks!
|
||||||
|
|
||||||
mocp
|
mocp
|
||||||
~~~~
|
~~~~
|
||||||
|
|
||||||
|
@ -688,6 +747,8 @@ Parameters:
|
||||||
* %b Bitrate
|
* %b Bitrate
|
||||||
* %r Sample rate
|
* %r Sample rate
|
||||||
|
|
||||||
|
contributed by `chrugi <https://github.com/chrugi>`_ - many thanks!
|
||||||
|
|
||||||
mpd
|
mpd
|
||||||
~~~
|
~~~
|
||||||
|
|
||||||
|
@ -734,6 +795,8 @@ Parameters:
|
||||||
* mpd.host: MPD host to connect to. (mpc behaviour by default)
|
* 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.
|
* 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!
|
||||||
|
|
||||||
.. image:: ../screenshots/mpd.png
|
.. image:: ../screenshots/mpd.png
|
||||||
|
|
||||||
network_traffic
|
network_traffic
|
||||||
|
@ -742,6 +805,8 @@ network_traffic
|
||||||
Displays network traffic
|
Displays network traffic
|
||||||
* No extra configuration needed
|
* No extra configuration needed
|
||||||
|
|
||||||
|
contributed by `izn <https://github.com/izn>`_ - many thanks!
|
||||||
|
|
||||||
notmuch_count
|
notmuch_count
|
||||||
~~~~~~~~~~~~~
|
~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
@ -757,6 +822,8 @@ Errors:
|
||||||
Dependencies:
|
Dependencies:
|
||||||
notmuch (https://notmuchmail.org/)
|
notmuch (https://notmuchmail.org/)
|
||||||
|
|
||||||
|
contributed by `abdoulayeYATERA <https://github.com/abdoulayeYATERA>`_ - many thanks!
|
||||||
|
|
||||||
nvidiagpu
|
nvidiagpu
|
||||||
~~~~~~~~~
|
~~~~~~~~~
|
||||||
|
|
||||||
|
@ -768,6 +835,8 @@ Parameters:
|
||||||
|
|
||||||
Requires nvidia-smi
|
Requires nvidia-smi
|
||||||
|
|
||||||
|
contributed by `RileyRedpath <https://github.com/RileyRedpath>`_ - many thanks!
|
||||||
|
|
||||||
octoprint
|
octoprint
|
||||||
~~~~~~~~~
|
~~~~~~~~~
|
||||||
|
|
||||||
|
@ -792,6 +861,8 @@ Requires the following executables:
|
||||||
* fakeroot
|
* fakeroot
|
||||||
* pacman
|
* pacman
|
||||||
|
|
||||||
|
contributed by `Pseudonick47 <https://github.com/Pseudonick47>`_ - many thanks!
|
||||||
|
|
||||||
.. image:: ../screenshots/pacman.png
|
.. image:: ../screenshots/pacman.png
|
||||||
|
|
||||||
pihole
|
pihole
|
||||||
|
@ -803,6 +874,8 @@ Parameters:
|
||||||
* pihole.address : pi-hole address (e.q: http://192.168.1.3)
|
* 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)
|
* 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!
|
||||||
|
|
||||||
pomodoro
|
pomodoro
|
||||||
~~~~~~~~
|
~~~~~~~~
|
||||||
|
|
||||||
|
@ -821,6 +894,8 @@ Parameters:
|
||||||
not support command chaining (see https://github.com/tobi-wan-kenobi/bumblebee-status/issues/532
|
not support command chaining (see https://github.com/tobi-wan-kenobi/bumblebee-status/issues/532
|
||||||
for a detailled explanation)
|
for a detailled explanation)
|
||||||
|
|
||||||
|
contributed by `martindoublem <https://github.com/martindoublem>`_, inspired by `karthink <https://github.com/karthink>`_ - many thanks!
|
||||||
|
|
||||||
prime
|
prime
|
||||||
~~~~~
|
~~~~~
|
||||||
|
|
||||||
|
@ -847,6 +922,8 @@ Parameters:
|
||||||
Requires the following executable:
|
Requires the following executable:
|
||||||
* prime-select
|
* prime-select
|
||||||
|
|
||||||
|
contributed by `jeffeb3 <https://github.com/jeffeb3>`_ - many thanks!
|
||||||
|
|
||||||
progress
|
progress
|
||||||
~~~~~~~~
|
~~~~~~~~
|
||||||
|
|
||||||
|
@ -863,6 +940,8 @@ Parameters:
|
||||||
Requires the following executable:
|
Requires the following executable:
|
||||||
* progress
|
* progress
|
||||||
|
|
||||||
|
contributed by `remi-dupre <https://github.com/remi-dupre>`_ - many thanks!
|
||||||
|
|
||||||
publicip
|
publicip
|
||||||
~~~~~~~~
|
~~~~~~~~
|
||||||
|
|
||||||
|
@ -889,6 +968,8 @@ Parameters:
|
||||||
* rss.feeds : Space-separated list of RSS URLs
|
* rss.feeds : Space-separated list of RSS URLs
|
||||||
* rss.length : Maximum length of the module, default is 60
|
* rss.length : Maximum length of the module, default is 60
|
||||||
|
|
||||||
|
contributed by `lonesomebyte537 <https://github.com/lonesomebyte537>`_ - many thanks!
|
||||||
|
|
||||||
sensors
|
sensors
|
||||||
~~~~~~~
|
~~~~~~~
|
||||||
|
|
||||||
|
@ -904,6 +985,9 @@ Parameters:
|
||||||
* sensors.match_number: (fallback) which of the matches you want (default -1: last match).
|
* sensors.match_number: (fallback) which of the matches you want (default -1: last match).
|
||||||
* sensors.show_freq: whether to show CPU frequency. (default: true)
|
* sensors.show_freq: whether to show CPU frequency. (default: true)
|
||||||
|
|
||||||
|
|
||||||
|
contributed by `mijoharas <https://github.com/mijoharas>`_ - many thanks!
|
||||||
|
|
||||||
.. image:: ../screenshots/sensors.png
|
.. image:: ../screenshots/sensors.png
|
||||||
|
|
||||||
shell
|
shell
|
||||||
|
@ -931,6 +1015,8 @@ Parameters:
|
||||||
running scripts to avoid bumblebee-status freezes
|
running scripts to avoid bumblebee-status freezes
|
||||||
(defaults to False)
|
(defaults to False)
|
||||||
|
|
||||||
|
contributed by `rrhuffy <https://github.com/rrhuffy>`_ - many thanks!
|
||||||
|
|
||||||
shortcut
|
shortcut
|
||||||
~~~~~~~~
|
~~~~~~~~
|
||||||
|
|
||||||
|
@ -950,6 +1036,9 @@ Parameters:
|
||||||
* shortcut.labels: List of widgets' labels (text)
|
* shortcut.labels: List of widgets' labels (text)
|
||||||
* shortcut.delim : Commands and labels delimiter (; semicolon by default)
|
* shortcut.delim : Commands and labels delimiter (; semicolon by default)
|
||||||
|
|
||||||
|
|
||||||
|
contributed by `cacyss0807 <https://github.com/cacyss0807>`_ - many thanks!
|
||||||
|
|
||||||
.. image:: ../screenshots/shortcut.png
|
.. image:: ../screenshots/shortcut.png
|
||||||
|
|
||||||
smartstatus
|
smartstatus
|
||||||
|
@ -959,7 +1048,8 @@ Displays HDD smart status of different drives or all drives
|
||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
* smartstatus.display: how to display (defaults to 'combined', other choices: 'seperate' or 'singles')
|
* 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
|
spaceapi
|
||||||
~~~~~~~~
|
~~~~~~~~
|
||||||
|
@ -986,6 +1076,8 @@ Format Strings:
|
||||||
to say 'Open/Closed' depending on the boolean you
|
to say 'Open/Closed' depending on the boolean you
|
||||||
would write '%%state.open%Open%Closed%%'
|
would write '%%state.open%Open%Closed%%'
|
||||||
|
|
||||||
|
contributed by `rad4day <https://github.com/rad4day>`_ - many thanks!
|
||||||
|
|
||||||
spotify
|
spotify
|
||||||
~~~~~~~
|
~~~~~~~
|
||||||
|
|
||||||
|
@ -1004,6 +1096,9 @@ Parameters:
|
||||||
Available options for spotify.previous, spotify.next and spotify.pause are:
|
Available options for spotify.previous, spotify.next and spotify.pause are:
|
||||||
LEFT_CLICK, RIGHT_CLICK, MIDDLE_CLICK, SCROLL_UP, SCROLL_DOWN
|
LEFT_CLICK, RIGHT_CLICK, MIDDLE_CLICK, SCROLL_UP, SCROLL_DOWN
|
||||||
|
|
||||||
|
|
||||||
|
contributed by `yvesh <https://github.com/yvesh>`_ - many thanks!
|
||||||
|
|
||||||
.. image:: ../screenshots/spotify.png
|
.. image:: ../screenshots/spotify.png
|
||||||
|
|
||||||
stock
|
stock
|
||||||
|
@ -1018,6 +1113,9 @@ Parameters:
|
||||||
* stock.symbols : Comma-separated list of symbols to fetch
|
* stock.symbols : Comma-separated list of symbols to fetch
|
||||||
* stock.change : Should we fetch change in stock value (defaults to True)
|
* stock.change : Should we fetch change in stock value (defaults to True)
|
||||||
|
|
||||||
|
|
||||||
|
contributed by `msoulier <https://github.com/msoulier>`_ - many thanks!
|
||||||
|
|
||||||
.. image:: ../screenshots/stock.png
|
.. image:: ../screenshots/stock.png
|
||||||
|
|
||||||
sun
|
sun
|
||||||
|
@ -1033,6 +1131,10 @@ Parameters:
|
||||||
* cpu.lat : Latitude of your location
|
* cpu.lat : Latitude of your location
|
||||||
* cpu.lon : Longitude 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!
|
||||||
|
|
||||||
system
|
system
|
||||||
~~~~~~
|
~~~~~~
|
||||||
|
|
||||||
|
@ -1056,6 +1158,8 @@ Parameters:
|
||||||
* system.suspend: specify a command for suspending (defaults to 'i3exit suspend')
|
* system.suspend: specify a command for suspending (defaults to 'i3exit suspend')
|
||||||
* system.hibernate: specify a command for hibernating (defaults to 'i3exit hibernate')
|
* system.hibernate: specify a command for hibernating (defaults to 'i3exit hibernate')
|
||||||
|
|
||||||
|
contributed by `bbernhard <https://github.com/bbernhard>`_ - many thanks!
|
||||||
|
|
||||||
taskwarrior
|
taskwarrior
|
||||||
~~~~~~~~~~~
|
~~~~~~~~~~~
|
||||||
|
|
||||||
|
@ -1067,6 +1171,9 @@ Requires the following library:
|
||||||
Parameters:
|
Parameters:
|
||||||
* taskwarrior.taskrc : path to the taskrc file (defaults to ~/.taskrc)
|
* taskwarrior.taskrc : path to the taskrc file (defaults to ~/.taskrc)
|
||||||
|
|
||||||
|
|
||||||
|
contributed by `chdorb <https://github.com/chdorb>`_ - many thanks!
|
||||||
|
|
||||||
.. image:: ../screenshots/taskwarrior.png
|
.. image:: ../screenshots/taskwarrior.png
|
||||||
|
|
||||||
timetz
|
timetz
|
||||||
|
@ -1091,6 +1198,9 @@ Parameters:
|
||||||
* title.placeholder : Placeholder text to be placed if title was truncated. Defaults to '...'.
|
* title.placeholder : Placeholder text to be placed if title was truncated. Defaults to '...'.
|
||||||
* title.scroll : Boolean flag for scrolling title. Defaults to False
|
* title.scroll : Boolean flag for scrolling title. Defaults to False
|
||||||
|
|
||||||
|
|
||||||
|
contributed by `UltimatePancake <https://github.com/UltimatePancake>`_ - many thanks!
|
||||||
|
|
||||||
.. image:: ../screenshots/title.png
|
.. image:: ../screenshots/title.png
|
||||||
|
|
||||||
todo
|
todo
|
||||||
|
@ -1101,6 +1211,9 @@ Displays the number of todo items from a text file
|
||||||
Parameters:
|
Parameters:
|
||||||
* todo.file: File to read TODOs from (defaults to ~/Documents/todo.txt)
|
* todo.file: File to read TODOs from (defaults to ~/Documents/todo.txt)
|
||||||
|
|
||||||
|
|
||||||
|
contributed by `codingo <https://github.com/codingo>`_ - many thanks!
|
||||||
|
|
||||||
.. image:: ../screenshots/todo.png
|
.. image:: ../screenshots/todo.png
|
||||||
|
|
||||||
traffic
|
traffic
|
||||||
|
@ -1118,6 +1231,8 @@ Parameters:
|
||||||
char shows 2 seconds. If set, enables up/down traffic
|
char shows 2 seconds. If set, enables up/down traffic
|
||||||
graphs
|
graphs
|
||||||
|
|
||||||
|
contributed by `meain <https://github.com/meain>`_ - many thanks!
|
||||||
|
|
||||||
.. image:: ../screenshots/traffic.png
|
.. image:: ../screenshots/traffic.png
|
||||||
|
|
||||||
twmn
|
twmn
|
||||||
|
@ -1125,11 +1240,15 @@ twmn
|
||||||
|
|
||||||
Toggle twmn notifications.
|
Toggle twmn notifications.
|
||||||
|
|
||||||
|
contributed by `Pseudonick47 <https://github.com/Pseudonick47>`_ - many thanks!
|
||||||
|
|
||||||
uptime
|
uptime
|
||||||
~~~~~~
|
~~~~~~
|
||||||
|
|
||||||
Displays the system uptime.
|
Displays the system uptime.
|
||||||
|
|
||||||
|
contributed by `ccoors <https://github.com/ccoors>`_ - many thanks!
|
||||||
|
|
||||||
.. image:: ../screenshots/uptime.png
|
.. image:: ../screenshots/uptime.png
|
||||||
|
|
||||||
vpn
|
vpn
|
||||||
|
@ -1149,6 +1268,8 @@ Prerequisites:
|
||||||
e.g: to import a openvpn profile via nmcli:
|
e.g: to import a openvpn profile via nmcli:
|
||||||
`sudo nmcli connection import type openvpn file </path/to/your/openvpn/profile.ovpn>`
|
`sudo nmcli connection import type openvpn file </path/to/your/openvpn/profile.ovpn>`
|
||||||
|
|
||||||
|
contributed by `bbernhard <https://github.com/bbernhard>`_ - many thanks!
|
||||||
|
|
||||||
watson
|
watson
|
||||||
~~~~~~
|
~~~~~~
|
||||||
|
|
||||||
|
@ -1157,6 +1278,8 @@ Displays the status of watson (time-tracking tool)
|
||||||
Requires the following executable:
|
Requires the following executable:
|
||||||
* watson
|
* watson
|
||||||
|
|
||||||
|
contributed by `bendardenne <https://github.com/bendardenne>`_ - many thanks!
|
||||||
|
|
||||||
weather
|
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.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
|
* weather.apikey: API key from http://api.openweathermap.org
|
||||||
|
|
||||||
|
|
||||||
|
contributed by `TheEdgeOfRage <https://github.com/TheEdgeOfRage>`_ - many thanks!
|
||||||
|
|
||||||
.. image:: ../screenshots/weather.png
|
.. image:: ../screenshots/weather.png
|
||||||
|
|
||||||
xkcd
|
xkcd
|
||||||
|
@ -1181,6 +1307,8 @@ xkcd
|
||||||
|
|
||||||
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!
|
||||||
|
|
||||||
yubikey
|
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 output indicates that a YubiKey is not connected or it displays
|
||||||
the corresponding serial number.
|
the corresponding serial number.
|
||||||
|
|
||||||
|
|
||||||
|
contributed by `EmmaTinten <https://github.com/EmmaTinten>`_ - many thanks!
|
||||||
|
|
||||||
zpool
|
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!
|
Be aware of security implications of doing this!
|
||||||
|
|
||||||
|
contributed by `adam-dej <https://github.com/adam-dej>`_ - many thanks!
|
||||||
|
|
||||||
.. image:: ../screenshots/zpool.png
|
.. image:: ../screenshots/zpool.png
|
||||||
|
|
|
@ -22,3 +22,4 @@
|
||||||
# documentation
|
# documentation
|
||||||
Add info about error widget and events for error logging
|
Add info about error widget and events for error logging
|
||||||
- add module contributor doc
|
- add module contributor doc
|
||||||
|
- which location APIs are used?
|
||||||
|
|
|
@ -2,6 +2,8 @@
|
||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
* amixer.device: Device to use, defaults to "Master,0"
|
* amixer.device: Device to use, defaults to "Master,0"
|
||||||
|
|
||||||
|
contributed by `zetxx <https://github.com/zetxx>`_ - many thanks!
|
||||||
"""
|
"""
|
||||||
import re
|
import re
|
||||||
|
|
||||||
|
|
|
@ -5,6 +5,7 @@ Requires the following packages:
|
||||||
|
|
||||||
* aptitude
|
* aptitude
|
||||||
|
|
||||||
|
contributed by `qba10 <https://github.com/qba10>`_ - many thanks!
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import re
|
import re
|
||||||
|
|
|
@ -3,6 +3,7 @@
|
||||||
Requires the following executable:
|
Requires the following executable:
|
||||||
* checkupdates (from pacman-contrib)
|
* checkupdates (from pacman-contrib)
|
||||||
|
|
||||||
|
contributed by `lucassouto <https://github.com/lucassouto>`_ - many thanks!
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import logging
|
import logging
|
||||||
|
|
|
@ -8,6 +8,7 @@ Parameters:
|
||||||
* bluetooth.dbus_destination_path : dbus destination path (defaults to /)
|
* bluetooth.dbus_destination_path : dbus destination path (defaults to /)
|
||||||
* bluetooth.right_click_popup : use popup menu when right-clicked (defaults to True)
|
* bluetooth.right_click_popup : use popup menu when right-clicked (defaults to True)
|
||||||
|
|
||||||
|
contributed by `brunosmmm <https://github.com/brunosmmm>`_ - many thanks!
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -4,6 +4,8 @@ python-dbus to count the number of connections
|
||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
* bluetooth.manager : application to launch on click (blueman-manager)
|
* bluetooth.manager : application to launch on click (blueman-manager)
|
||||||
|
|
||||||
|
contributed by `martindoublem <https://github.com/martindoublem>`_ - many thanks!
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -7,6 +7,8 @@ Requires the following executables:
|
||||||
* xdotool
|
* xdotool
|
||||||
* xprop (as dependency for xdotool)
|
* xprop (as dependency for xdotool)
|
||||||
* notify-send
|
* notify-send
|
||||||
|
|
||||||
|
contributed by `TheEdgeOfRage <https://github.com/TheEdgeOfRage>`_ - many thanks!
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import logging
|
import logging
|
||||||
|
|
|
@ -31,6 +31,7 @@ Parameters:
|
||||||
Note: if you are getting 'n/a' for CPU temperature / fan speed, then you're
|
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.
|
lacking the aforementioned pattern settings or they have wrong values.
|
||||||
|
|
||||||
|
contributed by `somospocos <https://github.com/somospocos>`_ - many thanks!
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import psutil
|
import psutil
|
||||||
|
|
|
@ -15,6 +15,8 @@ Parameters:
|
||||||
* currency.destinationdelimiter: Delimiter used for separating individual rates (defaults to '|')
|
* 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
|
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
|
import requests
|
||||||
|
|
|
@ -12,6 +12,8 @@ Parameters:
|
||||||
* datetz.locale : alias for datetimetz.locale
|
* datetz.locale : alias for datetimetz.locale
|
||||||
* timetz.locale : alias for datetimetz.locale
|
* timetz.locale : alias for datetimetz.locale
|
||||||
* timetz.timezone : alias for datetimetz.timezone
|
* timetz.timezone : alias for datetimetz.timezone
|
||||||
|
|
||||||
|
contributed by `frankzhao <https://github.com/frankzhao>`_ - many thanks!
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from __future__ import absolute_import
|
from __future__ import absolute_import
|
||||||
|
|
|
@ -32,6 +32,7 @@ Parameters:
|
||||||
Available options for deadbeef.previous, deadbeef.next and deadbeef.pause are:
|
Available options for deadbeef.previous, deadbeef.next and deadbeef.pause are:
|
||||||
LEFT_CLICK, RIGHT_CLICK, MIDDLE_CLICK, SCROLL_UP, SCROLL_DOWN
|
LEFT_CLICK, RIGHT_CLICK, MIDDLE_CLICK, SCROLL_UP, SCROLL_DOWN
|
||||||
|
|
||||||
|
contributed by `joshbarrass <https://github.com/joshbarrass>`_ - many thanks!
|
||||||
"""
|
"""
|
||||||
import sys
|
import sys
|
||||||
|
|
||||||
|
|
|
@ -14,6 +14,8 @@ Parameters:
|
||||||
|
|
||||||
Available options for deezer.previous, deezer.next and deezer.pause are:
|
Available options for deezer.previous, deezer.next and deezer.pause are:
|
||||||
LEFT_CLICK, RIGHT_CLICK, MIDDLE_CLICK, SCROLL_UP, SCROLL_DOWN
|
LEFT_CLICK, RIGHT_CLICK, MIDDLE_CLICK, SCROLL_UP, SCROLL_DOWN
|
||||||
|
|
||||||
|
contributed by `wwmoraes <https://github.com/wwmoraes>`_ - many thanks!
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import dbus
|
import dbus
|
||||||
|
|
|
@ -5,6 +5,7 @@
|
||||||
Requires the following python packages:
|
Requires the following python packages:
|
||||||
* docker
|
* docker
|
||||||
|
|
||||||
|
contributed by `jlopezzarza <https://github.com/jlopezzarza>`_ - many thanks!
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import docker
|
import docker
|
||||||
|
|
|
@ -1,6 +1,9 @@
|
||||||
# pylint: disable=C0111,R0903
|
# pylint: disable=C0111,R0903
|
||||||
|
|
||||||
"""Toggle dunst notifications."""
|
"""Toggle dunst notifications.
|
||||||
|
|
||||||
|
contributed by `eknoes <https://github.com/eknoes>`_ - many thanks!
|
||||||
|
"""
|
||||||
|
|
||||||
import core.module
|
import core.module
|
||||||
import core.widget
|
import core.widget
|
||||||
|
|
|
@ -11,6 +11,8 @@ Parameters:
|
||||||
* getcrypto.geteth: 0 for not getting price of ETH, 1 for getting it (default).
|
* 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.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.
|
* 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
|
import requests
|
||||||
|
|
|
@ -8,6 +8,8 @@ Requires the following library:
|
||||||
Parameters:
|
Parameters:
|
||||||
* github.token: GitHub user access token, the token needs to have the 'notifications' scope.
|
* github.token: GitHub user access token, the token needs to have the 'notifications' scope.
|
||||||
* github.interval: Interval in minutes between updates, default is 5.
|
* github.interval: Interval in minutes between updates, default is 5.
|
||||||
|
|
||||||
|
contributed by `yvesh <https://github.com/yvesh>`_ - many thanks!
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import shutil
|
import shutil
|
||||||
|
|
|
@ -4,6 +4,8 @@
|
||||||
|
|
||||||
Requires the following executable:
|
Requires the following executable:
|
||||||
* gpmdp-remote
|
* gpmdp-remote
|
||||||
|
|
||||||
|
contributed by `TheEdgeOfRage <https://github.com/TheEdgeOfRage>`_ - many thanks!
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import core.module
|
import core.module
|
||||||
|
|
|
@ -2,6 +2,8 @@
|
||||||
|
|
||||||
"""Fetch hard drive temeperature data from a hddtemp daemon
|
"""Fetch hard drive temeperature data from a hddtemp daemon
|
||||||
that runs on localhost and default port (7634)
|
that runs on localhost and default port (7634)
|
||||||
|
|
||||||
|
contributed by `somospocos <https://github.com/somospocos>`_ - many thanks!
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import socket
|
import socket
|
||||||
|
|
|
@ -1,6 +1,9 @@
|
||||||
# pylint: disable=C0111,R0903
|
# pylint: disable=C0111,R0903
|
||||||
|
|
||||||
"""Displays the system hostname."""
|
"""Displays the system hostname.
|
||||||
|
|
||||||
|
contributed by `varkokonyi <https://github.com/varkokonyi>`_ - many thanks!
|
||||||
|
"""
|
||||||
|
|
||||||
import platform
|
import platform
|
||||||
|
|
||||||
|
|
|
@ -6,6 +6,8 @@ Parameters:
|
||||||
* http__status.label: Prefix label (optional)
|
* http__status.label: Prefix label (optional)
|
||||||
* http__status.target: Target to retrieve the HTTP status from
|
* http__status.target: Target to retrieve the HTTP status from
|
||||||
* http__status.expect: Expected HTTP status
|
* http__status.expect: Expected HTTP status
|
||||||
|
|
||||||
|
contributed by `valkheim <https://github.com/valkheim>`_ - many thanks!
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from requests import head
|
from requests import head
|
||||||
|
|
|
@ -5,6 +5,8 @@
|
||||||
Parameters:
|
Parameters:
|
||||||
* indicator.include: Comma-separated list of interface prefixes to include (defaults to 'numlock,capslock')
|
* 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')
|
* 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
|
import core.module
|
||||||
|
|
|
@ -2,6 +2,8 @@
|
||||||
|
|
||||||
Requires the following executable:
|
Requires the following executable:
|
||||||
* xkb-switch
|
* xkb-switch
|
||||||
|
|
||||||
|
contributed by `somospocos <https://github.com/somospocos>`_ - many thanks!
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import core.module
|
import core.module
|
||||||
|
|
|
@ -4,6 +4,8 @@
|
||||||
|
|
||||||
Requires the following executable:
|
Requires the following executable:
|
||||||
* setxkbmap
|
* setxkbmap
|
||||||
|
|
||||||
|
contributed by `Pseudonick47 <https://github.com/Pseudonick47>`_ - many thanks!
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import core.module
|
import core.module
|
||||||
|
|
|
@ -2,6 +2,8 @@
|
||||||
|
|
||||||
Required the following python packages:
|
Required the following python packages:
|
||||||
* libvirt
|
* libvirt
|
||||||
|
|
||||||
|
contributed by `maxpivo <https://github.com/maxpivo>`_ - many thanks!
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import sys
|
import sys
|
||||||
|
|
|
@ -22,6 +22,8 @@ Parameters:
|
||||||
* %cs CurrentSec
|
* %cs CurrentSec
|
||||||
* %b Bitrate
|
* %b Bitrate
|
||||||
* %r Sample rate
|
* %r Sample rate
|
||||||
|
|
||||||
|
contributed by `chrugi <https://github.com/chrugi>`_ - many thanks!
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import core.module
|
import core.module
|
||||||
|
|
|
@ -43,6 +43,8 @@ Parameters:
|
||||||
|
|
||||||
* mpd.host: MPD host to connect to. (mpc behaviour by default)
|
* 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.
|
* 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
|
from collections import defaultdict
|
||||||
|
|
|
@ -3,6 +3,8 @@
|
||||||
|
|
||||||
"""Displays network traffic
|
"""Displays network traffic
|
||||||
* No extra configuration needed
|
* No extra configuration needed
|
||||||
|
|
||||||
|
contributed by `izn <https://github.com/izn>`_ - many thanks!
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import psutil
|
import psutil
|
||||||
|
|
|
@ -11,6 +11,8 @@ Errors:
|
||||||
|
|
||||||
Dependencies:
|
Dependencies:
|
||||||
notmuch (https://notmuchmail.org/)
|
notmuch (https://notmuchmail.org/)
|
||||||
|
|
||||||
|
contributed by `abdoulayeYATERA <https://github.com/abdoulayeYATERA>`_ - many thanks!
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import os
|
import os
|
||||||
|
|
|
@ -7,6 +7,8 @@ Parameters:
|
||||||
Available values are: {name} {temp} {mem_used} {mem_total} {fanspeed} {clock_gpu} {clock_mem}
|
Available values are: {name} {temp} {mem_used} {mem_total} {fanspeed} {clock_gpu} {clock_mem}
|
||||||
|
|
||||||
Requires nvidia-smi
|
Requires nvidia-smi
|
||||||
|
|
||||||
|
contributed by `RileyRedpath <https://github.com/RileyRedpath>`_ - many thanks!
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import core.module
|
import core.module
|
||||||
|
|
|
@ -8,6 +8,8 @@ Parameters:
|
||||||
Requires the following executables:
|
Requires the following executables:
|
||||||
* fakeroot
|
* fakeroot
|
||||||
* pacman
|
* pacman
|
||||||
|
|
||||||
|
contributed by `Pseudonick47 <https://github.com/Pseudonick47>`_ - many thanks!
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import os
|
import os
|
||||||
|
|
|
@ -5,6 +5,8 @@
|
||||||
Parameters:
|
Parameters:
|
||||||
* pihole.address : pi-hole address (e.q: http://192.168.1.3)
|
* 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)
|
* 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
|
import requests
|
||||||
|
|
|
@ -14,6 +14,8 @@ Parameters:
|
||||||
please use an external wrapper script and invoke that. The module itself does
|
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
|
not support command chaining (see https://github.com/tobi-wan-kenobi/bumblebee-status/issues/532
|
||||||
for a detailled explanation)
|
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
|
from __future__ import absolute_import
|
||||||
|
|
|
@ -23,6 +23,7 @@ Parameters:
|
||||||
Requires the following executable:
|
Requires the following executable:
|
||||||
* prime-select
|
* prime-select
|
||||||
|
|
||||||
|
contributed by `jeffeb3 <https://github.com/jeffeb3>`_ - many thanks!
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import core.module
|
import core.module
|
||||||
|
|
|
@ -11,6 +11,8 @@ Parameters:
|
||||||
|
|
||||||
Requires the following executable:
|
Requires the following executable:
|
||||||
* progress
|
* progress
|
||||||
|
|
||||||
|
contributed by `remi-dupre <https://github.com/remi-dupre>`_ - many thanks!
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import core.module
|
import core.module
|
||||||
|
|
|
@ -9,6 +9,8 @@ New stories are highlighted.
|
||||||
Parameters:
|
Parameters:
|
||||||
* rss.feeds : Space-separated list of RSS URLs
|
* rss.feeds : Space-separated list of RSS URLs
|
||||||
* rss.length : Maximum length of the module, default is 60
|
* rss.length : Maximum length of the module, default is 60
|
||||||
|
|
||||||
|
contributed by `lonesomebyte537 <https://github.com/lonesomebyte537>`_ - many thanks!
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import feedparser
|
import feedparser
|
||||||
|
|
|
@ -12,6 +12,9 @@ Parameters:
|
||||||
* sensors.match_pattern: (fallback) Line to match against before temperature is read (no default)
|
* 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.match_number: (fallback) which of the matches you want (default -1: last match).
|
||||||
* sensors.show_freq: whether to show CPU frequency. (default: true)
|
* sensors.show_freq: whether to show CPU frequency. (default: true)
|
||||||
|
|
||||||
|
|
||||||
|
contributed by `mijoharas <https://github.com/mijoharas>`_ - many thanks!
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import re
|
import re
|
||||||
|
|
|
@ -21,6 +21,8 @@ Parameters:
|
||||||
previous one didn't finished yet. Useful for long
|
previous one didn't finished yet. Useful for long
|
||||||
running scripts to avoid bumblebee-status freezes
|
running scripts to avoid bumblebee-status freezes
|
||||||
(defaults to False)
|
(defaults to False)
|
||||||
|
|
||||||
|
contributed by `rrhuffy <https://github.com/rrhuffy>`_ - many thanks!
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import os
|
import os
|
||||||
|
|
|
@ -15,6 +15,9 @@ Parameters:
|
||||||
* shortcut.cmds : List of commands to execute
|
* shortcut.cmds : List of commands to execute
|
||||||
* shortcut.labels: List of widgets' labels (text)
|
* shortcut.labels: List of widgets' labels (text)
|
||||||
* shortcut.delim : Commands and labels delimiter (; semicolon by default)
|
* shortcut.delim : Commands and labels delimiter (; semicolon by default)
|
||||||
|
|
||||||
|
|
||||||
|
contributed by `cacyss0807 <https://github.com/cacyss0807>`_ - many thanks!
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import logging
|
import logging
|
||||||
|
|
|
@ -24,6 +24,8 @@ Format Strings:
|
||||||
you would write '%%state.open%%', if you also want
|
you would write '%%state.open%%', if you also want
|
||||||
to say 'Open/Closed' depending on the boolean you
|
to say 'Open/Closed' depending on the boolean you
|
||||||
would write '%%state.open%Open%Closed%%'
|
would write '%%state.open%Open%Closed%%'
|
||||||
|
|
||||||
|
contributed by `rad4day <https://github.com/rad4day>`_ - many thanks!
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import requests
|
import requests
|
||||||
|
|
|
@ -14,6 +14,9 @@ Parameters:
|
||||||
|
|
||||||
Available options for spotify.previous, spotify.next and spotify.pause are:
|
Available options for spotify.previous, spotify.next and spotify.pause are:
|
||||||
LEFT_CLICK, RIGHT_CLICK, MIDDLE_CLICK, SCROLL_UP, SCROLL_DOWN
|
LEFT_CLICK, RIGHT_CLICK, MIDDLE_CLICK, SCROLL_UP, SCROLL_DOWN
|
||||||
|
|
||||||
|
|
||||||
|
contributed by `yvesh <https://github.com/yvesh>`_ - many thanks!
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import sys
|
import sys
|
||||||
|
|
|
@ -9,6 +9,9 @@ Requires the following python packages:
|
||||||
Parameters:
|
Parameters:
|
||||||
* stock.symbols : Comma-separated list of symbols to fetch
|
* stock.symbols : Comma-separated list of symbols to fetch
|
||||||
* stock.change : Should we fetch change in stock value (defaults to True)
|
* stock.change : Should we fetch change in stock value (defaults to True)
|
||||||
|
|
||||||
|
|
||||||
|
contributed by `msoulier <https://github.com/msoulier>`_ - many thanks!
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import json
|
import json
|
||||||
|
|
|
@ -9,6 +9,10 @@ Requires the following python packages:
|
||||||
Parameters:
|
Parameters:
|
||||||
* cpu.lat : Latitude of your location
|
* cpu.lat : Latitude of your location
|
||||||
* cpu.lon : Longitude 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
|
from suntime import Sun, SunTimeException
|
||||||
|
|
|
@ -20,6 +20,8 @@ Parameters:
|
||||||
* system.lock: specify a command for locking the screen (defaults to 'i3exit lock')
|
* 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.suspend: specify a command for suspending (defaults to 'i3exit suspend')
|
||||||
* system.hibernate: specify a command for hibernating (defaults to 'i3exit hibernate')
|
* system.hibernate: specify a command for hibernating (defaults to 'i3exit hibernate')
|
||||||
|
|
||||||
|
contributed by `bbernhard <https://github.com/bbernhard>`_ - many thanks!
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import logging
|
import logging
|
||||||
|
|
|
@ -5,6 +5,9 @@ Requires the following library:
|
||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
* taskwarrior.taskrc : path to the taskrc file (defaults to ~/.taskrc)
|
* taskwarrior.taskrc : path to the taskrc file (defaults to ~/.taskrc)
|
||||||
|
|
||||||
|
|
||||||
|
contributed by `chdorb <https://github.com/chdorb>`_ - many thanks!
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from taskw import TaskWarrior
|
from taskw import TaskWarrior
|
||||||
|
|
|
@ -9,6 +9,9 @@ Parameters:
|
||||||
* title.max : Maximum character length for title before truncating. Defaults to 64.
|
* 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.placeholder : Placeholder text to be placed if title was truncated. Defaults to '...'.
|
||||||
* title.scroll : Boolean flag for scrolling title. Defaults to False
|
* title.scroll : Boolean flag for scrolling title. Defaults to False
|
||||||
|
|
||||||
|
|
||||||
|
contributed by `UltimatePancake <https://github.com/UltimatePancake>`_ - many thanks!
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import threading
|
import threading
|
||||||
|
|
|
@ -4,6 +4,9 @@
|
||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
* todo.file: File to read TODOs from (defaults to ~/Documents/todo.txt)
|
* todo.file: File to read TODOs from (defaults to ~/Documents/todo.txt)
|
||||||
|
|
||||||
|
|
||||||
|
contributed by `codingo <https://github.com/codingo>`_ - many thanks!
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import os.path
|
import os.path
|
||||||
|
|
|
@ -11,6 +11,8 @@ Parameters:
|
||||||
* traffic.graphlen: Graph lenth in seconds. Positive even integer. Each
|
* traffic.graphlen: Graph lenth in seconds. Positive even integer. Each
|
||||||
char shows 2 seconds. If set, enables up/down traffic
|
char shows 2 seconds. If set, enables up/down traffic
|
||||||
graphs
|
graphs
|
||||||
|
|
||||||
|
contributed by `meain <https://github.com/meain>`_ - many thanks!
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import re
|
import re
|
||||||
|
|
|
@ -1,6 +1,9 @@
|
||||||
# pylint: disable=C0111,R0903
|
# pylint: disable=C0111,R0903
|
||||||
|
|
||||||
"""Toggle twmn notifications."""
|
"""Toggle twmn notifications.
|
||||||
|
|
||||||
|
contributed by `Pseudonick47 <https://github.com/Pseudonick47>`_ - many thanks!
|
||||||
|
"""
|
||||||
|
|
||||||
import core.module
|
import core.module
|
||||||
import core.widget
|
import core.widget
|
||||||
|
|
|
@ -1,6 +1,9 @@
|
||||||
# pylint: disable=C0111,R0903
|
# 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
|
from datetime import timedelta
|
||||||
|
|
||||||
|
|
|
@ -13,6 +13,8 @@
|
||||||
|
|
||||||
e.g: to import a openvpn profile via nmcli:
|
e.g: to import a openvpn profile via nmcli:
|
||||||
`sudo nmcli connection import type openvpn file </path/to/your/openvpn/profile.ovpn>`
|
`sudo nmcli connection import type openvpn file </path/to/your/openvpn/profile.ovpn>`
|
||||||
|
|
||||||
|
contributed by `bbernhard <https://github.com/bbernhard>`_ - many thanks!
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import logging
|
import logging
|
||||||
|
|
|
@ -4,6 +4,8 @@
|
||||||
|
|
||||||
Requires the following executable:
|
Requires the following executable:
|
||||||
* watson
|
* watson
|
||||||
|
|
||||||
|
contributed by `bendardenne <https://github.com/bendardenne>`_ - many thanks!
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import logging
|
import logging
|
||||||
|
|
|
@ -14,6 +14,9 @@ Parameters:
|
||||||
* weather.showcity: If set to true, show location information, otherwise hide it (defaults to true)
|
* 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.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
|
* weather.apikey: API key from http://api.openweathermap.org
|
||||||
|
|
||||||
|
|
||||||
|
contributed by `TheEdgeOfRage <https://github.com/TheEdgeOfRage>`_ - many thanks!
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import core.module
|
import core.module
|
||||||
|
|
|
@ -1,6 +1,9 @@
|
||||||
# pylint: disable=C0111,R0903
|
# 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.module
|
||||||
import core.widget
|
import core.widget
|
||||||
|
|
|
@ -7,6 +7,8 @@ Requires: https://github.com/Yubico/python-yubico
|
||||||
The output indicates that a YubiKey is not connected or it displays
|
The output indicates that a YubiKey is not connected or it displays
|
||||||
the corresponding serial number.
|
the corresponding serial number.
|
||||||
|
|
||||||
|
|
||||||
|
contributed by `EmmaTinten <https://github.com/EmmaTinten>`_ - many thanks!
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import yubico
|
import yubico
|
||||||
|
|
|
@ -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!
|
Be aware of security implications of doing this!
|
||||||
|
|
||||||
|
contributed by `adam-dej <https://github.com/adam-dej>`_ - many thanks!
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import time
|
import time
|
||||||
|
|
|
@ -6,6 +6,8 @@ Parameters:
|
||||||
* battery-upower.warning : Warning threshold in % of remaining charge (defaults to 20)
|
* 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.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
|
* 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
|
import dbus
|
||||||
|
|
|
@ -10,6 +10,8 @@ Parameters:
|
||||||
* battery.decorate : If set to 'false', hides additional icons (charging, etc.) (defaults to True)
|
* 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.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)
|
* 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
|
import os
|
||||||
|
|
|
@ -5,6 +5,7 @@
|
||||||
Parameters:
|
Parameters:
|
||||||
* brightness.step: The amount of increase/decrease on scroll in % (defaults to 2)
|
* brightness.step: The amount of increase/decrease on scroll in % (defaults to 2)
|
||||||
|
|
||||||
|
contributed by `TheEdgeOfRage <https://github.com/TheEdgeOfRage>`_ - many thanks!
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import glob
|
import glob
|
||||||
|
|
|
@ -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.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.
|
* cmus.passwd: The password to use for the TCP/IP connection.
|
||||||
|
|
||||||
|
contributed by `TheEdgeOfRage <https://github.com/TheEdgeOfRage>`_ - many thanks!
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from collections import defaultdict
|
from collections import defaultdict
|
||||||
|
|
|
@ -1,6 +1,9 @@
|
||||||
# pylint: disable=C0111,R0903
|
# 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
|
import platform
|
||||||
|
|
||||||
|
|
|
@ -9,6 +9,8 @@ Parameters:
|
||||||
* vault.location: Location of the password store (defaults to ~/.password-store)
|
* vault.location: Location of the password store (defaults to ~/.password-store)
|
||||||
* vault.offx: x-axis offset of popup menu (defaults to 0)
|
* vault.offx: x-axis offset of popup menu (defaults to 0)
|
||||||
* vault.offy: y-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!
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue