Elliria / autokey_run_tests_and_provide_feedback_on_a_pull_request.md

Last active January 16, 2025 05:09

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.

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).
Install the git package in Kubuntu.
Install the tox package in Kubuntu.
Open the directory you'd like to create the cloned autokey directory inside of in a terminal window.
Clone the PR:

Elliria / AutoKeyVMNotes.md

Last active January 14, 2025 16:41

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.md

Last active January 14, 2025 17:31

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 / autokey_update_workflows.rst

Last active March 10, 2025 17:03

Test RST

Update The Workflows

Update the action versions

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

Elliria / autokey_run_in_different_ways.md

Last active January 14, 2025 17:41

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.md

Last active March 2, 2025 13:35

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 / AutoKeyDocumentationLocations.md

Last active April 11, 2024 19:41

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 / VirtualboxInstallationAndUse.md

Last active August 18, 2023 14:53

VirtualBox Installation and Use

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

Installation

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

Elliria / Gists.md

Last active March 2, 2025 14:50

Gists

Elliria / github_lists_done_creatively.md

Last active January 14, 2025 17:19

GitHub lists done creatively

Standard nesting syntax:

* red
  * yellow
    * blue
      * black
        * white

Elliria Elliria