Skip to main content

Keyboard and GUI automation on Linux (X11)

Project description

https://img.shields.io/badge/IRC-%23autokey%20on%20freenode-blue.svg Join the chat at https://gitter.im/autokey/autokey Ask and answer questions on StackOverflow

About

AutoKey, a desktop automation utility for Linux and X11, formerly hosted at OldAutoKey. Updated to run on Python 3.

Important: This is an X11 application, and as such will not function 100% on distributions that default to using Wayland instead of Xorg.

Installation

Please remove previous installations of both AutoKey and AutoKey-py3 fully before installing!

For detailed installation instructions, please visit the Installation page. in our wiki.

Zero-installation Method

AutoKey can also be used directly from the cloned repository. This is useful, e.g., for trying out a new version without removing a current installation.

  1. Start the Autokey daemon

cd lib
python3 -m autokey.gtkui
# or for KDE
python3 -m autokey.qtui
  1. Start the Autokey UI (if desired) by appending the –configure or -c command line switch to the end of the command.

The commands accept CLI switches just like the regular installation, so python3 -m autokey.qtui -lc works as expected.

Documentation

Documentation for new features. For older features, please refer to the original AutoKey’s scripting API, wiki, and Stack Overflow.

Examples of AutoKey scripts can be found by searching GitHub and reading AutoKey’s wiki.

Support

Please do not request support on the issue tracker. Instead, head over to the autokey-users Google Groups forum, StackOverflow, on IRC (#autokey on Freenode), or Gitter web-based chat.

We’d appreciate it if you take a look at Problem reporting guide before posting. By providing as much information as you can, you’ll have a much better chance of getting a good answer in less time.

Bug reports and Pull Requests

Bug reports and PRs are welcome. Please use the GitHub Issue Tracker for bug reports. When reporting a suspected bug, please test against latest git HEAD and make sure to include as much information as possible to expedite troubleshooting and resolution. For example,

  • required: How to reproduce the issue you are experiencing

  • Python tracebacks, if any

  • Verbose logging information obtained by starting the frontend (autokey-gtk or autokey-qt) from terminal with the --verbose option.

Running the unit tests

The unit test suite has two additional requirements:

Running the test suite is integrated into setup.py. The tests can be run by executing python3 setup.py test from the repository root directory.

Changelog

The changelog is located Here.

License

GNU GPL v3. See the LICENSE file alongside this README for a plain text copy of the license text.

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

autokey-0.96.0b8.tar.gz (216.6 kB view details)

Uploaded Source

Built Distribution

autokey-0.96.0b8-py3-none-any.whl (398.7 kB view details)

Uploaded Python 3

File details

Details for the file autokey-0.96.0b8.tar.gz.

File metadata

  • Download URL: autokey-0.96.0b8.tar.gz
  • Upload date:
  • Size: 216.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.4 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.1 CPython/3.9.6

File hashes

Hashes for autokey-0.96.0b8.tar.gz
Algorithm Hash digest
SHA256 45c01ce32d13a26aa789d8671b17207922543dc69c368dec120bf48f0e866236
MD5 b9ec005edfef03913f1959d109863f4b
BLAKE2b-256 dd02b8c1fc73c281ea83734c453a24b8a71d9fcdd8f7bd6607f2316733fd2de4

See more details on using hashes here.

File details

Details for the file autokey-0.96.0b8-py3-none-any.whl.

File metadata

  • Download URL: autokey-0.96.0b8-py3-none-any.whl
  • Upload date:
  • Size: 398.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.4 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.1 CPython/3.9.6

File hashes

Hashes for autokey-0.96.0b8-py3-none-any.whl
Algorithm Hash digest
SHA256 06200d6df4c1f90bd2f2f96489187657012c7463d07d99572d81f3d06bcf733b
MD5 1af980356fef49bafa618784b0b06059
BLAKE2b-256 bc54185384625f07524fbebbbd47993f1f3202f389075809e25bcc44a3c6d3ea

See more details on using hashes here.

Supported by

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