Metadata-Version: 2.5
Name: kuerzel
Version: 0.1.1
Summary: Kürzel, a desktop studio for Espanso snippets. This package downloads and starts the app.
Project-URL: Homepage, https://github.com/maximilianfeix/kuerzel
Project-URL: Releases, https://github.com/maximilianfeix/kuerzel/releases
Project-URL: Issues, https://github.com/maximilianfeix/kuerzel/issues
Project-URL: Changelog, https://github.com/maximilianfeix/kuerzel/blob/main/CHANGELOG.md
Author: Maxi
License-Expression: MIT
Keywords: espanso,gui,productivity,snippets,text-expander
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: MacOS X
Classifier: Environment :: Win32 (MS Windows)
Classifier: Environment :: X11 Applications
Classifier: Intended Audience :: End Users/Desktop
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Text Processing
Classifier: Topic :: Utilities
Requires-Python: >=3.9
Description-Content-Type: text/markdown

# Kürzel

A desktop studio for [Espanso](https://espanso.org) snippets: write, test and check your text expansions without editing YAML.

![A tour of Kürzel](https://raw.githubusercontent.com/maximilianfeix/kuerzel/main/docs/tour.gif)

## Run it

```sh
pipx run kuerzel
```

or install the command for good:

```sh
pipx install kuerzel
kuerzel
```

`uvx kuerzel` and `pip install kuerzel` work too.

## What this package is

Kürzel is a desktop app, and too large for a Python wheel. This package is a small launcher with no dependencies. On first run it:

1. downloads the build for your system from the project's [GitHub release](https://github.com/maximilianfeix/kuerzel/releases) of the same version,
2. checks it against the release's published SHA-256 checksum and deletes it if it does not match,
3. keeps it in your user cache folder and starts it.

Later runs start the cached app straight away.

| System              | What is downloaded | What happens                                         |
| ------------------- | ------------------ | ---------------------------------------------------- |
| Windows, 64-bit     | portable `.exe`    | The app starts.                                      |
| Linux, x86-64       | `.AppImage`        | The app starts.                                      |
| macOS, Intel or ARM | `.dmg`             | The disk image opens; drag Kürzel to Applications.   |

## Options

```text
kuerzel             download if needed, then start the app
kuerzel --path      print where the app is stored
kuerzel --remove    delete the downloaded app
kuerzel --version   print the version
```

## Good to know

- The builds are not code-signed yet, so Windows and macOS warn on first launch.
- Kürzel edits the files of an existing [Espanso installation](https://espanso.org/install/). Without Espanso it opens a sample workspace.
- Kürzel is an independent project and is not affiliated with Espanso.

What the app does, how it works and its limits are described in the [main README](https://github.com/maximilianfeix/kuerzel#readme).

## License

MIT
