Metadata-Version: 2.1
Name: envoke
Version: 0.3.0
Summary: the python macro package
Author-email: Kian McKenna <kian@mckenna.cloud>
License: MIT License
        
        Copyright (c) 2024 McKenna Cloud
        
        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.
Project-URL: Homepage, https://github.com/cowboycodr/envoke
Project-URL: Repository, https://github.com/cowboycodr/envoke
Keywords: macro,keyboard,input,automation
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pyautogui ==0.9.54
Provides-Extra: dev
Requires-Dist: black ; extra == 'dev'
Requires-Dist: bumpver ; extra == 'dev'
Requires-Dist: isort ; extra == 'dev'
Requires-Dist: pip-tools ; extra == 'dev'
Requires-Dist: pytest ; extra == 'dev'

# Envoke

<a href="https://pepy.tech/project/envoke"><img src="https://img.shields.io/pypi/dw/envoke"></a>
<a href="https://pypi.org/project/envoke"><img src="https://img.shields.io/pypi/v/envoke"></a>
<a href="https://github.com/cowboycodr/envoke"><img src="https://img.shields.io/github/repo-size/cowboycodr/envoke"></a>

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:

```bash
pip install envoke
```

## Quick Start

Here's a simple example to get you started:

```python
from envoke import envoke

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

# Run the macro
c.run()
```

## 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

```python
# See examples/basic_usage.py
```

### Advanced Features

```python
# See examples/advanced_features.py
```

### Using Number Keys

```python
# 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.

## License

Envoke is released under the [MIT License](LICENSE).
