Everything you need to know about Qtile¶

Default Configuration¶

The default configuration is invoked when qtile cannot find a configuration file. In addition, if qtile is restarted via qsh, qtile will load the default configuration if the config file it finds has some kind of error in it. The documentation below describes the configuration lookup process, as well as what the key bindings are in the default config.

The default config is not intended to be sutiable for all users; it’s mostly just there so qtile does /something/ when fired up, and so that it doesn’t crash and cause you to lose all your work if you reload a bad config.

Running Inside Gnome¶

Add the following snippet to your Qtile configuration. As per this page, it registers Qtile with gnome-session. Without it, a “Something has gone wrong!” message shows up a short while after logging in. dbus-send must be on your $PATH.

import subprocess
import os

@hook.subscribe.startup
def dbus_register():
    x = os.environ['DESKTOP_AUTOSTART_ID']
    subprocess.Popen(['dbus-send',
                      '--session',
                      '--print-reply=string',
                      '--dest=org.gnome.SessionManager',
                      '/org/gnome/SessionManager',
                      'org.gnome.SessionManager.RegisterClient',
                      'string:qtile',
                      'string:' + x])

This adds a new entry “Qtile GNOME” to GDM’s login screen.

$ cat /usr/share/xsessions/qtile_gnome.desktop
[Desktop Entry]
Name=Qtile GNOME
Comment=Tiling window manager
TryExec=/usr/bin/gnome-session
Exec=gnome-session --session=qtile
Type=XSession

The custom session for gnome-session.

$ cat /usr/share/gnome-session/sessions/qtile.session
[GNOME Session]
Name=Qtile session
RequiredComponents=qtile;gnome-settings-daemon;

So that Qtile starts automatically on login.

$ cat /usr/share/applications/qtile.desktop
[Desktop Entry]
Type=Application
Encoding=UTF-8
Name=Qtile
Exec=qtile
NoDisplay=true
X-GNOME-WMName=Qtile
X-GNOME-Autostart-Phase=WindowManager
X-GNOME-Provides=windowmanager
X-GNOME-Autostart-Notify=false

The above does not start gnome-panel. Getting gnome-panel to work requires some extra Qtile configuration, mainly making the top and bottom panels static on panel startup and leaving a gap at the top (and bottom) for the panel window.

You might want to add keybindings to log out of the GNOME session.

Key([mod, 'control'], 'l', lazy.spawn('gnome-screensaver-command -l')),
Key([mod, 'control'], 'q', lazy.spawn('gnome-session-quit --logout --no-prompt')),
Key([mod, 'shift', 'control'], 'q', lazy.spawn('gnome-session-quit --power-off')),

The above apps need to be in your path (though they are typically installed in /usr/bin, so they probably are if they’re installed at all).

Built-in Hooks¶

classmethod subscribe.group_window_add(func)¶

Called when a new window is added to a group.

classmethod subscribe.selection_change(func)¶

Called on selection chance.

classmethod subscribe.client_killed(func)¶

Called after a client has been unmanaged.

• arguments: window.Window object of the killed window.

classmethod subscribe.startup_once(func)¶

Called when Qtile has initialized, exactly once (i.e. not on each lazy.restart()).

classmethod subscribe.setgroup(func)¶

Called when group is changed.

classmethod subscribe.selection_notify(func)¶

Called on selection notify.

classmethod subscribe.changegroup(func)¶

Called whenever a group change occurs.

classmethod subscribe.window_name_change(func)¶

Called whenever a windows name changes.

classmethod subscribe.delgroup(func)¶

Called when group is deleted.

classmethod subscribe.client_focus(func)¶

Called whenver focus changes.

• arguments: window.Window object of the new focus.

classmethod subscribe.screen_change(func)¶

Called when a screen is added or screen configuration is changed (via xrandr). The hook should take two arguments: the root qtile object and the xproto.randr.ScreenChangeNotify event. Common usage is simply to call qtile.cmd_restart() on each event (to restart qtile when there is a new monitor):

## Example:

def restart_on_randr(qtile, ev):

qtile.cmd_restart()

classmethod subscribe.startup(func)¶

