Contents
AutoKey, a desktop automation utility for Linux and X11, formerly hosted on Google, has been updated to run on Python 3.
Important: This is an X11 application and, as such, will not function correctly when Wayland is in use instead of Xorg.
Important: Please remove previous installations of AutoKey fully before installing!
<<<<<<< HEAD For detailed installation instructions, please visit the Installation page. in our wiki.
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.
- Start the Autokey daemon
cd lib
# For the GTK UI (likely to work best with Gnome, e.g. Ubuntu.)
python3 -m autokey.gtkui
# or for the QT UI (best on KDE).
python3 -m autokey.qtui
# or for no UI at all, if you only want to configure autokey using the scripting API.- Show the Autokey config window on startup (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.
||||||| merged common ancestors
For detailed installation instructions, please visit the Installation page. in our wiki.
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.
- Start the Autokey daemon
cd lib
python3 -m autokey.gtkui
# or for KDE
python3 -m autokey.qtui- 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.
=======
For detailed installation instructions, please visit the Installing page in our wiki.
>>>>>>> master
AutoKey documentation is available here and, for versions prior to 0.96.0, here. Example code and explanations for how AutoKey works can be found in our wiki and, in particular, on the Features and Example Scripts pages. Additional information can be found by searching Stack Overflow and GitHub.
Please do not request support on the issue tracker. Instead, head over to the autokey-users Google Groups forum, Gitter web-based chat, on IRC (#autokey on Libera.Chat), or Stack Overflow.
We'd appreciate it if you take a look at our Troubleshooting wiki page before posting. You'll be more likely to get a good answer quickly by providing as much information as you can.
Bug reports are welcome. Please use the GitHub Issue Tracker to report bugs. When reporting a suspected bug, please make sure to include as much information as possible to expedite troubleshooting and resolution.
Here are some possible examples of the types of information you might need to provide:
- Details on how to reproduce the issue you are experiencing are always helpful.
- An AutoKey error message is helpful when something is wrong with your AutoKey script.
- An AutoKey traceback is helpful when AutoKey runs without crashing, a trigger was used, and the expected event either didn't occur or something other than the expected result occurred.
- A Python traceback is helpful when something is wrong with your AutoKey script, causing an exception to be shown in your AutoKey error message.
If you're not sure your issue is a bug or you'd like help with reporting it, you can post about it first on one of the platforms used by our community and we'll assist you.
If you wish to modify the source code (and especially if you wish to contribute to the code here), useful tips can be found in CONTRIBUTORS.rst__
See `CONTRIBUTORS.rst`_ for instructions. .. _CONTRIBUTORS.rst: https://github.com/autokey/autokey/blob/master/CONTRIBUTORS.rst
Pull requests are welcome from anyone who would like to modify or contribute to the source code. Useful tips for working with and testing the code can be found in the `CONTRIBUTORS.rst`_ file. AutoKey also participates in CodeTriage, where members can sign up to receive a periodic email with a link to an open AutoKey issue that needs help.
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.
The unit test suite has two additional requirements: * Pytest (https://github.com/pytest-dev/pytest, https://pypi.org/project/pytest/) * PyHamcrest (https://github.com/hamcrest/PyHamcrest/, https://pypi.org/project/PyHamcrest/)
Our changelog is the best source of information for what's new and fixed in each release.
AutoKey uses the GNU GPL v3. See the LICENSE file for a plain text copy of the license.