envoke 0.3.1

the python macro package

Envoke

Envoke is a Python package that allows users to create and run keyboard macros with optional delays and randomness. It's designed to be simple yet flexible, providing a straightforward API for automating key presses.

Installation

To install Envoke, run the following command:

pip install envoke

Quick Start

Here's a simple example to get you started:

from envoke import envoke

# Create a macro sequence
e = envoke()
e.enter(interval=0.5).key('a', interval=0.1)

# Run the macro
e.run(start_delay=3)

Advanced Usage

Envoke also supports more advanced features, including continuous macros and random interval differences. See the /examples directory for more use cases.

Examples

Basic Usage

# See examples/basic_usage.py

Advanced Features

# See examples/advanced_features.py

Using Number Keys

# See examples/number_keys_example.py

Documentation

Will work on this eventually. For right now /examples should suffice.

Contributing

Contributions to Envoke are welcome! I don't currently have a CONTRIBUTING.md so just submit them freely.

Packaging

To package Envoke for distribution, follow these steps:

# Ensure you are in the root directory of the project
python -m build

After the build is successful, you can upload the package to PyPI using twine:

python -m twine upload dist/*

License

Envoke is released under the MIT License.