autokey2espanso 1.0.2__tar.gz

autokey2espanso-1.0.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Johann Judek
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

autokey2espanso-1.0.2/PKG-INFO

@@ -0,0 +1,140 @@
+Metadata-Version: 2.4
+Name: autokey2espanso
+Version: 1.0.2
+Summary: Convert AutoKey phrase entries to Espanso YAML format
+Author: Johann Judek
+License: MIT
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# autokey2espanso
+
+Convert AutoKey phrase entries into Espanso YAML configuration.
+
+## Why?
+
+If you are migrating from AutoKey to Espanso, this tool converts your existing phrase entries automatically.
+
+It reads matching `.json` and `.txt` pairs and generates a valid Espanso `matches:` configuration.
+
+---
+
+## Requirements
+
+* Python 3.8+
+
+---
+
+## Installation
+
+Clone the repository:
+
+```bash
+git clone https://github.com/johannjdk/autokey2espanso.git
+cd autokey2espanso
+pip install .
+```
+
+Or run directly:
+
+```bash
+python3 autokey2espanso/cli.py <directory>
+```
+
+---
+
+## Usage
+
+Basic usage (prints YAML to stdout):
+
+```bash
+autokey2espanso /path/to/autokey/phrases
+```
+
+Write output to file:
+
+```bash
+autokey2espanso /path/to/autokey/phrases -o espanso.yml
+```
+
+Verbose mode:
+
+```bash
+autokey2espanso /path/to/autokey/phrases -o espanso.yml -v
+```
+
+Word mode (`-w / --wordmode`):
+
+```bash
+autokey2espanso /path/to/autokey/phrases -o espanso.yml -w
+```
+
+Custom prefix (`-p / --prefix`):
+
+```bash
+autokey2espanso /path/to/autokey/phrases -p ":" -o espanso.yml
+```
+
+When enabled, the prefix will be added before each trigger.
+If omitted, triggers are taken **1:1** from AutoKey.
+
+When word mode is enabled, each entry will include:
+
+```yaml
+word: true
+```
+
+This is useful for triggers that should only match entire words in Espanso.
+
+---
+
+## How it works
+
+For each entry, both files must exist:
+
+```
+Example.json
+Example.txt
+```
+
+The first abbreviation inside the JSON file becomes the Espanso trigger. With optional prefix:
+
+```json
+"abbreviations": ["hello"]
+```
+
+Becomes with `-p ":"`:
+
+```yaml
+matches:
+  - trigger: ":hello"
+    replace: |
+      Hello World!
+```
+
+Or 1:1 (no prefix):
+
+```yaml
+matches:
+  - trigger: "hello"
+    replace: |
+      Hello World!
+```
+
+If word mode is enabled:
+
+```yaml
+matches:
+  - trigger: ":hello"
+    word: true
+    replace: |
+      Hello World!
+```
+
+---
+
+## License
+
+MIT

autokey2espanso-1.0.2/README.md

@@ -0,0 +1,129 @@
+# autokey2espanso
+
+Convert AutoKey phrase entries into Espanso YAML configuration.
+
+## Why?
+
+If you are migrating from AutoKey to Espanso, this tool converts your existing phrase entries automatically.
+
+It reads matching `.json` and `.txt` pairs and generates a valid Espanso `matches:` configuration.
+
+---
+
+## Requirements
+
+* Python 3.8+
+
+---
+
+## Installation
+
+Clone the repository:
+
+```bash
+git clone https://github.com/johannjdk/autokey2espanso.git
+cd autokey2espanso
+pip install .
+```
+
+Or run directly:
+
+```bash
+python3 autokey2espanso/cli.py <directory>
+```
+
+---
+
+## Usage
+
+Basic usage (prints YAML to stdout):
+
+```bash
+autokey2espanso /path/to/autokey/phrases
+```
+
+Write output to file:
+
+```bash
+autokey2espanso /path/to/autokey/phrases -o espanso.yml
+```
+
+Verbose mode:
+
+```bash
+autokey2espanso /path/to/autokey/phrases -o espanso.yml -v
+```
+
+Word mode (`-w / --wordmode`):
+
+```bash
+autokey2espanso /path/to/autokey/phrases -o espanso.yml -w
+```
+
+Custom prefix (`-p / --prefix`):
+
+```bash
+autokey2espanso /path/to/autokey/phrases -p ":" -o espanso.yml
+```
+
+When enabled, the prefix will be added before each trigger.
+If omitted, triggers are taken **1:1** from AutoKey.
+
+When word mode is enabled, each entry will include:
+
+```yaml
+word: true
+```
+
+This is useful for triggers that should only match entire words in Espanso.
+
+---
+
+## How it works
+
+For each entry, both files must exist:
+
+```
+Example.json
+Example.txt
+```
+
+The first abbreviation inside the JSON file becomes the Espanso trigger. With optional prefix:
+
+```json
+"abbreviations": ["hello"]
+```
+
+Becomes with `-p ":"`:
+
+```yaml
+matches:
+  - trigger: ":hello"
+    replace: |
+      Hello World!
+```
+
+Or 1:1 (no prefix):
+
+```yaml
+matches:
+  - trigger: "hello"
+    replace: |
+      Hello World!
+```
+
+If word mode is enabled:
+
+```yaml
+matches:
+  - trigger: ":hello"
+    word: true
+    replace: |
+      Hello World!
+```
+
+---
+
+## License
+
+MIT

