Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

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.

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.0b5.tar.gz (214.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

autokey-0.96.0b5-py3-none-any.whl (395.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: autokey-0.96.0b5.tar.gz
  • Upload date:
  • Size: 214.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.5

File hashes

Hashes for autokey-0.96.0b5.tar.gz
Algorithm Hash digest
SHA256 3839ce76ac8ac91e2aa75d44d0efd406fbe7a995992a2a2a403fe64dccf07e3d
MD5 6de245bcaf66bd68943cdedb3923e6b8
BLAKE2b-256 08a1f0afd8a726630504a1de2653d1211ea67798abed1108ce97368cf46f9cbe

See more details on using hashes here.

File details

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

File metadata

  • Download URL: autokey-0.96.0b5-py3-none-any.whl
  • Upload date:
  • Size: 395.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.5

File hashes

Hashes for autokey-0.96.0b5-py3-none-any.whl
Algorithm Hash digest
SHA256 8eac52a5c3146dd0ed5ce26cc1dd6155eadc6c3bfbed567f2f7219930a118204
MD5 7f5fe6f0dd5c0579d2bc9f62ac51bde2
BLAKE2b-256 a82a1c1031879bb8e062ff44e0c682b591a56da2a366e3d105180fe9a71dc680

See more details on using hashes here.

Release history Release notifications | RSS feed

0.96.0

2 files

This release

0.96.0b5 This release

2 files

0.95.4

2 files

0.93.10

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page