masq/i3pystatus
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve documentation

Browse Source
This commit is contained in:
enkore 2013-07-31 21:39:59 +02:00
parent bab4f1e402
commit e848fc4a6f
11 changed files with 123 additions and 93 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

109
README.md
View File

@ -168,10 +168,17 @@ Shows volume of ALSA mixer. You can also use this for inputs, btw.
Requires pyalsaaudio Requires pyalsaaudio
Available formatters:
* `{volume}` — the current volume in percent
* `{muted}` — the value of one of the `muted` or `unmuted` settings
* `{card}` — the associated soundcard
* `{mixer}` — the associated ALSA mixer
__Settings:__ __Settings:__
* `format` — {volume} is the current volume, {muted} is one of `muted` or `unmuted`. {card} is the sound card used; {mixer} the mixer. (default: `♪: {volume}`) * `format` — (default: `♪: {volume}`)
* `mixer` — ALSA mixer (default: `Master`) * `mixer` — ALSA mixer (default: `Master`)
* `mixer_id` — ALSA mixer id (default: `0`) * `mixer_id` — ALSA mixer id (default: `0`)
* `card` — ALSA sound card (default: `0`) * `card` — ALSA sound card (default: `0`)
@ -188,6 +195,11 @@ __Settings:__
Screen backlight info Screen backlight info
Available formatters:
* `{brightness}` — current brightness relative to max_brightness
* `{max_brightness}` — maximum brightness value
* `{percentage}` — current brightness in percent
__Settings:__ __Settings:__
@ -205,26 +217,25 @@ battery status
Available formatters for format and alert_format_\*: Available formatters for format and alert_format_\*:
* remaining_str * `{remaining_str}` — remaining time for charging or discharging in the format H:MM
* remaining_hm * `{remaining_hm}`- remaining time in the format Hh:MMm
* percentage * `{percentage}` — battery percentage relative to the last full value
* percentage_design * `{percentage_design}` — absolute battery charge percentage
* consumption (Watts) * `{consumption (Watts)}` — current power flowing into/out of the battery
* status * `{status}`
* battery_ident * `{battery_ident}` — the same as the setting
__Settings:__ __Settings:__
* `battery_ident` — (default: `BAT0`) * `battery_ident` — The name of your battery, usually BAT0 or BAT1 (default: `BAT0`)
* `format` — (default: `{status} {remaining_hm}`) * `format` — (default: `{status} {remaining_hm}`)
* `alert` — Display a libnotify-notification on low battery (default: `False`) * `alert` — Display a libnotify-notification on low battery (default: `False`)
* `alert_percentage` — (default: `10`) * `alert_percentage` — (default: `10`)
* `alert_format_title` — (default: `Low battery`) * `alert_format_title` — The title of the notification, all formatters can be used (default: `Low battery`)
* `alert_format_body` — (default: `Battery {battery_ident} has only {percentage:.2f}% ({remaining_hm}) remaining!`) * `alert_format_body` — The body text of the notification, all formatters can be used (default: `Battery {battery_ident} has only {percentage:.2f}% ({remaining_hm}) remaining!`)
* `alert_percentage` — (default: `10`) * `path` — Override the default-generated path (default: `None`)
* `path` — (default: `None`) * `status` — A dictionary mapping ('DIS', 'CHR', 'FULL') to alternative names (default: `{'DIS': 'DIS', 'FULL': 'FULL', 'CHR': 'CHR'}`)
* `status` — A dictionary mapping ('DIS', 'CHR', 'FULL') to alternative names (default: `{'FULL': 'FULL', 'CHR': 'CHR', 'DIS': 'DIS'}`)
@ -236,17 +247,17 @@ This class shows a clock
__Settings:__ __Settings:__
* `format` — stftime format string (default: `None`) * `format` — stftime format string, `None` means to use the default, locale-dependent format (default: `None`)
### disk ### disk
Gets used, free, available and total amount of bytes on the given mounted filesystem. Gets `{used}`, `{free}`, `{available}` and `{total}` amount of bytes on the given mounted filesystem.
These values can also be expressed in percentages with the percentage_used, percentage_free These values can also be expressed in percentages with the `{percentage_used}`, `{percentage_free}`
and percentage_avail formats. and `{percentage_avail}` formats.
__Settings:__ __Settings:__
@ -390,16 +401,16 @@ __Settings:__
Displays various information from MPD (the music player daemon) Displays various information from MPD (the music player daemon)
Available formatters: Available formatters:
* title (the title of the current song) * `{title}` — (the title of the current song)
* album (the album of the current song, can be an empty string (e.g. for online streams)) * `{album}` — (the album of the current song, can be an empty string (e.g. for online streams))
* artist (can be empty, too) * `{artist}` — (can be empty, too)
* song_elapsed (Position in the currently playing song, looks like 3:54) * `{song_elapsed}` — (Position in the currently playing song, looks like 3:54)
* song_length (Length of the current song, same format as song_elapsed) * `{song_length}` — (Length of the current song, same format as song_elapsed)
* pos (Position of current song in playlist, one-based) * `{pos}` — (Position of current song in playlist, one-based)
* len (Songs in playlist) * `{len}` — (Songs in playlist)
* status (play, pause, stop mapped through the `status` dictionary) * `{status}` — (play, pause, stop mapped through the `status` dictionary)
* bitrate (Current bitrate in kilobit/s) * `{bitrate}` — (Current bitrate in kilobit/s)
* volume (Volume set in MPD) * `{volume}` — (Volume set in MPD)
Left click on the module play/pauses, right click (un)mutes. Left click on the module play/pauses, right click (un)mutes.
@ -416,7 +427,7 @@ __Settings:__
* `port` — MPD port (default: `6600`) * `port` — MPD port (default: `6600`)
* `format` — (default: `{title} {status}`) * `format` — (default: `{title} {status}`)
* `format_sparse` — (default: `None`) * `format_sparse` — (default: `None`)
* `status` — Dictionary mapping pause, play and stop to output (default: `{'stop': '◾', 'play': '▶', 'pause': '▷'}`) * `status` — Dictionary mapping pause, play and stop to output (default: `{'stop': '◾', 'pause': '▷', 'play': '▶'}`)
@ -428,15 +439,15 @@ Display network information about a interface.
Requires the PyPI package `netifaces-py3`. Requires the PyPI package `netifaces-py3`.
Available formatters: Available formatters:
* `{interface}` same as setting * `{interface}` — same as setting
* `{name}` same as setting * `{name}` — same as setting
* `{v4}` IPv4 address * `{v4}` — IPv4 address
* `{v4mask}` subnet mask * `{v4mask}` — subnet mask
* `{v4cidr}` IPv4 address in cidr notation (i.e. 192.168.2.204/24) * `{v4cidr}` — IPv4 address in cidr notation (i.e. 192.168.2.204/24)
* `{v6}` IPv6 address * `{v6}` — IPv6 address
* `{v6mask}` subnet mask * `{v6mask}` — subnet mask
* `{v6cidr}` IPv6 address in cidr notation * `{v6cidr}` — IPv6 address in cidr notation
* `{mac}` MAC of interface * `{mac}` — MAC of interface
Not available addresses (i.e. no IPv6 connectivity) are replaced with empty strings. Not available addresses (i.e. no IPv6 connectivity) are replaced with empty strings.
@ -484,13 +495,13 @@ __Settings:__
Shows pyLoad status Shows pyLoad status
Available formatters: Available formatters:
* captcha (see captcha_true and captcha_false, which are the values filled in for this formatter) * `{captcha}` (see captcha_true and captcha_false, which are the values filled in for this formatter)
* progress (average over all running downloads) * `{progress}` (average over all running downloads)
* progress_all (percentage of completed files/links in queue) * `{progress_all}` (percentage of completed files/links in queue)
* speed (kilobytes/s) * `{speed}` (kilobytes/s)
* download (downloads enabled, also see download_true and download_false) * `{download}` (downloads enabled, also see download_true and download_false)
* total (number of downloads) * `{total}` (number of downloads)
* free_space (free space in download directory in gigabytes) * `{free_space}` (free space in download directory in gigabytes)
__Settings:__ __Settings:__
@ -511,6 +522,8 @@ __Settings:__
Simple regex file watcher Simple regex file watcher
The groups of the regex are passed to the format string as positional arguments.
__Settings:__ __Settings:__
@ -570,9 +583,9 @@ Requires the PyPI packages `netifaces-py3` and `basiciw`.
This is based on the network module, so all options and formatters are This is based on the network module, so all options and formatters are
the same, except for these additional formatters: the same, except for these additional formatters:
* {essid} ESSID of currently connected wifi * `{essid}` — ESSID of currently connected wifi
* {freq} Current frequency * `{freq}` — Current frequency
* {quality} Link quality in percent * `{quality}` — Link quality in percent
__Settings:__ __Settings:__