autokey2espanso-1.0.2/autokey2espanso/__init__.py

@@ -0,0 +1 @@
+__version__ = "1.0.2"

autokey2espanso-1.0.2/autokey2espanso/cli.py

@@ -0,0 +1,117 @@
+#!/usr/bin/env python3
+
+import argparse
+import json
+import sys
+from pathlib import Path
+from datetime import datetime
+
+
+def verbose_print(enabled, message):
+    if enabled:
+        timestamp = datetime.now().strftime("%H:%M:%S")
+        print(f"[{timestamp}] {message}", file=sys.stderr)
+
+
+def collect_entries(directory: Path, verbose: bool, prefix: str):
+    entries = []
+    json_files = sorted(directory.glob("*.json"))
+
+    verbose_print(verbose, f"Scanning directory: {directory}")
+    verbose_print(verbose, f"Found {len(json_files)} JSON files")
+
+    for json_file in json_files:
+        base_name = json_file.stem
+        txt_file = directory / f"{base_name}.txt"
+
+        if not txt_file.exists():
+            verbose_print(verbose, f"Skipping '{base_name}': missing .txt file")
+            continue
+
+        try:
+            with json_file.open("r", encoding="utf-8") as jf:
+                data = json.load(jf)
+        except Exception as e:
+            verbose_print(verbose, f"Skipping '{base_name}': JSON error ({e})")
+            continue
+
+        abbreviations = (
+            data.get("abbreviation", {})
+            .get("abbreviations", [])
+        )
+
+        if not abbreviations:
+            verbose_print(verbose, f"Skipping '{base_name}': no abbreviation found")
+            continue
+
+        trigger = abbreviations[0]
+        if prefix:
+            trigger = f"{prefix}{trigger}"
+
+        try:
+            with txt_file.open("r", encoding="utf-8") as tf:
+                content = tf.read().rstrip()
+        except Exception as e:
+            verbose_print(verbose, f"Skipping '{base_name}': TXT read error ({e})")
+            continue
+
+        entries.append((trigger, content))
+        verbose_print(verbose, f"Processed '{base_name}' -> trigger '{trigger}'")
+
+    verbose_print(verbose, f"Successfully processed {len(entries)} entries")
+    return entries
+
+
+def generate_yaml(entries, wordmode=False):
+    lines = ["matches:"]
+    for trigger, content in entries:
+        lines.append(f"  - trigger: \"{trigger}\"")
+        if wordmode:
+            lines.append("    word: true")
+        lines.append("    replace: |-")
+        for line in content.splitlines():
+            lines.append(f"      {line}")
+    return "\n".join(lines) + "\n"
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        description="Convert AutoKey phrase entries to Espanso YAML format."
+    )
+    parser.add_argument("directory", help="Directory containing AutoKey entries")
+    parser.add_argument("-o", "--output", help="Output file path")
+    parser.add_argument("-v", "--verbose", action="store_true", help="Verbose mode")
+    parser.add_argument(
+        "-w", "--wordmode", action="store_true", help="Add 'word: true' to each entry"
+    )
+    parser.add_argument(
+        "-p", "--prefix", help="Custom prefix to add to triggers", default=""
+    )
+    args = parser.parse_args()
+
+    directory = Path(args.directory)
+
+    if not directory.is_dir():
+        print("Error: Invalid directory", file=sys.stderr)
+        sys.exit(1)
+
+    entries = collect_entries(directory, args.verbose, args.prefix)
+    yaml_output = generate_yaml(entries, wordmode=args.wordmode)
+
+    if args.output:
+        output_path = Path(args.output)
+        try:
+            with output_path.open("w", encoding="utf-8") as f:
+                f.write(yaml_output)
+            verbose_print(args.verbose, f"YAML written to {output_path}")
+            sys.exit(0)
+        except Exception as e:
+            print(f"Error writing output file: {e}", file=sys.stderr)
+            sys.exit(1)
+    else:
+        print(yaml_output, end="")
+        sys.exit(0)
+
+
+if __name__ == "__main__":
+    main()

