Metadata-Version: 2.1
Name: scusage
Version: 0.0.1
Summary: analyze shortcut usage for i3wm
Home-page: https://github.com/tobi-wan-kenobi/scusage
Author: tobi-wan-kenobi
Author-email: github@tobi-wan-kenobi.at
License: MIT
Project-URL: Documentation, https://github.com/tobi-wan-kenobi/scusage
Project-URL: Code, https://github.com/tobi-wan-kenobi/scusage
Project-URL: Issue tracker, https://github.com/tobi-wan-kenobi/scusage
Keywords: scusage,i3wm
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Utilities
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: tabulate
Requires-Dist: i3ipc

scusage
=====================================================
[![PyPI version](https://badge.fury.io/py/scusage.svg)](https://badge.fury.io/py/scusage)
[![CodeQL](https://github.com/tobi-wan-kenobi/scusage/actions/workflows/codeql-analysis.yml/badge.svg?branch=main)](https://github.com/tobi-wan-kenobi/scusage/actions/workflows/codeql-analysis.yml)
![License](https://img.shields.io/github/license/tobi-wan-kenobi/scusage)

`scusage` is a small tool to analyze your keyboard shortcut usage (hence the name -
**S**hort**C**ut **usage**) to help you find optimal keybindings.

Currently, it only supports the i3 window manager.

# Installation

```
$ pip install --user scusage
```

# Usage

`scusage` has no parameters, you simply run it, use your window manager, and
when you want to get the results, you terminate `scusage` using `Ctrl+C`.

```
$ scusage
# let scusage run while you go about your daily business
# when you are done, terminate the tool with Ctrl+C

shortcut                                                                          count
--------------------------------------------------------------------------------  -------  ------------------------------
Mod4+2: workspace "2: "                                                           7 (22%)  ==============================
Mod4+3: workspace "3: "                                                           7 (22%)  ==============================
Mod4+4: workspace "4: "                                                           5 (16%)  =====================
Mod4+5: workspace "5: "                                                           3 (9%)   ============
Mod4+r: exec "rofi -modi window,drun,ssh,combi -show combi"                       3 (9%)   ============
Mod4+1: workspace "1: "                                                           2 (6%)   ========
Mod4+s: mark swapee; focus right; swap container with mark swapee; unmark swapee  2 (6%)   ========
Mod4+8: workspace "8:  "                                                          1 (3%)   ====
Mod4+9: workspace "9: "                                                           1 (3%)   ====
Mod4+0: workspace "10: "                                                          1 (3%)   ====
```

The idea is that this tool helps you identify which shortcuts you use most often,
so that you can bind them to convenient and easy to reach key combinations.
