Metadata-Version: 2.1
Name: AutoHotkey.py
Version: 0.2
Summary: Write AutoHotkey scripts in Python
Author-email: Sviatoslav Abakumov <dust.harvesting@gmail.com>
License: BSD-3-Clause
Project-URL: Documentation, https://ahkpy.readthedocs.io/en/latest/
Project-URL: Changelog, https://github.com/Perlence/AutoHotkey.py/blob/master/CHANGES.md
Project-URL: Source Code, https://github.com/Perlence/AutoHotkey.py
Project-URL: Issue Tracker, https://github.com/Perlence/AutoHotkey.py/issues
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: Implementation :: CPython
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE.md

# AutoHotkey.py

Write AutoHotkey scripts in Python.

## Description

AutoHotkey.py provides a user-friendly API that lets the user write hotkeys and
automation scripts in Python harnessing the power of AutoHotkey. It does so by
embedding a Python DLL into the AutoHotkey process.

## Quickstart

Ensure that you have installed [Python](https://www.python.org/downloads/) 3.8
or later and [AutoHotkey](https://www.autohotkey.com/) 1.1.28 or later.

Install the package to the Python user install directory. To do that, copy and
paste the following into a PowerShell window:

```powershell
py -m pip install --user autohotkey.py
```

Write the sample code into the `playground.py` file:

```powershell
@"
import sys
import ahkpy as ahk

ahk.message_box("Hello!")

@ahk.hotkey("F1")
def bye():
    ahk.message_box("Bye!")
    sys.exit()
"@ | Out-File -Encoding utf8 playground.py
```

Finally, run the sample code:

```powershell
py -m ahkpy playground.py
```

It will show a "Hello!" message box. When the user presses <kbd>F1</kbd>, it
will show a "Bye!" message box and exit.

You can check out and run other
[examples](https://github.com/Perlence/AutoHotkey.py/tree/master/examples) and
read the [documentation](https://ahkpy.readthedocs.io/).

## Minimum Supported Versions

- AutoHotkey v1.1.28 (U32 and U64 variants), AutoHotkey v2.0 is not supported
  [#23](https://github.com/Perlence/AutoHotkey.py/issues/23)
- Python 3.8.0
- Windows 10, version 1511

## Credits

AutoHotkey.py was greatly inspired by Aurelain's
[Exo](https://github.com/Aurelain/Exo). Thanks to Lexikos for his monumental
work on AutoHotkey. Thanks to the AutoHotkey site admins for maintaining the
lively and welcoming forums.
