Skip to content

Instantly share code, notes, and snippets.

---
########################################################################
# How to create a YAML issue template form in your repository #
########################################################################
# To use a YAML issue form in your repository, you must create a new
# file and add it to the .github/ISSUE_TEMPLATE folder in your
# repository by typing the full path to the new file in when prompted
# for a new file's name.
#
# If, for example, you wanted to create the bug.yaml form to add to your

GitHub import a project

Import a project onto GitHub.

1. Prepare your computer for development

  1. Before you do anything else, make a backup of your local project!
  2. Check through all the folders in your local project and if any of them don't have any files in them, add a file to them. This matters when it comes time to push the changes to GitHub, because the push command won't send empty directories. A common practice is to put the empty .gitkeep file into empty directories.
  3. Grab all available operating-system updates.
  4. Update the apt database: sudo apt update
  5. Configure your git username in place of John Doe's: git config --global user.name "John"

CLIPBOARD vs PRIMARY vs SECONDARY

About

  • CLIPBOARD:
    • This contains copied data.
    • Copy data by selecting text and pressing Ctrl+c or right-clicking and choosing copy from the context menu.
    • Paste data by pressing Ctrl+v or pressing Shift+Insert or right-clicking the mouse and choosing paste to paste.
    • AutoKey's clipboard.get_clipboard() and clipboard.fill_clipboard() API calls can access this.
  • PRIMARY:
  • This contains selected data.

GitHub lists done creatively

Standard nesting syntax:

* red
  * yellow
    * blue
      * black
        * white

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.

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
Elliria / autokey_run_tox_tests.md
Last active March 2, 2025 13:35
AutoKey run tox tests

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
Elliria / autokey_run_in_different_ways.md
Last active January 14, 2025 17:41
AutoKey run in different ways

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