Called each time qtile is started (including the first time qtile starts)

classmethod subscribe.client_managed(func)¶

Called after Qtile starts managing a new client. That is, after a window is assigned to a group, or when a window is made static. This hook is not called for internal windows.

• arguments: window.Window object

classmethod subscribe.net_wm_icon_change(func)¶

Called on _NET_WM_ICON chance.

classmethod subscribe.client_urgent_hint_changed(func)¶

Called when the client urgent hint changes.

classmethod subscribe.layout_change(func)¶

Called on layout change.

classmethod subscribe.client_state_changed(func)¶

Called whenever client state changes.

classmethod subscribe.client_name_updated(func)¶

Called when the client name changes.

classmethod subscribe.client_new(func)¶

Called before Qtile starts managing a new client. Use this hook to declare windows static, or add them to a group on startup. This hook is not called for internal windows.

• arguments: window.Window object

## Example:

def func(c):

if c.name == “xterm”:

c.togroup(“a”)

elif c.name == “dzen”:

c.static(0)

libqtile.hook.subscribe.client_new(func)

classmethod subscribe.focus_change(func)¶

Called when focus is changed.

classmethod subscribe.current_screen_change(func)¶

Called when the current screen (i.e. the screen with focus) changes; no arguments.

classmethod subscribe.float_change(func)¶

Called when a change in float state is made

classmethod subscribe.addgroup(func)¶

Called when group is added.

classmethod subscribe.client_type_changed(func)¶

Called whenever window type changes.

classmethod subscribe.client_mouse_enter(func)¶

Called when the mouse enters a client.

Built-in Layouts¶

class libqtile.layout.floating.Floating(float_rules=None, **config)[source]¶

Floating layout, which does nothing with windows but handles focus order

key	default	description
border_focus	'#0000ff'	Border colour for the focused window.
border_normal	'#000000'	Border colour for un-focused winows.
border_width	1	Border width.
max_border_width	0	Border width for maximize.
fullscreen_border_width	0	Border width for fullscreen.
name	'floating'	Name of this layout.
auto_float_types	set(['dialog', 'notification', 'splash', 'toolbar', 'utility'])	default wm types to automatically float

__init__(float_rules=None, **config)[source]¶

If you have certain apps that you always want to float you can provide float_rules to do so. float_rules is a list of dictionaries containing:

{wname: WM_NAME, wmclass: WM_CLASS role: WM_WINDOW_ROLE}

The keys must be specified as above. You only need one, but you need to provide the value for it. When a new window is opened it’s match method is called with each of these rules. If one matches, the window will float. The following will float gimp and skype:

float_rules=[dict(wmclass=”skype”), dict(wmclass=”gimp”)]

Specify these in the floating_layout in your config.

class libqtile.layout.matrix.Matrix(columns=2, **config)[source]¶

This layout divides the screen into a matrix of equally sized cells and places one window in each cell. The number of columns is configurable and can also be changed interactively.

key	default	description
border_focus	'#0000ff'	Border colour for the focused window.
border_normal	'#000000'	Border colour for un-focused winows.
border_width	1	Border width.
name	'matrix'	Name of this layout.
margin	0	Margin of the layout

class libqtile.layout.max.Max(**config)[source]¶

A simple layout that only displays one window at a time, filling the screen. This is suitable for use on laptops and other devices with small screens. Conceptually, the windows are managed as a stack, with commands to switch to next and previous windows in the stack.

key	default	description
name	'max'	Name of this layout.

class libqtile.layout.ratiotile.RatioTile(ratio=1.618, ratio_increment=0.1, fancy=False, **config)[source]¶

Tries to tile all windows in the width/height ratio passed in

key	default	description
border_focus	'#0000ff'	Border colour for the focused window.
border_normal	'#000000'	Border colour for un-focused winows.
border_width	1	Border width.
name	'ratiotile'	Name of this layout.
margin	0	Margin of the layout

class libqtile.layout.slice.Slice(side, width, wname=None, wmclass=None, role=None, fallback=<libqtile.layout.max.Max object at 0x7f4de8583290>, **config)[source]¶

Slice layout

This layout cuts piece of screen and places a single window on that piece, and delegates other window placement to other layout

