Merge pull request #3 from dynobo/develop

Develop

.gitignore

@@ -1,5 +1,6 @@
 .venv
 .vscode
+run.sh
 
 # Byte-compiled / optimized / DLL files
 __pycache__/

MANIFEST.in

@@ -1 +1,4 @@
 include LICENSE
+include README.md
+include keyhint/config/config.yaml
+include keyhint/config/hints.yaml

Makefile

@@ -1,10 +1,37 @@
+colon := :
+$(colon) := :
+
 init:
 	rm -rf ./.venv
+	rm ~/.config/keyhint/*
 	python3 -m venv .venv
 	.venv/bin/python -m pip install -r requirements-dev.txt
 
+reset_config:
+	rm ~/.config/keyhint/*
+
 test:
 	.venv/bin/pytest tests
 
+lint:
+	.venv/bin/pylama
+
 run:
 	.venv/bin/python -m keyhint
+
+package:
+	rm -rf build dist
+	.venv/bin/python setup.py sdist bdist_wheel
+	.venv/bin/twine check dist/*
+
+upload_test:
+	rm -rf build dist
+	.venv/bin/python setup.py sdist bdist_wheel
+	.venv/bin/twine check dist/*
+	.venv/bin/twine upload --repository-url=https$(:)//test.pypi.org/legacy/ dist/*
+
+upload_final:
+	rm -rf build dist
+	.venv/bin/python setup.py sdist bdist_wheel
+	.venv/bin/twine check dist/*
+	.venv/bin/twine upload dist/*

README.md

@@ -1 +1,75 @@
-# keyhint
+# keyhint
+
+**_Display context-sensitive keyboard shortcuts or other hints on Linux and Windows._**
+
+<p align="center"><br>
+<img alt="Tests passing" src="https://github.com/dynobo/keyhint/workflows/Test/badge.svg">
+<a href="https://github.com/dynobo/keyhint/blob/master/LICENSE"><img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-blue.svg"></a>
+<a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/Code%20style-black-%23000000"></a>
+<a href='https://coveralls.io/github/dynobo/keyhint'><img src='https://coveralls.io/repos/github/dynobo/keyhint/badge.svg' alt='Coverage Status' /></a>
+</p>
+
+## Usage
+
+The tool can be started by `python -m keyhint` or simply `keyhint`. But as the **keyhint** displays hints based on the currently active window, you probably want to configure a **global hotkey** to trigger it on demand.
+
+Based on the **process name** and **window title** of the active window, different sets of hints are displayed.
+
+_Screenshots of some hints:_
+
+![General Firefox Shortcuts](assets/demo.gif)
+
+## Installation
+
+`pip install keyhint`
+
+## Configuration
+
+### Look & Behavior
+
+- You can configure colors, font and closing behavior by modifying the file<br>
+  `<CONFIG_PATH>/keyhint/config.yaml`
+
+### Hints
+
+- You can also configure the hints to show for different applications by modifying or adding section in the file<br>
+  `<CONFIG_PATH>/keyhint/hints.yaml`
+
+- The hints to display are selected by going through all sections from top to bottom and comparing the value of `regex_process` with the process name of the active window and the value of `regex_title` with the title of the active window. The first section, where both values are found, gets displayed.
+
+- Both of those `regex_` values are interpreted as **case insensitive regular expressions**.)
+
+### Notes
+
+- The `<CONFIG_PATH>` can be different from system to system. On Linux it's usually `~/.config`, on Windows it should be `C:\Users\<YOURNAME>\AppData\Roaming`.
+
+- You can **reset configuration or hints** to the shipped version by deleting the `yaml` files from the configuration folder.
+
+## Tips
+
+**Differentiate Websites:**
+
+- For showing different browser-hints depending on the current website, you might want to use a browser extension like "[Add URL To Window Title](https://addons.mozilla.org/en-US/firefox/addon/add-url-to-window-title/)" and then configure the sections in `hints.yaml` to look for the URL in the window title.
+
+**Differentiate Multi Platform:**
+
+- Sometimes the hints you want to show are the same for e.g. Linux and Windows. In that case, you might want to set e.g. `regex_process: firefox.*` to match with `Firefox` (Linux) as well as with `Firefox.exe` (Windows).
+
+- If you want to show different hints for the same tool depending on the platform, use two sections, one with `regex_process: firefox(?!\.exe)` (Linux) and one with `regex_process: firefox\.exe` (Windows).
+
+## Contribute
+
+I'm happy about any contribution! Especially I would appreciate submissions to improve the [shipped hints](https://github.com/dynobo/keyhint/blob/master/keyhint/config/hints.yaml). (The current set are the hints I personally use).
+
+## Design Principles
+
+- **Multi-Platform**<br>Should work on Linux, Mac (not yet achieved) & Windows.
+- **Don't run as service**<br>It shouldn't consume resources in the background, even if this leads to slower start-up time.
+- **No network connection**<br>Everything should run locally without any network communication.
+- **Dependencies**<br>The fewer dependencies, the better.
+- **Chain of Responsibility as main design pattern**<br>[See description on refactoring.guru](https://refactoring.guru/design-patterns/chain-of-responsibility)
+- **Multi-Monitors**<br>Supports setups with two or more displays
+
+## Certification
+
+![WOMM](https://raw.githubusercontent.com/dynobo/lmdiag/master/badge.png)