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

Clone the repository:

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

Change to the autokey subdirectory you just created:
```
cd autokey
```
Change to the lib subdirectory:
```
cd lib
```

Pick one:

Run AutoKey GTK:
```
python3 -m autokey.gtkui -lc
```
Run AutoKey Qt:
```
python3 -m autokey.qtui -lc
```

When you're finished with this testing session, close AutoKey normally.
If you'd like to get rid of the clone, delete the clone's directory. Otherwise, keep it for further testing.

Test AutoKey by cloning a branch

Pick one:

Clone the Beta branch:

git clone --branch beta --single-branch https://github.com/autokey/autokey.git

Clone the Develop branch:

git clone --branch develop --single-branch https://github.com/autokey/autokey.git

Clone the Master branch:

git clone --branch master --single-branch https://github.com/autokey/autokey.git

Change to the autokey subdirectory you just created:
```
cd autokey
```
Change to the lib subdirectory:
```
cd lib
```

Pick one:

Run AutoKey GTK:
```
python3 -m autokey.gtkui -lc
```
Run AutoKey Qt:
```
python3 -m autokey.qtui -lc
```

When you're finished with this testing session, close AutoKey normally.
If you'd like to get rid of the clone, delete the clone's directory. Otherwise, keep it for further testing.

Test AutoKey by cloning a fork

Pick one:
- Clone a fork (replace Elliria with the fork's name):
```
git clone https://github.com/Elliria/fork.git
```
Change to the autokey subdirectory you just created:
```
cd autokey
```
Change to the lib subdirectory:
```
cd lib
```

Pick one:

Run AutoKey GTK:
```
python3 -m autokey.gtkui -lc
```
Run AutoKey Qt:
```
python3 -m autokey.qtui -lc
```

When you're finished with this testing session, close AutoKey normally.
If you'd like to get rid of the clone, delete the clone's directory. Otherwise, keep it for further testing.

Test AutoKey by cloning a branch and checking out a pull request

Clone the Develop branch:

git clone --branch develop --single-branch https://github.com/autokey/autokey.git

Change to the autokey subdirectory you just created:
```
cd autokey
```
Fetch the pull request (using its number):
```
git fetch origin pull/844/head:pull_844
```
Check out the pull request (using its number):
```
git checkout pull_844
```
Change to the lib subdirectory:
```
cd lib
```

Pick one:

Run AutoKey GTK:
```
python3 -m autokey.gtkui -lc
```
Run AutoKey Qt:
```
python3 -m autokey.qtui -lc
```

When you're finished with this testing session, close AutoKey normally.
If you'd like to get rid of the clone, delete the clone's directory. Otherwise, keep it for further testing.

Test Autokey by cloning a branch and checking out a tag (a release)

Clone the Develop branch:

git clone --branch develop --single-branch https://github.com/autokey/autokey.git

Change to the autokey subdirectory you just created:
```
cd autokey
```
Fetch all of AutoKey's tags:
```
git fetch --all --tags --prune
```
Check out the specified tag by using the tags prefix and the tag's name:
```
git checkout tags/v0.96.0
```
Change to the lib subdirectory:
```
cd lib
```

Pick one:

Run AutoKey GTK:
```
python3 -m autokey.gtkui -lc
```
Run AutoKey Qt:
```
python3 -m autokey.qtui -lc
```

When you're finished with this testing session, close AutoKey normally.
If you'd like to get rid of the clone, delete the clone's directory. Otherwise, keep it for further testing.

Test AutoKey from a zip file

Download the zip file of any version of AutoKey.
Unzip it into the current directory.
Open the autokey subdirectory you unzipped it into in a terminal window.
Change to the lib subdirectory:
```
cd lib
```

Pick one:

Run AutoKey GTK:
```
python3 -m autokey.gtkui -lc
```
Run AutoKey Qt:
```
python3 -m autokey.qtui -lc
```

When you're finished with this testing session, close AutoKey normally.
If you'd like to get rid of the clone, delete the clone's directory. Otherwise, keep it for further testing.

Test AutoKey in a virtual environment

The steps below demonstrate using AutoKey in Ubuntu inside of a virtual machine and running AutoKey in the venv virtual environment (see this Debian article and this Ubuntu discussion for why), which only seems to work manually on the command line and not in a shortcut, most likely because the virtual environment needs a shell to create itself in.

Create the virtual environment (this only needs to be done once):

Create a virtual machine (in VirtualBox, for example, with instructions for that here) on your computer.
Install Ubuntu in it.
Boot into the virtual machine.
Install build-essential:
```
sudo apt install build-essential
```
Install pip3:
```
sudo apt install python3-pip
```
Install the cairo development package:
```
sudo apt install libcairo2-dev
```
Install venv:
```
sudo apt install python3-venv
```

Pick one:

Clone AutoKey's Master branch in the current directory:
```
git clone https://github.com/autokey/autokey.git
```

Clone AutoKey's Develop branch in the current directory:

git clone --branch develop --single-branch https://github.com/autokey/autokey.git

Change to the cloned autokey directory you created:
```
cd autokey
```
Install any missing packages that are listed in the apt-requirements.txt file:
```
grep -vE '^#' apr-requirements.txt | xargs sudo apt install -y
```
Create a virtual environment:
```
python3 -m venv venv
```
Activate the virtual environment:
```
source venv/bin/activate
```
Install the Python packaging module inside the virtual environment:
```
pip install packaging
```
Install the Python pycairo module inside the virtual environment:
```
pip install pycairo
```
Install AutoKey's pip requirements inside the virtual environment:
```
pip install -r pip-requirements.txt
```
Close AutoKey.
Deactivate the virtual environment:
```
deactivate
```
Close the terminal window.

Run AutoKey in the virtual environment (this can be done from then on):

Open a terminal window.
Pick one, replacing ~/Desktop/autokey with the path to your test copy of autokey below before following the steps, to change to the autokey directory, activate the venv virtual environment, change to the lib subdirectory, and run AutoKey:
- AutoKey GTK:
```
cd ~/Desktop/autokey; source venv/bin/activate; cd lib; python3 -m autokey.gtkui -lc
```
- AutoKey Qt:
```
cd ~/Desktop/autokey; source venv/bin/activate; cd lib; python3 -m autokey.qtui -lc
```
When finished, close AutoKey.
Deactivate the virtual environment:
```
deactivate
```
Close the terminal window.
Log out of Ubuntu.

Notes

Google recommends using venv in this way if you want to run a file in venv from the command line: <venv-path>/<bin-path>/<executable>

Elliria/autokey_run_in_different_ways.md

AutoKey run in different ways

Before you begin

Test AutoKey by cloning the repository

Test AutoKey by cloning a branch

Test AutoKey by cloning a fork

Test AutoKey by cloning a branch and checking out a pull request

Test Autokey by cloning a branch and checking out a tag (a release)

Test AutoKey from a zip file

Test AutoKey in a virtual environment

Create the virtual environment (this only needs to be done once):

Run AutoKey in the virtual environment (this can be done from then on):

Notes