key	default	description
width	256	Slice width
side	'left'	Side of the slice (left, right, top, bottom)
name	'max'	Name of this layout.

class libqtile.layout.stack.Stack(**config)[source]¶

The stack layout divides the screen horizontally into a set of stacks. Commands allow you to switch between stacks, to next and previous windows within a stack, and to split a stack to show all windows in the stack, or unsplit it to show only the current window. At the moment, this is the most mature and flexible layout in Qtile.

key	default	description
border_focus	'#0000ff'	Border colour for the focused window.
border_normal	'#000000'	Border colour for un-focused winows.
border_width	1	Border width.
name	'stack'	Name of this layout.
autosplit	False	Auto split all new stacks.
num_stacks	2	Number of stacks.
fair	False	Add new windows to the stacks in a round robin way.
margin	0	Margin of the layout

class libqtile.layout.tile.Tile(ratio=0.618, masterWindows=1, expand=True, ratio_increment=0.05, add_on_top=True, shift_windows=False, master_match=None, **config)[source]¶

key	default	description
border_focus	'#0000ff'	Border colour for the focused window.
border_normal	'#000000'	Border colour for un-focused winows.
border_width	1	Border width.
name	'tile'	Name of this layout.
margin	0	Margin of the layout

class libqtile.layout.tree.TreeTab(**config)[source]¶

Tree Tab Layout

This layout works just like Max but displays tree of the windows at the left border of the screen, which allows you to overview all opened windows. It’s designed to work with uzbl-browser but works with other windows too.

key	default	description
bg_color	'000000'	Background color of tabs
active_bg	'000080'	Background color of active tab
active_fg	'ffffff'	Foreground color of active tab
inactive_bg	'606060'	Background color of inactive tab
inactive_fg	'ffffff'	Foreground color of inactive tab
margin_left	6	Left margin of tab panel
margin_y	6	Vertical margin of tab panel
padding_left	6	Left padding for tabs
padding_x	6	Left padding for tab label
padding_y	2	Top padding for tab label
border_width	2	Width of the border
vspace	2	Space between tabs
level_shift	8	Shift for children tabs
font	'Arial'	Font
fontsize	14	Font pixel size.
fontshadow	None	font shadow color, default is None (no shadow)
section_fontsize	11	Font pixel size of section label
section_fg	'ffffff'	Color of section label
section_top	4	Top margin of section label
section_bottom	6	Bottom margin of section
section_padding	4	Bottom of magin section label
section_left	4	Left margin of section label
panel_width	150	Width of the left panel
sections	['Default']	Foreground color of inactive tab
name	'treetab'	Name of this layout.
previous_on_rm	False	Focus previous window on close instead of first.

class libqtile.layout.verticaltile.VerticalTile(**config)[source]¶

VerticalTile implements a tiling layout that works nice on vertically mounted monitors. The available height gets divided by the number of panes, if no pane is maximized. If one pane has been maximized, the available height gets split in master- and secondary area. The maximized pane (master pane) gets the full height of the master area and the other panes (secondary panes) share the remaining space. The master area (at default 75%) can grow and shrink via keybindings.

—————– —————– — | | | | | | 1 | <– Panes | | | | | | | | | |—————| | | | | | | | | | | | 2 | <—–+ | 1 | | Master Area | | | | | | |—————| | | | | | | | | | | | 3 | <—–+ | | | | | | | | | |—————| | |—————| — | | | | 2 | | | 4 | <—–+ |—————| | Secondary Area | | | 3 | | —————– —————– —

Normal behavior. No One maximized pane in the master area maximized pane. No and two secondary panes in the specific areas. secondary area.

———————————– In some cases VerticalTile can be | | useful on horizontal mounted | 1 | monitors two. | | For example if you want to have a |———————————| webbrowser and a shell below it. | | | 2 | | | ———————————–

Keybindings:

Key([modkey], ‘j’, lazy.layout.down()), Key([modkey], ‘k’, lazy.layout.up()), Key([modkey], ‘Tab’, lazy.layout.next()), Key([modkey, ‘shift’], ‘Tab’, lazy.layout.next()), Key([modkey, ‘shift’], ‘j’, lazy.layout.shuffle_down()), Key([modkey, ‘shift’], ‘k’, lazy.layout.shuffle_up()), Key([modkey], ‘m’, lazy.layout.maximize()), Key([modkey], ‘n’, lazy.layout.normalize()),

key	default	description
border_focus	'#FF0000'	Border color for the focused window.
border_normal	'#FFFFFF'	Border color for un-focused winows.
border_width	1	Border width.
margin	0	Border margin.
name	'VerticalTile'	Name of this layout.

class libqtile.layout.zoomy.Zoomy(**config)[source]¶

A layout with single active windows, and few other previews at the right

key	default	description
columnwidth	150	Width of the right column
property_name	'ZOOM'	Property to set on zoomed window
property_small	'0.1'	Property value to set on zoomed window
property_big	'1.0'	Property value to set on normal window
margin	0	Margin of the layout

Built-in Widgets¶

class libqtile.widget.AGroupBox(**config)¶

A widget that graphically displays the current group.

key	default	description
border	'000000'	group box border color

class libqtile.widget.Backlight(**config)¶

A simple widget to show the current brightness of a monitor.

key	default	description
backlight_name	'acpi_video0'	ACPI name of a backlight device
brightness_file	'brightness'	Name of file with the current brightness in /sys/class/backlight/backlight_name
max_brightness_file	'max_brightness'	Name of file with the maximum brightness in /sys/class/backlight/backlight_name
update_interval	0.2	The delay in seconds between updates

class libqtile.widget.Battery(**config)¶

A simple but flexible text-based battery widget.

key	default	description
low_foreground	'FF0000'	font color when battery is low
format	'{char} {percent:2.0%} {hour:d}:{min:02d}'	Display format
charge_char	'^'	Character to indicate the battery is charging
discharge_char	'V'	Character to indicate the battery is discharging
low_percentage	0.1	0 < x < 1 at which to indicate battery is low with low_foreground
hide_threshold	None	Hide the text when there is enough energy

class libqtile.widget.BatteryIcon(**config)¶

Battery life indicator widget

key	default	description
theme_path	'/var/build/user_builds/qtile-dmp/checkouts/feature-docs-ng/libqtile/resources/battery-icons'	Path of the icons
custom_icons	{}	dict containing key->filename icon map

class libqtile.widget.BitcoinTicker(**config)¶

A bitcoin ticker widget, data provided by the btc-e.com API. Defaults to displaying currency in whatever the current locale is.

key	default	description
currency	''	The currency the value of bitcoin is displayed in
format	'BTC Buy: {buy}, Sell: {sell}'	Display format, allows buy, sell, high, low, avg, vol, vol_cur, last, variables.

class libqtile.widget.CPUGraph(**config)¶

Display CPU usage graph.

key	default	description
core	'all'	Which core to show (all/0/1/2/...)

class libqtile.widget.Canto(**config)¶

Display RSS feeds updates using the canto console reader.

key	default	description
fetch	False	Whether to fetch new items on update
feeds	[]	List of feeds to display, empty for all
one_format	'{name}: {number}'	One feed display format
all_format	'{number}'	All feeds display format

class libqtile.widget.Clipboard(width=CALCULATED, **config)¶

Display current clipboard contents.

key	default	description
selection	'CLIPBOARD'	the selection to display(CLIPBOARD or PRIMARY)
max_width	10	maximum number of characters to display (None for all, useful when width is bar.STRETCH)
timeout	10	Default timeout (seconds) for display text, None to keep forever
blacklist	['keepassx']	list with blacklisted wm_class, sadly not every clipboard window sets them, keepassx does.Clipboard contents from blacklisted wm_classes will be replaced by the value of blacklist_text.
blacklist_text	'***********'	text to display when the wm_class is blacklisted

class libqtile.widget.Clock(fmt=None, **config)¶

A simple but flexible text-based clock.

key	default	description
format	'%H:%M'	A Python datetime format string
update_interval	1.0	Update interval for the clock
timezone	None	The timezone to use for this clock, e.g. “US/Central” (or anything in /usr/share/zoneinfo). None means the default timezone.