autokey2espanso-1.0.2/autokey2espanso.egg-info/PKG-INFO

@@ -0,0 +1,140 @@
+Metadata-Version: 2.4
+Name: autokey2espanso
+Version: 1.0.2
+Summary: Convert AutoKey phrase entries to Espanso YAML format
+Author: Johann Judek
+License: MIT
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# autokey2espanso
+
+Convert AutoKey phrase entries into Espanso YAML configuration.
+
+## Why?
+
+If you are migrating from AutoKey to Espanso, this tool converts your existing phrase entries automatically.
+
+It reads matching `.json` and `.txt` pairs and generates a valid Espanso `matches:` configuration.
+
+---
+
+## Requirements
+
+* Python 3.8+
+
+---
+
+## Installation
+
+Clone the repository:
+
+```bash
+git clone https://github.com/johannjdk/autokey2espanso.git
+cd autokey2espanso
+pip install .
+```
+
+Or run directly:
+
+```bash
+python3 autokey2espanso/cli.py <directory>
+```
+
+---
+
+## Usage
+
+Basic usage (prints YAML to stdout):
+
+```bash
+autokey2espanso /path/to/autokey/phrases
+```
+
+Write output to file:
+
+```bash
+autokey2espanso /path/to/autokey/phrases -o espanso.yml
+```
+
+Verbose mode:
+
+```bash
+autokey2espanso /path/to/autokey/phrases -o espanso.yml -v
+```
+
+Word mode (`-w / --wordmode`):
+
+```bash
+autokey2espanso /path/to/autokey/phrases -o espanso.yml -w
+```
+
+Custom prefix (`-p / --prefix`):
+
+```bash
+autokey2espanso /path/to/autokey/phrases -p ":" -o espanso.yml
+```
+
+When enabled, the prefix will be added before each trigger.
+If omitted, triggers are taken **1:1** from AutoKey.
+
+When word mode is enabled, each entry will include:
+
+```yaml
+word: true
+```
+
+This is useful for triggers that should only match entire words in Espanso.
+
+---
+
+## How it works
+
+For each entry, both files must exist:
+
+```
+Example.json
+Example.txt
+```
+
+The first abbreviation inside the JSON file becomes the Espanso trigger. With optional prefix:
+
+```json
+"abbreviations": ["hello"]
+```
+
+Becomes with `-p ":"`:
+
+```yaml
+matches:
+  - trigger: ":hello"
+    replace: |
+      Hello World!
+```
+
+Or 1:1 (no prefix):
+
+```yaml
+matches:
+  - trigger: "hello"
+    replace: |
+      Hello World!
+```
+
+If word mode is enabled:
+
+```yaml
+matches:
+  - trigger: ":hello"
+    word: true
+    replace: |
+      Hello World!
+```
+
+---
+
+## License
+
+MIT

autokey2espanso-1.0.2/autokey2espanso.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+LICENSE
+README.md
+pyproject.toml
+autokey2espanso/__init__.py
+autokey2espanso/cli.py
+autokey2espanso.egg-info/PKG-INFO
+autokey2espanso.egg-info/SOURCES.txt
+autokey2espanso.egg-info/dependency_links.txt
+autokey2espanso.egg-info/entry_points.txt
+autokey2espanso.egg-info/top_level.txt

autokey2espanso-1.0.2/autokey2espanso.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

autokey2espanso-1.0.2/autokey2espanso.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+autokey2espanso = autokey2espanso.cli:main

autokey2espanso-1.0.2/autokey2espanso.egg-info/top_level.txt

@@ -0,0 +1 @@
+autokey2espanso

autokey2espanso-1.0.2/pyproject.toml

@@ -0,0 +1,13 @@
+[project]
+name = "autokey2espanso"
+version = "1.0.2"
+description = "Convert AutoKey phrase entries to Espanso YAML format"
+authors = [
+    {name = "Johann Judek"}
+]
+readme = "README.md"
+requires-python = ">=3.8"
+license = {text = "MIT"}
+
+[project.scripts]
+autokey2espanso = "autokey2espanso.cli:main"

autokey2espanso-1.0.2/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+