Skip to main content

Your hotkeys for various apps in 'dmenu' style.

Project description

dmenu-hotkeys

[![pypi](https://img.shields.io/pypi/v/dmenu_hotkeys.svg)](https://pypi.python.org/pypi/dmenu_hotkeys) [![travis](https://img.shields.io/travis/maledorak/dmenu-hotkeys.svg)](https://travis-ci.org/maledorak/dmenu-hotkeys) [![codecov](https://codecov.io/gh/maledorak/dmenu-hotkeys/branch/master/graph/badge.svg)](https://codecov.io/gh/maledorak/dmenu-hotkeys) [![docs](https://readthedocs.org/projects/dmenu-hotkeys/badge/?version=latest)](https://dmenu-hotkeys.readthedocs.io/en/latest/?badge=latest)

Your hotkeys for various apps in ‘dmenu’ style.

Features

This app allows you to prepare cheat sheet of hotkeys from your apps in simple menu with search.

![screenshot](docs/shot.png)

Requirements

This app needs below apps as a GUI, so install one of these first. * dmenu * rofi

Install

### From pip This app works on Python 2.7, 3.4, 3.5, 3.6, 3.7, so the best choice is installation using pip

` pip install --user dmenu-hotkeys `

then you could run it by typing in console

` dmenu_hotkeys `

### From git repo Clone repository ` git clone git@github.com:maledorak/dmenu-hotkeys.git . `

and run script in bin dir like this ` ./dmenu-hotkeys/bin/dmenu_hotkeys `

How to use

### Run menu with hotkeys 1. Add the following comment line before hotkey line which you want to use in your app config file.

eg:

  • i3: # %%hotkey: Some description of the following hotkey %%
  • openbox: <– %%hotkey: Some description of the following hotkey %% –>

Notice: For full configuration file examples check [test/fixtures](./tests/fixtures) directory

  1. Run the dmenu-hotkeys
    ` dmenu_hotkeys run --menu [dmenu|rofi] --app [i3|openbox] `
  2. Check help if you want to know more
    ` dmenu_hotkeys run --help `

### Override dmenu-hotkeys configuration file If you want to change default configuration paths for apps (i3, openbox, etc) you should override dmenu-hotkeys config file.

` dmenu_hotkeys copy-config `

The default path for the overridden configuration file is ` $HOME/.config/dmenu_hotkeys/config.cfg `

You could change it ` dmenu_hotkeys copy-config --dest some/path/config.cfg `

But since then you always should run dmenu-hotkeys with this new path

` dmenu_hotkeys run --menu [dmenu|rofi] --app [i3|openbox] --config-path some/path/config.cfg `

History

Unreleased

  • Added dots enabling in config.cfg
  • Added coverage
  • Added config as a singleton.
  • Added conf path passing from console argument.
  • Added testing conf and application fixtures.
  • Added copy-config command to copying config files to the user home dir.
  • Added menu and apps installation validation.

1.0.0 (2019-03-09)

  • First release on PyPI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for dmenu-hotkeys, version 1.1.0
Filename, size File type Python version Upload date Hashes
Filename, size dmenu_hotkeys-1.1.0-py2.py3-none-any.whl (10.0 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size dmenu_hotkeys-1.1.0.tar.gz (147.5 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page