Skip to main content

An AutoHotkey server allowing remote clients to execute ahk functionality

Project description

ahk-server

A server to allow remote execution of AutoHotkey using the Python ahk wrapper. Uses fastapi.

Installation

pip install ahk-server

Requires you have AutoHotkey installed. See ahk readme for non-python dependencies.

Usage

To start the server:

python -m ahk_server

This accepts two optional command line parameters: --host and --port. Alternatively, you can also configure the host and port by setting the environment variables AHK_SERVER_HOST and AHK_SERVER_PORT.

Alternatively still, you can also invoke the server using uvicorn

uvicorn ahk_server.app:app

Standalone release

ahk-server is also available in a standalone exe release which can be found in the releases page

For connecting to the server, see the client project: ahk-client.

Status

This project (and its client counterpart) is usable, but in very early stages of development. Notably, it does not currently include any authentication mechanisms for securing server connections, so use with caution.

TODO:

A noninclusive list of things that might come in the future:

  • support some kind of basic authentication
  • implement run_script functionality
  • implement non-blocking functionality
  • implement extension negotiation with clients

Project details


Download files

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

Source Distribution

ahk_server-0.1.0.tar.gz (4.2 kB view hashes)

Uploaded Source

Built Distribution

ahk_server-0.1.0-py3-none-any.whl (4.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page