| Name | envoke JSON |
| Version |
0.3.1
JSON |
| download |
| home_page | |
| Summary | the python macro package |
| upload_time | 2024-01-16 19:39:37 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.6 |
| 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. |
| keywords |
macro
keyboard
input
automation
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
mouseinfo
pyautogui
pygetwindow
pymsgbox
pyobjc-core
pyobjc-framework-cocoa
pyobjc-framework-quartz
pyperclip
pyrect
pyscreeze
pytweening
rubicon-objc
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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
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
```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.
## Packaging
To package Envoke for distribution, follow these steps:
```bash
# 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:
```bash
python -m twine upload dist/*
```
## License
Envoke is released under the [MIT License](LICENSE).
Raw data
{
"_id": null,
"home_page": "",
"name": "envoke",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "macro,keyboard,input,automation",
"author": "",
"author_email": "Kian McKenna <kian@mckenna.cloud>",
"download_url": "https://files.pythonhosted.org/packages/63/05/2e1b08f63d732b6ba33c40d813432a3c09db48a03b271e9791a369e1af4f/envoke-0.3.1.tar.gz",
"platform": null,
"description": "# Envoke\n\n<a href=\"https://pepy.tech/project/envoke\"><img src=\"https://img.shields.io/pypi/dw/envoke\"></a>\n<a href=\"https://pypi.org/project/envoke\"><img src=\"https://img.shields.io/pypi/v/envoke\"></a>\n<a href=\"https://github.com/cowboycodr/envoke\"><img src=\"https://img.shields.io/github/repo-size/cowboycodr/envoke\"></a>\n\nEnvoke 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.\n\n## Installation\n\nTo install Envoke, run the following command:\n\n```bash\npip install envoke\n```\n\n## Quick Start\n\nHere's a simple example to get you started:\n\n```python\nfrom envoke import envoke\n\n# Create a macro sequence\ne = envoke()\ne.enter(interval=0.5).key('a', interval=0.1)\n\n# Run the macro\ne.run(start_delay=3)\n```\n\n## Advanced Usage\n\nEnvoke also supports more advanced features, including continuous macros and random interval differences. See the `/examples` directory for more use cases.\n\n## Examples\n\n### Basic Usage\n\n```python\n# See examples/basic_usage.py\n```\n\n### Advanced Features\n\n```python\n# See examples/advanced_features.py\n```\n\n### Using Number Keys\n\n```python\n# See examples/number_keys_example.py\n```\n\n## Documentation\n\nWill work on this eventually. For right now `/examples` should suffice.\n\n## Contributing\n\nContributions to Envoke are welcome! I don't currently have a `CONTRIBUTING.md` so just submit them freely.\n\n## Packaging\n\nTo package Envoke for distribution, follow these steps:\n\n```bash\n# Ensure you are in the root directory of the project\npython -m build\n```\n\nAfter the build is successful, you can upload the package to PyPI using twine:\n\n```bash\npython -m twine upload dist/*\n```\n\n## License\n\nEnvoke is released under the [MIT License](LICENSE).\n",
"bugtrack_url": null,
"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.",
"summary": "the python macro package",
"version": "0.3.1",
"project_urls": {
"Homepage": "https://github.com/cowboycodr/envoke",
"Repository": "https://github.com/cowboycodr/envoke"
},
"split_keywords": [
"macro",
"keyboard",
"input",
"automation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c4e48e29b3f3d232716d44a29cbc14d5120566569ae4596a53d9059aa9844e59",
"md5": "3967c7050dda3de68a588bef97cd5a08",
"sha256": "6d6cb9803cefa3e35885b5150bc8bd9c450a81403c7eca53fd3e16a87b2dc65d"
},
"downloads": -1,
"filename": "envoke-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3967c7050dda3de68a588bef97cd5a08",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 4647,
"upload_time": "2024-01-16T19:39:36",
"upload_time_iso_8601": "2024-01-16T19:39:36.254974Z",
"url": "https://files.pythonhosted.org/packages/c4/e4/8e29b3f3d232716d44a29cbc14d5120566569ae4596a53d9059aa9844e59/envoke-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "63052e1b08f63d732b6ba33c40d813432a3c09db48a03b271e9791a369e1af4f",
"md5": "6fcc415f2243e1b3bcc04a1747e0bf77",
"sha256": "c2e96cf763da640be87c6e10a72b0ed531441fd96a00731cbff160121f31092d"
},
"downloads": -1,
"filename": "envoke-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "6fcc415f2243e1b3bcc04a1747e0bf77",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 3937,
"upload_time": "2024-01-16T19:39:37",
"upload_time_iso_8601": "2024-01-16T19:39:37.850753Z",
"url": "https://files.pythonhosted.org/packages/63/05/2e1b08f63d732b6ba33c40d813432a3c09db48a03b271e9791a369e1af4f/envoke-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-16 19:39:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cowboycodr",
"github_project": "envoke",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "mouseinfo",
"specs": [
[
"==",
"0.1.3"
]
]
},
{
"name": "pyautogui",
"specs": [
[
"==",
"0.9.54"
]
]
},
{
"name": "pygetwindow",
"specs": [
[
"==",
"0.0.9"
]
]
},
{
"name": "pymsgbox",
"specs": [
[
"==",
"1.0.9"
]
]
},
{
"name": "pyobjc-core",
"specs": [
[
"==",
"10.1"
]
]
},
{
"name": "pyobjc-framework-cocoa",
"specs": [
[
"==",
"10.1"
]
]
},
{
"name": "pyobjc-framework-quartz",
"specs": [
[
"==",
"10.1"
]
]
},
{
"name": "pyperclip",
"specs": [
[
"==",
"1.8.2"
]
]
},
{
"name": "pyrect",
"specs": [
[
"==",
"0.2.0"
]
]
},
{
"name": "pyscreeze",
"specs": [
[
"==",
"0.1.30"
]
]
},
{
"name": "pytweening",
"specs": [
[
"==",
"1.0.7"
]
]
},
{
"name": "rubicon-objc",
"specs": [
[
"==",
"0.4.7"
]
]
}
],
"lcname": "envoke"
}
