# Pixeler
[](https://github.com/Klobbix/Pixeler/actions/workflows/python-publish.yml)
### This project is a work-in-progress!
### Human-like Automation and Screen Reading OCR for Python
Pixeler is a Python library that enables developers to create sophisticated automation bots capable of reading and
interacting with a user’s screen in a human-like manner.
By utilizing Optical Character Recognition (OCR) and Bézier curve-based mouse movements, Pixeler provides the tools
necessary for building bots that can perform tasks like identifying text on the screen, responding to UI changes, and
executing precise mouse interactions.
### Features
OCR-Based Screen Reading: Accurately read and interpret text on the screen, enabling bots to understand what’s happening in real-time.
Human-like Mouse Movements: Simulate realistic, human-like mouse movements using Bézier curves to interact with UI elements naturally.
Window-Specific Targeting: Focus on specific windows based on their titles, allowing the bot to interact with the correct application.
Flexible Automation: Design bots that can respond to changes in the UI dynamically, making them adaptable to various applications.
### Third-Party Setup
1. [Install Tesseract](https://github.com/UB-Mannheim/tesseract/releases/)
2. Add Tesseract install path to PATH environment variables
### Installation
You can install Pixeler via pip:
`pip install pixeler`
# Usage
`import Pixeler.bot`
### Extend the bot
Create your own class extending the Pixeler Bot class:
```
class MyBot(Bot):
...
```
### Initialize the bot
```
bot = MyBot(title="Target Application")
```
### Examples
See the **examples** folder. There are plenty of scenarios represented here, from color tracking, screen reading, and Win32 overlays.
### License
Pixeler is licensed under the MIT License. See the LICENSE file for more details.
### Acknowledgments
pytesseract: For the powerful OCR capabilities.
OpenCV: For the robust computer vision tools.
PyAutoGUI: For providing easy-to-use cross-platform GUI automation tools.
### Contact
For any inquiries, please contact [klobbix@gmail.com].
Raw data
{
"_id": null,
"home_page": null,
"name": "pixeler",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Klobbix <klobbix@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/7e/f6/7583bde32edb21f27fbd09a77d982ac1237206d48a2e91af54d4016b921a/pixeler-0.0.5.tar.gz",
"platform": null,
"description": "# Pixeler\n[](https://github.com/Klobbix/Pixeler/actions/workflows/python-publish.yml)\n\n### This project is a work-in-progress!\n\n### Human-like Automation and Screen Reading OCR for Python\n\nPixeler is a Python library that enables developers to create sophisticated automation bots capable of reading and\ninteracting with a user\u2019s screen in a human-like manner.\nBy utilizing Optical Character Recognition (OCR) and B\u00e9zier curve-based mouse movements, Pixeler provides the tools\nnecessary for building bots that can perform tasks like identifying text on the screen, responding to UI changes, and\nexecuting precise mouse interactions.\n\n\n### Features\n\n OCR-Based Screen Reading: Accurately read and interpret text on the screen, enabling bots to understand what\u2019s happening in real-time.\n Human-like Mouse Movements: Simulate realistic, human-like mouse movements using B\u00e9zier curves to interact with UI elements naturally.\n Window-Specific Targeting: Focus on specific windows based on their titles, allowing the bot to interact with the correct application.\n Flexible Automation: Design bots that can respond to changes in the UI dynamically, making them adaptable to various applications.\n\n### Third-Party Setup\n1. [Install Tesseract](https://github.com/UB-Mannheim/tesseract/releases/)\n2. Add Tesseract install path to PATH environment variables\n\n### Installation\n\nYou can install Pixeler via pip:\n\n`pip install pixeler`\n\n# Usage\n\n`import Pixeler.bot`\n\n### Extend the bot\n\nCreate your own class extending the Pixeler Bot class:\n\n```\nclass MyBot(Bot):\n ...\n```\n\n### Initialize the bot\n\n```\nbot = MyBot(title=\"Target Application\")\n```\n\n### Examples\nSee the **examples** folder. There are plenty of scenarios represented here, from color tracking, screen reading, and Win32 overlays.\n\n\n### License\nPixeler is licensed under the MIT License. See the LICENSE file for more details.\n\n\n### Acknowledgments\n\n pytesseract: For the powerful OCR capabilities.\n OpenCV: For the robust computer vision tools.\n PyAutoGUI: For providing easy-to-use cross-platform GUI automation tools.\n\n### Contact\nFor any inquiries, please contact [klobbix@gmail.com].",
"bugtrack_url": null,
"license": null,
"summary": "An automation framework for python using OpenCV",
"version": "0.0.5",
"project_urls": {
"Homepage": "https://github.com/klobbix/Pixeler",
"Issues": "https://github.com/klobbix/Pixeler/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7c1e6362050fb99206fd60efa7970a023d649837ae7b6bac1f5005fb194ad61f",
"md5": "48b0f35e8893945475a5a0dc2f493520",
"sha256": "83d37730b35b54a8e9a5b669f4b3e47019a3d3abb9a4e49b70c3c014fc49fa67"
},
"downloads": -1,
"filename": "pixeler-0.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "48b0f35e8893945475a5a0dc2f493520",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 17493,
"upload_time": "2024-08-23T01:40:48",
"upload_time_iso_8601": "2024-08-23T01:40:48.910381Z",
"url": "https://files.pythonhosted.org/packages/7c/1e/6362050fb99206fd60efa7970a023d649837ae7b6bac1f5005fb194ad61f/pixeler-0.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7ef67583bde32edb21f27fbd09a77d982ac1237206d48a2e91af54d4016b921a",
"md5": "23f15cb88d0073eac3e7ee54f92d6030",
"sha256": "86bc05c05227ce245230496d7a905276f5f453d93737e1fdf7fe0c834c086993"
},
"downloads": -1,
"filename": "pixeler-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "23f15cb88d0073eac3e7ee54f92d6030",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 16142,
"upload_time": "2024-08-23T01:40:49",
"upload_time_iso_8601": "2024-08-23T01:40:49.922688Z",
"url": "https://files.pythonhosted.org/packages/7e/f6/7583bde32edb21f27fbd09a77d982ac1237206d48a2e91af54d4016b921a/pixeler-0.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-23 01:40:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "klobbix",
"github_project": "Pixeler",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "opencv_python_headless",
"specs": [
[
"==",
"4.10.0.84"
]
]
},
{
"name": "opencv-python",
"specs": [
[
"==",
"4.10.0.84"
]
]
},
{
"name": "pywinctl",
"specs": [
[
"==",
"0.4"
]
]
},
{
"name": "numpy",
"specs": [
[
"==",
"2.0.1"
]
]
},
{
"name": "mss",
"specs": [
[
"==",
"9.0.1"
]
]
},
{
"name": "pytesseract",
"specs": [
[
"==",
"0.3.13"
]
]
},
{
"name": "pyautogui",
"specs": [
[
"==",
"0.9.54"
]
]
},
{
"name": "pywin32",
"specs": [
[
"==",
"306"
]
]
}
],
"lcname": "pixeler"
}
JSON
