GitHub - Sorebit/couch-remote: Simple FastAPI remote control for a PC keyboard

⚠️ Current status of this project

• Run remote to serve
  • Commands are not supported yet.
• Supported Operating Systems:
  • Linux (Xorg) - pynput
  • Windows - pynput
  • macos - pynput (tested on 12.6)
• Not yet supported Operating Systems:
  • Linux (Wayland)

A utility, available at PyPI, which serves a remote keyboard to control a computer.

Usage

1. To install: pip install couch-remote (in a venv or globally)
2. Now, your remote should be available.
3. Optionally, remote scaffold-config, creates a basic settings file, then remote global settings.py copies it to a global configuration directory.
4. Finally, remote control serves an instance at 0.0.0.0:4444. This is the only command, you're going to need from now on.

On macOS it might be required to allow the running process to control your keyboard. Most likely a pop-up will open on the first recorded keypress.

Settings

from pynput.keyboard import Key
from remote.models import Button

buttons = {
    'play_pause_media': Button(key=Key.media_play_pause, label='⏯️'),
    'esc': Button(key=Key.esc, label='Esc'),
    'caps': Button(key=Key.caps_lock, label='Caps Lock'),
    'space': Button(key=Key.space, label='Space'),
}

port = 4444

Q: Do jakiego formatu zapisują się i wczytują configi w settingsach?

Install a global settings file remote global settings.py

When ran, stores settings at a default path: ~/.config/couch-remote/settings.py

The app will default to this path when not specified.