9
i3pystatus/alsa.py
View File

@ -7,12 +7,19 @@ class ALSA(IntervalModule):
Shows volume of ALSA mixer. You can also use this for inputs, btw. Shows volume of ALSA mixer. You can also use this for inputs, btw.
Requires pyalsaaudio Requires pyalsaaudio
Available formatters:
* `{volume}` — the current volume in percent
* `{muted}` — the value of one of the `muted` or `unmuted` settings
* `{card}` — the associated soundcard
* `{mixer}` — the associated ALSA mixer
""" """
interval = 1 interval = 1
settings = ( settings = (
("format", "{volume} is the current volume, {muted} is one of `muted` or `unmuted`. {card} is the sound card used; {mixer} the mixer."), "format",
("mixer", "ALSA mixer"), ("mixer", "ALSA mixer"),
("mixer_id", "ALSA mixer id"), ("mixer_id", "ALSA mixer id"),
("card", "ALSA sound card"), ("card", "ALSA sound card"),

5
i3pystatus/backlight.py
View File

@ -3,6 +3,11 @@ from i3pystatus.file import File
class Backlight(File): class Backlight(File):
""" """
Screen backlight info Screen backlight info
Available formatters:
* `{brightness}` — current brightness relative to max_brightness
* `{max_brightness}` — maximum brightness value
* `{percentage}` — current brightness in percent
""" """
settings = ( settings = (

23
i3pystatus/battery.py
View File

@ -97,20 +97,23 @@ class BatteryChecker(IntervalModule):
Available formatters for format and alert_format_\*: Available formatters for format and alert_format_\*:
* remaining_str * `{remaining_str}` — remaining time for charging or discharging in the format H:MM
* remaining_hm * `{remaining_hm}`- remaining time in the format Hh:MMm
* percentage * `{percentage}` — battery percentage relative to the last full value
* percentage_design * `{percentage_design}` — absolute battery charge percentage
* consumption (Watts) * `{consumption (Watts)}` — current power flowing into/out of the battery
* status * `{status}`
* battery_ident * `{battery_ident}` — the same as the setting
""" """
settings = ( settings = (
"battery_ident", "format", ("battery_ident", "The name of your battery, usually BAT0 or BAT1"),
"format",
("alert", "Display a libnotify-notification on low battery"), ("alert", "Display a libnotify-notification on low battery"),
"alert_percentage", "alert_format_title", "alert_format_body", "alert_percentage", "alert_percentage",
"path", ("alert_format_title", "The title of the notification, all formatters can be used"),
("alert_format_body", "The body text of the notification, all formatters can be used"),
("path", "Override the default-generated path"),
("status", "A dictionary mapping ('DIS', 'CHR', 'FULL') to alternative names"), ("status", "A dictionary mapping ('DIS', 'CHR', 'FULL') to alternative names"),
) )
battery_ident = "BAT0" battery_ident = "BAT0"

2
i3pystatus/clock.py
View File

@ -11,7 +11,7 @@ class Clock(IntervalModule):
""" """
settings = ( settings = (
("format", "stftime format string"), ("format", "stftime format string, `None` means to use the default, locale-dependent format"),
) )
format = None format = None
interval = 1 interval = 1

6
i3pystatus/disk.py
View File

@ -5,10 +5,10 @@ from .core.util import round_dict
class Disk(IntervalModule): class Disk(IntervalModule):
""" """
Gets used, free, available and total amount of bytes on the given mounted filesystem. Gets `{used}`, `{free}`, `{available}` and `{total}` amount of bytes on the given mounted filesystem.
These values can also be expressed in percentages with the percentage_used, percentage_free These values can also be expressed in percentages with the `{percentage_used}`, `{percentage_free}`
and percentage_avail formats. and `{percentage_avail}` formats.
""" """
settings = ( settings = (

22
i3pystatus/mpd.py
View File

@ -4,23 +4,23 @@ import socket
from i3pystatus import IntervalModule from i3pystatus import IntervalModule
def format_time(seconds): def format_time(seconds):
return "{}:{:02}".format(*divmod(int(seconds), 60)) return "{}:{:02}".format(*divmod(int(seconds), 60)) if seconds else ""
class MPD(IntervalModule): class MPD(IntervalModule):
""" """
Displays various information from MPD (the music player daemon) Displays various information from MPD (the music player daemon)
Available formatters: Available formatters:
* title (the title of the current song) * `{title}` — (the title of the current song)
* album (the album of the current song, can be an empty string (e.g. for online streams)) * `{album}` — (the album of the current song, can be an empty string (e.g. for online streams))
* artist (can be empty, too) * `{artist}` — (can be empty, too)
* song_elapsed (Position in the currently playing song, looks like 3:54) * `{song_elapsed}` — (Position in the currently playing song, looks like 3:54)
* song_length (Length of the current song, same format as song_elapsed) * `{song_length}` — (Length of the current song, same format as song_elapsed)
* pos (Position of current song in playlist, one-based) * `{pos}` — (Position of current song in playlist, one-based)
* len (Songs in playlist) * `{len}` — (Songs in playlist)
* status (play, pause, stop mapped through the `status` dictionary) * `{status}` — (play, pause, stop mapped through the `status` dictionary)
* bitrate (Current bitrate in kilobit/s) * `{bitrate}` — (Current bitrate in kilobit/s)
* volume (Volume set in MPD) * `{volume}` — (Volume set in MPD)
Left click on the module play/pauses, right click (un)mutes. Left click on the module play/pauses, right click (un)mutes.

18
i3pystatus/network.py
View File

@ -44,15 +44,15 @@ class Network(IntervalModule):
Requires the PyPI package `netifaces-py3`. Requires the PyPI package `netifaces-py3`.
Available formatters: Available formatters:
* `{interface}` same as setting * `{interface}` — same as setting
* `{name}` same as setting * `{name}` — same as setting
* `{v4}` IPv4 address * `{v4}` — IPv4 address
* `{v4mask}` subnet mask * `{v4mask}` — subnet mask
* `{v4cidr}` IPv4 address in cidr notation (i.e. 192.168.2.204/24) * `{v4cidr}` — IPv4 address in cidr notation (i.e. 192.168.2.204/24)
* `{v6}` IPv6 address * `{v6}` — IPv6 address
* `{v6mask}` subnet mask * `{v6mask}` — subnet mask
* `{v6cidr}` IPv6 address in cidr notation * `{v6cidr}` — IPv6 address in cidr notation
* `{mac}` MAC of interface * `{mac}` — MAC of interface
Not available addresses (i.e. no IPv6 connectivity) are replaced with empty strings. Not available addresses (i.e. no IPv6 connectivity) are replaced with empty strings.
""" """

14
i3pystatus/pyload.py
View File

@ -11,13 +11,13 @@ class pyLoad(IntervalModule):
Shows pyLoad status Shows pyLoad status
Available formatters: Available formatters:
* captcha (see captcha_true and captcha_false, which are the values filled in for this formatter) * `{captcha}` (see captcha_true and captcha_false, which are the values filled in for this formatter)
* progress (average over all running downloads) * `{progress}` (average over all running downloads)
* progress_all (percentage of completed files/links in queue) * `{progress_all}` (percentage of completed files/links in queue)
* speed (kilobytes/s) * `{speed}` (kilobytes/s)
* download (downloads enabled, also see download_true and download_false) * `{download}` (downloads enabled, also see download_true and download_false)
* total (number of downloads) * `{total}` (number of downloads)
* free_space (free space in download directory in gigabytes) * `{free_space}` (free space in download directory in gigabytes)
""" """
interval = 5 interval = 5

2
i3pystatus/regex.py
View File

@ -5,6 +5,8 @@ from i3pystatus import IntervalModule
class Regex(IntervalModule): class Regex(IntervalModule):
""" """
Simple regex file watcher Simple regex file watcher
The groups of the regex are passed to the format string as positional arguments.
""" """
flags = 0 flags = 0

6
i3pystatus/wireless.py
View File

@ -11,9 +11,9 @@ class Wireless(Network):
This is based on the network module, so all options and formatters are This is based on the network module, so all options and formatters are
the same, except for these additional formatters: the same, except for these additional formatters:
* {essid} ESSID of currently connected wifi * `{essid}` — ESSID of currently connected wifi
* {freq} Current frequency * `{freq}` — Current frequency
* {quality} Link quality in percent * `{quality}` — Link quality in percent
""" """
interface = "wlan0" interface = "wlan0"