My collection of plugins for the Qtile window manager.
git clone https://mcol.xyz/code/qtools
Log | Files | Refs | README

commit 72368620f29d913fb5c655ee53e874ed6fd9a1e5
parent 991f20cc403d29863b530613972cae55cf85f235
Author: mcol <mcol@posteo.net>
Date:   Sun,  4 Oct 2020 19:33:02 +0100

add email address to readme

Diffstat:
Mreadme.rst | 55++++++++-----------------------------------------------
1 file changed, 8 insertions(+), 47 deletions(-)

diff --git a/readme.rst b/readme.rst @@ -1,49 +1,13 @@ qtools ====== -This is a small collection of plugins I wrote for Qtile_. -Aims: - - Simplifying Qtile configuration. - - Only loading those that are used. - - Ability to easily create responsive key-bindings with notifications. - - Avoiding extra dependencies. - - -Bases ------ - -Notifiers -````````` - -:code:`Notifier`-based plugins expose methods that trigger notifications, with -the purpose of being bound to keys. - -An example usage: - -.. code-block:: python - - import qtools.mpc - mpc = qtools.mpc.Client() - keys.extend([EzKey(k, v) for k, v in { - '<XF86AudioPlay>': mpc.lazy_toggle, - '<XF86AudioNext>': mpc.lazy_next, - '<XF86AudioPrev>': mpc.lazy_previous, - }.items()]) - -:code:`Notifier`'s methods are exposed with the 'lazy\_' prefix for binding to -keys. +This is a small collection of plugins I wrote for Qtile_. I primarily use this +as a playground for things that might get merged. -:code:`qtools.mpc.Client` is a subclass of :code:`Notifier`, which is found at -:code:`qtools.Notifier` in :code:`qtools/__init__.py`. - - -Popups -`````` - -The :code:`Popup` class can be used to create and control popup windows, such -as tooltips or notifications. For an example see the :code:`notification` -plugin. +Aims: + - To extend Qtile configuration. + - To keep configuration simple and tidy. Plugin list @@ -52,15 +16,12 @@ Plugin list ============== =============================================================== Module Description ============== =============================================================== -amixer Notifier that controls an ALSA device's volume - -backlight Notifier that controls backlight level - notification A fully functional notification server -mpc Notifier that controls MPD - xresources Load X resources into Qtile config ============== =============================================================== + +Email me @ mcol@posteo.net for questions/contributions. + .. _Qtile: https://github.com/qtile/qtile