Skip to main content

Apparser is a Python library for automating desktop applications and interacting with UIs using AI-powered tools such as OCR and object detection models.

Project description

License - BSD 3-Clause unit_tests
PyPI Downloads Documentation
PyPI GitHub Issues

Apparser

Apparser is a Python library for automating desktop applications and interacting with UIs using AI-powered tools such as OCR and object detection models.

Installation

# Base Apparser package with base OCR model
pip install apparser

# Apparser with text recognition support
pip install "apparser[ocr]"

# Apparser with text-to-speech support
pip install "apparser[speak]"

# Apparser with object detection support
pip install "apparser[cv]"

# Apparser with all optional features
pip install "apparser[all]"

Examples

Disclaimer: This example is provided for educational purposes only to demonstrate UI automation concepts. Do not use it with Counter-Strike 2, Steam, multiplayer games, VAC-protected games, ranking/progression systems, or any application/service where automation is prohibited by its terms of service. This project is not affiliated with, endorsed by, or sponsored by Valve, Steam, or Counter-Strike 2.

  1. Open CS2 and start a game

Code

from apparser import App
from apparser.instructions import OCRAlgorithm
from apparser.instructions.ocr import WaitText, ClickOnText

# Text labels that the OCR algorithm will look for on the screen.
play_button = "play"
deathmatch_button = "deathmatch"
group_button = "hostage group"
start_button = "go"

# Create OCR-based algorithm.
algorithm = OCRAlgorithm([
    # Wait for the main menu and open the play screen.
    WaitText(play_button),
    ClickOnText(play_button),
    # Select the deathmatch mode.
    WaitText(deathmatch_button),
    ClickOnText(deathmatch_button),
    # Select the hostage group and start the match.
    WaitText(group_button),
    ClickOnText(group_button),
    ClickOnText(start_button, min_similarity=0.5)
])

# Launch CS2
app = App(['cmd', '/c', 'start', 'steam://rungameid/730'], timeout=20)

# Run the prepared scenario against the application UI.
algorithm.perform(app.ui)

Video

Docs

Full documentation is available here
Package page on PyPI

Donation

If you'd like to financially support the developers' work:

Donation link

For Developers

  1. If something doesn't work, open an issue.
  2. If you want something fixed, open an issue.
  3. If you can help with the library, email us.

apparser.development@gmail.com

Contributions are welcome!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

apparser-1.1.2.tar.gz (39.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

apparser-1.1.2-py3-none-any.whl (78.9 kB view details)

Uploaded Python 3

File details

Details for the file apparser-1.1.2.tar.gz.

File metadata

  • Download URL: apparser-1.1.2.tar.gz
  • Upload date:
  • Size: 39.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for apparser-1.1.2.tar.gz
Algorithm Hash digest
SHA256 2016515e08ead627ecea8300941d8a5a887a05e14de381d99e74e513bf66708e
MD5 42ad6c834f982dce541b46d55e787396
BLAKE2b-256 365357e42397590c71625f93a9be21a12293bfbd0e40aa8e7db861df24bfbc58

See more details on using hashes here.

File details

Details for the file apparser-1.1.2-py3-none-any.whl.

File metadata

  • Download URL: apparser-1.1.2-py3-none-any.whl
  • Upload date:
  • Size: 78.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for apparser-1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 1cd43d73a858164570cf647810fda8d2ba11917d1de120199e9202bbff7f76b5
MD5 4b168882532d472d357cd0e941f3332d
BLAKE2b-256 a2dff790378aebbabf4a8940a51c5c2dbdce5854eebf02f5c65ac8c88ce89f60

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page