geteventforhumans


Namegeteventforhumans JSON
Version 0.10 PyPI version JSON
download
home_pagehttps://github.com/hansalemaos/geteventforhumans
SummaryAndroid getevent for Humans!
upload_time2024-07-14 23:01:55
maintainerNone
docs_urlNone
authorJohannes Fischer
requires_pythonNone
licenseMIT
keywords android adb
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            
# Android's getevent for Humans!

### Tested against Windows 10/ Python 3.11 / Anaconda

### pip install geteventforhumans


[![YT](https://i.ytimg.com/vi/np2KZXZHzsY/maxresdefault.jpg)](https://www.youtube.com/watch?v=np2KZXZHzsY)
[https://www.youtube.com/watch?v=np2KZXZHzsY]()


```PY

The function start_getevent_for_humans in the module is designed to capture and log Android device input events in a human-readable format. 

adb_path (optional, default: None):
Type: str
Description: The file path to the Android Debug Bridge (ADB) executable. If not specified, the function attempts to locate ADB using the system's environment variables.

logfolder (optional, default: None):
Type: str
Description: The directory path where event logs should be saved. If not specified, the logs will not be saved

device_serial (optional, default: '127.0.0.1:5555'):
Type: str
Description: The serial number of the Android device to be monitored. This is crucial when multiple devices are connected to the ADB host.

runasdaemon (optional, default: True):
Type: bool
Description: If set to True, the threads started by this function will run as daemons, allowing the main program to exit without having to manually terminate these threads.

bufsize (optional, default: 0):
Type: int
Description: The buffer size for reading data from the input streams. This size can impact performance and responsiveness in capturing event data.

shell (optional, default: True):
Type: bool
Description: Specifies whether the subprocesses should be invoked within a shell environment. 

multiply (optional, default: 24):
Type: int
Description: Used as a multiplier in calculating the chunk size for data processing in some contexts. The exact usage should be confirmed within specific subprocess or threading implementations.


keepbuffer (optional, default: 4):
Type: int
Description: Determines the number of chunks to keep in memory buffer for processing, affecting how much past event data is accessible at any time.


ljust (optional, default: 12):
Type: int
Description: Specifies the padding length for string formatting within the logging output, ensuring alignment in log visualizations.


devices_to_observe (optional, default: empty tuple ()):
Type: tuple of str
Description: A tuple containing the identifiers of specific input devices to monitor, e.g., ("event3", "event4"). If empty, the script may default to monitoring all available devices.

Usage Example
To initiate the event monitoring for specific devices with custom settings, you might call the function like this:

from geteventforhumans import start_getevent_for_humans
import shutil

start_getevent_for_humans(
    adb_path=shutil.which("adb"),
    device_serial="127.0.0.1:5645",
    logfolder="c:\\neuelogsadb",
    runasdaemon=True,
    bufsize=0,
    shell=False,
    multiply=24,
    keepbuffer=1,
    ljust=12,
    devices_to_observe=("event3", "event4"),
)

```

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/hansalemaos/geteventforhumans",
    "name": "geteventforhumans",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "android, adb",
    "author": "Johannes Fischer",
    "author_email": "aulasparticularesdealemaosp@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/7c/0d/4371c18b1b21833f84eab8789b5c54dc2495065bbf11178dacd9ac5a3185/geteventforhumans-0.10.tar.gz",
    "platform": null,
    "description": "\r\n# Android's getevent for Humans!\r\n\r\n### Tested against Windows 10/ Python 3.11 / Anaconda\r\n\r\n### pip install geteventforhumans\r\n\r\n\r\n[![YT](https://i.ytimg.com/vi/np2KZXZHzsY/maxresdefault.jpg)](https://www.youtube.com/watch?v=np2KZXZHzsY)\r\n[https://www.youtube.com/watch?v=np2KZXZHzsY]()\r\n\r\n\r\n```PY\r\n\r\nThe function start_getevent_for_humans in the module is designed to capture and log Android device input events in a human-readable format. \r\n\r\nadb_path (optional, default: None):\r\nType: str\r\nDescription: The file path to the Android Debug Bridge (ADB) executable. If not specified, the function attempts to locate ADB using the system's environment variables.\r\n\r\nlogfolder (optional, default: None):\r\nType: str\r\nDescription: The directory path where event logs should be saved. If not specified, the logs will not be saved\r\n\r\ndevice_serial (optional, default: '127.0.0.1:5555'):\r\nType: str\r\nDescription: The serial number of the Android device to be monitored. This is crucial when multiple devices are connected to the ADB host.\r\n\r\nrunasdaemon (optional, default: True):\r\nType: bool\r\nDescription: If set to True, the threads started by this function will run as daemons, allowing the main program to exit without having to manually terminate these threads.\r\n\r\nbufsize (optional, default: 0):\r\nType: int\r\nDescription: The buffer size for reading data from the input streams. This size can impact performance and responsiveness in capturing event data.\r\n\r\nshell (optional, default: True):\r\nType: bool\r\nDescription: Specifies whether the subprocesses should be invoked within a shell environment. \r\n\r\nmultiply (optional, default: 24):\r\nType: int\r\nDescription: Used as a multiplier in calculating the chunk size for data processing in some contexts. The exact usage should be confirmed within specific subprocess or threading implementations.\r\n\r\n\r\nkeepbuffer (optional, default: 4):\r\nType: int\r\nDescription: Determines the number of chunks to keep in memory buffer for processing, affecting how much past event data is accessible at any time.\r\n\r\n\r\nljust (optional, default: 12):\r\nType: int\r\nDescription: Specifies the padding length for string formatting within the logging output, ensuring alignment in log visualizations.\r\n\r\n\r\ndevices_to_observe (optional, default: empty tuple ()):\r\nType: tuple of str\r\nDescription: A tuple containing the identifiers of specific input devices to monitor, e.g., (\"event3\", \"event4\"). If empty, the script may default to monitoring all available devices.\r\n\r\nUsage Example\r\nTo initiate the event monitoring for specific devices with custom settings, you might call the function like this:\r\n\r\nfrom geteventforhumans import start_getevent_for_humans\r\nimport shutil\r\n\r\nstart_getevent_for_humans(\r\n    adb_path=shutil.which(\"adb\"),\r\n    device_serial=\"127.0.0.1:5645\",\r\n    logfolder=\"c:\\\\neuelogsadb\",\r\n    runasdaemon=True,\r\n    bufsize=0,\r\n    shell=False,\r\n    multiply=24,\r\n    keepbuffer=1,\r\n    ljust=12,\r\n    devices_to_observe=(\"event3\", \"event4\"),\r\n)\r\n\r\n```\r\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Android getevent for Humans!",
    "version": "0.10",
    "project_urls": {
        "Homepage": "https://github.com/hansalemaos/geteventforhumans"
    },
    "split_keywords": [
        "android",
        " adb"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fb0ce2f0a1b01857eec835d97d4d5ee027ef5044625299ac8ee194cdb774d69b",
                "md5": "a743f0f9f753b4cbb13fce620e28b614",
                "sha256": "fb5f9afa459752e01ba634e81aab47f3bce52d617834380e7b2aaec17f7574a8"
            },
            "downloads": -1,
            "filename": "geteventforhumans-0.10-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a743f0f9f753b4cbb13fce620e28b614",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 16402,
            "upload_time": "2024-07-14T23:01:53",
            "upload_time_iso_8601": "2024-07-14T23:01:53.982738Z",
            "url": "https://files.pythonhosted.org/packages/fb/0c/e2f0a1b01857eec835d97d4d5ee027ef5044625299ac8ee194cdb774d69b/geteventforhumans-0.10-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7c0d4371c18b1b21833f84eab8789b5c54dc2495065bbf11178dacd9ac5a3185",
                "md5": "69c6d69d0dc2e0942977ec368af6b4d6",
                "sha256": "56eae493a0992906a5dc86fea84663140926dc6e6d167288f2082187d4e85f87"
            },
            "downloads": -1,
            "filename": "geteventforhumans-0.10.tar.gz",
            "has_sig": false,
            "md5_digest": "69c6d69d0dc2e0942977ec368af6b4d6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 15112,
            "upload_time": "2024-07-14T23:01:55",
            "upload_time_iso_8601": "2024-07-14T23:01:55.339159Z",
            "url": "https://files.pythonhosted.org/packages/7c/0d/4371c18b1b21833f84eab8789b5c54dc2495065bbf11178dacd9ac5a3185/geteventforhumans-0.10.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-07-14 23:01:55",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "hansalemaos",
    "github_project": "geteventforhumans",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "lcname": "geteventforhumans"
}
        
Elapsed time: 0.26303s