Skip to content

Commit

Permalink
add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
spyoungtech committed Nov 22, 2018
1 parent 0aae373 commit 8d4d709
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# ahk

A (proof-of-concept) Python wrapper around AHK.

# Usage

```python
from ahk import AHK
ahk = AHK()
ahk.move_mouse(x=100, y=100, speed=10) # blocks until mouse finishes moving
print(ahk.mouse_position) # (100, 100)
```

# Installation

```
pip install ahk
```

## Dependencies

Just the AHK executable. It's expected to be on PATH by default.

Alternatively you can set an `AHK_PATH` environment variable.

Or, provide it inline

```python
from ahk import AHK
ahk = AHK(executable_path=r'C:\ProgramFiles\AutoHotkey\AutoHotkey.exe')
```

# Development

Right now this is just an idea. It may not even be a particularly good one.

Not much is implemented right now, but the vision is to provide additional interfaces that mirror the core functionality from the AHK API in a Pythonic way.

0 comments on commit 8d4d709

Please sign in to comment.