Elliria

Manage The Wiki Locally

Clone the AutoKey wiki:

1. Open the directory you'd like to put the clone's directory into in a terminal window.
2. Clone the wiki, which will create the autokey.wiki directory inside of the current directory:

   git clone https://github.com/autokey/autokey.wiki.git

Update the clone and check the wiki for changes:

Elliria

AutoKey run tests and provide feedback on a pull request

🛑 Caution: Although the steps below have you creating and using a clone of AutoKey, the clone shares the same configuration folder as the installed copy of AutoKey. Since there's always a risk of corruption of files when one is testing new code, it's best not to run these tests on a system where the installed copy of AutoKey contains valued custom phrases and/or scripts. I recommend creating a virtual machine instead.

1. Make sure that the system you'll be doing the tests on already has a working copy of AutoKey installed on it (so that you'll already have all the necessary apt dependencies).
2. Install the git package in Kubuntu.
3. Install the tox package in Kubuntu.
4. Open the directory you'd like to create the cloned autokey directory inside of in a terminal window.
5. Clone the PR:

Elliria

AutoKey VM Notes

Contents of the Note widget

===============================================================
CLONE AUTOKEY AND RUN IT:
cd Desktop
git clone https://github.com/autokey/autokey.git
cd autokey

Elliria

AutoKey run clones in a VM

Prepare the machine for AutoKey development:

sudo apt install autokey-gtk
sudo apt install autokey-qt
sudo apt install git
sudo apt install libcairo2-dev
sudo apt install python3.12-venv
sudo apt install python3-tk

Elliria

Update The Workflows

Update the action versions

1. Open the .github/workflows directory.
2. Check the action versions:
   1. Check the `build.yml`_ file:

Elliria

AutoKey run in different ways

Before you begin

The testing methods below can be done inside of a terminal window on a machine that has AutoKey already installed on it (in fact, that's recommended since it will likely provide you with all of the necessary dependencies in advance).

🛑 🛑 🛑 🛑 🛑 🛑
It's important to note that lthough each instance of AutoKey will be independent, the AutoKey configuration from your installed copy of AutoKey will be used, which means all of these tests will have full access to your phrases and scripts and changes you make to those while testing will affect your installed version of AutoKey as well.
🛑 🛑 🛑 🛑 🛑 🛑

Test AutoKey by cloning the repository

Elliria

AutoKey run tox tests

We don't have a tox.ini file and it may be necessary. From what I've been able to find out online:

• The setup.cfg and setup.py files are for building distributions.
• The tox.ini file is for running tests in virtual environments that are created on-the-fly.

In reference to the official AutoKey documentation at https://autokey.github.io/autokey/ Silico_Biomancer (AKA BlueDrink9) said: Iirc on the branch with the docs changes, if you run something like tox -e docs it should re-generate the files. Should be documented, but probably only on that branch's readme or CONTRIBUTORS.rst atm

Run tox using the version of Python in PATH:

tox -e py

Elliria

AutoKey Documentation Locations

Current locations for documentation:

The documentation is in several places, none of which are identical, and some of which aren't served.

• AutoKey 0.94.1 and earlier:
  • 🛑 Use pre-legacy documentation.
  • 🛑 Served by: No longer served.
  • 🛑 Can use some legacy documentation, but some naming conventions changed.
• AutoKey 0.95.0 through AutoKey 0.95.10:
• Use legacy documentation: https://autokey.github.io/autokey/index.html

Elliria

VirtualBox Installation and Use

One of the popular virtual-machine programs is VirtualBox. Below are basic instructions for installing it and using it.

Installation

1. Go to the VirtualBox LinuxDownloads page.
2. Click your GNU/Linux distribution's name in the list to download a .deb file.
3. Click the SHA256 checksums link to download a list of SHA checksums.
4. Click the MD5 checksums link to download a list of MD5 checksums.
5. Open a terminal window in the download folder on your computer.

Elliria

Gists

• AutoKey documentation locations
• AutoKey run clones in a VM
• AutoKey run in different ways
• AutoKey run tests and provide feedback on a pull request
• AutoKey run tox tests
• AutoKey update workflows
• AutoKey VM notes
• CLIPBOARD vs PRIMARY vs SECONDARY