class libqtile.widget.Countdown(**config)¶

A simple countdown timer text widget.

key	default	description
format	'{D}d {H}h {M}m {S}s'	Format of the displayed text. Available variables:{D} == days, {H} == hours, {M} == minutes, {S} seconds.
update_interval	1.0	Update interval in seconds for the clock
date	datetime.datetime(2015, 1, 15, 11, 54, 32, 31698)	The datetime for the endo of the countdown

class libqtile.widget.CurrentLayout(width=CALCULATED, **config)¶

Display the name of the current layout of the current group of the screen, the bar containing the widget, is on.

key	default	description
font	'Arial'	Default font
fontsize	None	Font size. Calculated if None.
padding	None	Padding. Calculated if None.
foreground	'ffffff'	Foreground colour
fontshadow	None	font shadow color, default is None(no shadow)
markup	False	Whether or not to use pango markup

class libqtile.widget.DF(**config)¶

Disk Free Widget

By default the widget only displays if the space is less than warn_space

key	default	description
partition	'/'	the partition to check space
warn_color	'ff0000'	Warning color
warn_space	2	Warning space in scale defined by the measure option.
visible_on_warn	True	Only display if warning
measure	'G'	Measurement (G, M, B)
format	'{p} ({uf}{m})'	String format (p: partition, s: size, f: free space, uf: user free space, m: measure)
update_interval	60	The update inteval.

class libqtile.widget.DebugInfo(width=CALCULATED, **config)¶

Displays debugging infos about selected window

key	default	description
font	'Arial'	Default font
fontsize	None	Font size. Calculated if None.
padding	None	Padding. Calculated if None.
foreground	'ffffff'	Foreground colour
fontshadow	None	font shadow color, default is None(no shadow)
markup	False	Whether or not to use pango markup

__init__(width=CALCULATED, **config)¶

• width: A fixed width, or bar.CALCULATED to calculate the width

automatically (wich is recommended).

class libqtile.widget.GmailChecker(settings=None, **config)¶

A simple gmail checker. settings = {

‘username’: username, ‘password’: password, ‘email_path’: valide email path, ‘fmt’: “format string fot textbox widget”, #if status_only_unseen is True #example “my unseen[%s]”, #if status_only_unseen is False #example “messages: %s, unseen: %s” status_only_unseen: True or False

}

key	default	description
update_interval	30	Update time in seconds.
username	None	username
password	None	password
email_path	'INBOX'	email_path
fmt	'inbox[%s],unseen[%s]'	fmt
status_only_unseen	False	Only show unseen messages

class libqtile.widget.GroupBox(**config)¶

A widget that graphically displays the current group.

key	default	description
active	'FFFFFF'	Active group font colour
inactive	'404040'	Inactive group font colour
urgent_text	'FF0000'	Urgent group font color
highlight_method	'border'	Method of highlighting (one of ‘border’ or ‘block’) Uses *_border color settings
rounded	True	To round or not to round borders
this_current_screen_border	'215578'	Border colour for group on this screen when focused.
urgent_alert_method	'border'	Method for alerting you of WM urgent hints (one of ‘border’, ‘text’ or ‘block’)
disable_drag	False	Disable dragging and dropping of group names on widget
this_screen_border	'215578'	Border colour for group on this screen.
other_screen_border	'404040'	Border colour for group on other screen.
urgent_border	'FF0000'	Urgent border color
invert_mouse_wheel	False	Whether to invert mouse wheel group movement

class libqtile.widget.HDDBusyGraph(**config)¶

Parses /sys/block/<dev>/stat file and extracts overall device IO usage, based on io_ticks‘s value. See https://www.kernel.org/doc/Documentation/block/stat.txt

key	default	description
device	'sda'	Block device to display info for

class libqtile.widget.HDDGraph(**config)¶

Display HDD free or used space graph.

key	default	description
path	'/'	Partition mount point.
space_type	'used'	free/used

class libqtile.widget.Image(width=CALCULATED, **config)¶

Display a PNG image on the bar.

key	default	description
scale	True	Enable/Disable image scaling
filename	None	PNG Image filename. Can contain ‘~’

class libqtile.widget.KeyboardLayout(**config)¶

Widget for changing and displaying the current keyboard layout. It requires setxkbmap to be available in the sytem.

key	default	description
update_interval	1	Update time in seconds.
configured_keyboards	'us'	A list of predefined keyboard layouts represented as strings. For example: [‘us’, ‘us colemak’, ‘es’, ‘fr’].

class libqtile.widget.Maildir(maildirPath=None, subFolders=None, separator=' ', **config)¶

A simple widget showing the number of new mails in maildir mailboxes.

key	default	description
maildirPath	'~/Mail'	path to the Maildir folder
subFolders	[]	The subfolders to scan (e.g. [{“path”: “INBOX”, “label”: “Home mail”}, {“path”: “spam”, “label”: “Home junk”}]
separator	' '	the string to put between the subfolder strings.

class libqtile.widget.MemoryGraph(**config)¶

Displays a memory usage graph.

key	default	description
graph_color	'18BAEB'	Graph color
fill_color	'1667EB.3'	Fill color for linefill graph
border_color	'215578'	Widget border color
border_width	2	Widget border width
margin_x	3	Margin X
margin_y	3	Margin Y
samples	100	Count of graph samples.
frequency	1	Update frequency in seconds
type	'linefill'	‘box’, ‘line’, ‘linefill’
line_width	3	Line width
start_pos	'bottom'	Drawer starting position (‘bottom’/’top’)

class libqtile.widget.Net(**config)¶

Displays interface down and up speed.

key	default	description
interface	'wlan0'	The interface to monitor
update_interval	1	The update interval.

class libqtile.widget.NetGraph(**config)¶

Display a network usage graph.

key	default	description
interface	'auto'	Interface to display info for (‘auto’ for detection)
bandwidth_type	'down'	down(load)/up(load)

class libqtile.widget.Notify(width=CALCULATED, **config)¶

A notify widget

key	default	description
foreground_urgent	'ff0000'	Foreground urgent priority colour
foreground_low	'dddddd'	Foreground low priority colour
default_timeout	None	Default timeout (seconds) for notifications

class libqtile.widget.Pacman(**config)¶

Shows number of available updates. Needs the pacman package manager installed. So will only work in Arch Linux installation.

key	default	description
unavailable	'ffffff'	Unavailable Color - no updates.
execute	None	Command to execute on click
update_interval	60	The update interval.

class libqtile.widget.Prompt(name='prompt', **config)¶

A widget that prompts for user input. Input should be started using the .startInput method on this class.

key	default	description
cursorblink	0.5	Cursor blink rate. 0 to disable.
prompt	'{prompt}: '	Text displayed at the prompt

class libqtile.widget.Sep(**config)¶

A visible widget separator.

key	default	description
padding	2	Padding on either side of separator.
linewidth	1	Width of separator line.
foreground	'888888'	Separator line colour.
height_percent	80	Height as a percentage of bar height (0-100).

class libqtile.widget.She(**config)¶

Widget to display the Super Hybrid Engine status. can display either the mode or CPU speed on eeepc computers.

key	default	description
device	'/sys/devices/platform/eeepc/cpufv'	sys path to cpufv
format	'speed'	Type of info to display “speed” or “name”
update_interval	0.5	Update Time in seconds.

class libqtile.widget.Spacer(width=STRETCH)¶

Just an empty space on the bar. Often used with width equal to bar.STRETCH to push bar widgets to the right edge of the screen.

key	default	description
background	None	Widget background color

__init__(width=STRETCH)¶

• width: Width of the widget. Can be either bar.STRETCH or a width in pixels.

class libqtile.widget.SwapGraph(**config)¶

Display a swap info graph.

key	default	description
graph_color	'18BAEB'	Graph color
fill_color	'1667EB.3'	Fill color for linefill graph
border_color	'215578'	Widget border color
border_width	2	Widget border width
margin_x	3	Margin X
margin_y	3	Margin Y
samples	100	Count of graph samples.
frequency	1	Update frequency in seconds
type	'linefill'	‘box’, ‘line’, ‘linefill’
line_width	3	Line width
start_pos	'bottom'	Drawer starting position (‘bottom’/’top’)

class libqtile.widget.Systray(**config)¶

A widget that manage system tray

key	default	description
icon_size	20	Icon width
padding	5	Padding between icons

class libqtile.widget.TaskList(**config)¶

key	default	description
font	'Arial'	Default font
fontsize	None	Font size. Calculated if None.
foreground	'ffffff'	Foreground colour
fontshadow	None	font shadow color, default is None(no shadow)
borderwidth	2	Current group border width
border	'215578'	Border colour
rounded	True	To round or not to round borders
highlight_method	'border'	Method of highlighting (one of ‘border’ or ‘block’) Uses *_border color settings
urgent_border	'FF0000'	Urgent border color
urgent_alert_method	'border'	Method for alerting you of WM urgent hints (one of ‘border’ or ‘text’)
max_title_width	200	size in pixels of task title

class libqtile.widget.TextBox(text=' ', width=CALCULATED, **config)¶

A flexible textbox that can be updated from bound keys, scripts and qsh.

key	default	description
font	'Arial'	Text font
fontsize	None	Font pixel size. Calculated if None.
fontshadow	None	font shadow color, default is None(no shadow)
padding	None	Padding left and right. Calculated if None.
foreground	'#ffffff'	Foreground colour.

__init__(text=' ', width=CALCULATED, **config)¶

• text: Initial widget text.
• width: An integer width, bar.STRETCH, or bar.CALCULATED .

class libqtile.widget.ThermalSensor(**config)¶

For using the thermal sensor widget you need to have lm-sensors installed. You can get a list of the tag_sensors executing “sensors” in your terminal. Then you can choose which you want, otherwise it will display the first available.

key	default	description
metric	True	True to use metric/C, False to use imperial/F
show_tag	False	Show tag sensor
update_interval	2	Update interval in seconds
tag_sensor	None	Tag of the temperature sensor. For example: “temp1” or “Core 0”
threshold	70	If the current temperature value is above, then change to foreground_alert colour
foreground_alert	'ff0000'	Foreground colour alert

class libqtile.widget.Volume(**config)¶

Widget that display and change volume if theme_path is set it draw widget as icons

key	default	description
cardid	0	Card Id
channel	'Master'	Channel
padding	3	Padding left and right. Calculated if None.
theme_path	None	Path of the icons
update_interval	0.2	Update time in seconds.
emoji	False	Use emoji to display volume states, only if theme_path is not set.The specified font needs to contain the correct unicode characters.
mute_command	None	Mute command
volume_up_command	None	Volume up command
volume_down_command	None	Volume down command

class libqtile.widget.WindowName(width=STRETCH, **config)¶

Displays the name of the window that currently has focus.

key	default	description
font	'Arial'	Default font
fontsize	None	Font size. Calculated if None.
padding	None	Padding. Calculated if None.
foreground	'ffffff'	Foreground colour
fontshadow	None	font shadow color, default is None(no shadow)
markup	False	Whether or not to use pango markup

class libqtile.widget.WindowTabs(**config)¶

Displays the name of each window in the current group. Contrary to TaskList this is not an interactive widget. The window that currently has focus is highlighted.

key	default	description
separator	' | '	Task separator text.
selected	('<', '>')	Selected task indicator

class libqtile.widget.YahooWeather(**config)¶

A weather widget, data provided by the Yahoo! Weather API Format options:

astronomy_sunrise, astronomy_sunset atmosphere_humidity, atmosphere_visibility, atmosphere_pressure, atmosphere_rising condition_text, condition_code, condition_temp, condition_date location_city. location_region, location_country units_temperature, units_distance, units_pressure, units_speed wind_chill, wind_direction, wind_speed

key	default	description
location	None	Location to fetch weather for. Ignored if woeid is set.
woeid	None	Where On Earth ID. Auto-calculated if location is set.
format	'{location_city}: {condition_temp} \xc2\xb0{units_temperature}'	Display format
metric	True	True to use metric/C, False to use imperial/F
up	'^'	symbol for rising atmospheric pressure
down	'v'	symbol for falling atmospheric pressure
steady	's'	symbol for steady atmospheric pressure