Merge pull request #20 from JE-Chen/dev

Dev

Author: JE-Chen

.idea/workspace.xml

@@ -2,6 +2,19 @@
 
 ---
 
+### JE Auto Control as a tool for GUI Testing 
+#### Features
+* Image Detect
+* Keyboard Event
+* Mouse Event
+* Screen 
+* Action File
+* Record Event
+* CLI with action file
+* timeout
+
+---
+
 [![CircleCI](https://circleci.com/gh/JE-Chen/AutoControl/tree/main.svg?style=svg)](https://circleci.com/gh/JE-Chen/AutoControl/tree/main)
 
 ### Documentation

README.md

@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name="je_auto_control_dev",
-    version="0.0.07",
+    version="0.0.08",
     author="JE-Chen",
     author_email="[email protected]",
     description="auto testing",

dev_setup.py

@@ -0,0 +1,32 @@
+AutoControlGUI Critical Exit Doc
+==========================
+
+.. code-block:: python
+
+   class CriticalExit(Thread):
+    """
+    use to make program interrupt
+    """
+
+        def __init__(self, default_daemon: bool = True):
+            """
+            default interrupt is keyboard F7 key
+            :param default_daemon bool thread setDaemon
+            """
+
+        def set_critical_key(self, keycode: [int, str] = None):
+            """
+            set interrupt key
+            :param keycode interrupt key
+            """
+
+          def run(self):
+            """
+            listener keycode _exit_check_key to interrupt
+            """
+
+         def init_critical_exit(self):
+            """
+            should only use this to start critical exit
+            may this function will add more
+            """

docs/source/doc/auto_control_critical_exit_doc/auto_control_critical_exit_doc.rst

@@ -0,0 +1,42 @@
+AutoControlGUI Executor Doc
+==========================
+
+.. code-block:: python
+
+    def execute_action(action_list: list):
+        """
+        use to execute all action on action list(action file or python list)
+        :param action_list the list include action
+        for loop the list and execute action
+        """
+
+    """
+    Executor example
+    on program or action file
+    use format like bottom
+    [function_name, {param: value,...}]
+    if no param use [function_name]
+    """
+    from je_auto_control import execute_action
+    from je_auto_control import test_record
+        example_list = [
+        ["type_key", {"keycode": 65}],
+        ["mouse_left", {"mouse_keycode": "mouse_left", "x": 500, "y": 500}],
+        ["position"],
+        ["press_mouse", {"mouse_keycode": "mouse_left", "x": 500, "y": 500}],
+        ["release_mouse", {"mouse_keycode": "mouse_left", "x": 500, "y": 500}],
+    ]
+    execute_action(example_list)
+
+    def read_action_json(json_file_path: str):
+    """
+    use to read action file
+    :param json_file_path json file's path to read
+    """
+
+    def write_action_json(json_save_path: str, action_json: list):
+    """
+    use to save action file
+    :param json_save_path  json save path
+    :param action_json the json str include action to write
+    """

docs/source/doc/auto_control_executor_doc/auto_control_executor_doc.rst

@@ -1,4 +1,4 @@
-AutoControlGUI Critical Exit
+AutoControlGUI Image Doc
 ==========================
 
 .. code-block:: python

docs/source/doc/auto_control_image/auto_control_image.rst renamed to docs/source/doc/auto_control_image_doc/auto_control_image_doc.rst

@@ -1,4 +1,4 @@
-AutoControlGUI Critical Exit
+AutoControlGUI Keyboard Doc
 ==========================
 
 

docs/source/doc/auto_control_keyboard/auto_control_keyboard.rst renamed to docs/source/doc/auto_control_keyboard_doc/auto_control_keyboard_doc.rst

@@ -1,4 +1,4 @@
-AutoControlGUI Critical Exit
+AutoControlGUI Mouse Doc
 ==========================
 
 

docs/source/doc/auto_control_mouse/auto_control_mouse.rst renamed to docs/source/doc/auto_control_mouse_doc/auto_control_mouse_doc.rst

@@ -0,0 +1,15 @@
+AutoControlGUI Record Doc
+==========================
+
+
+.. code-block:: python
+
+    def record():
+    """
+    start record keyboard and mouse event until stop_record
+    """
+
+    def stop_record():
+    """
+    stop current record
+    """

docs/source/doc/auto_control_record_doc/auto_control_record_doc.rst

@@ -0,0 +1,17 @@
+AutoControlGUI Screen Doc
+==========================
+
+
+.. code-block:: python
+
+    def size():
+        """
+        get screen size
+        """
+
+    def screenshot(file_path: str = None, region: list = None):
+        """
+        use to capture current screen image
+        :param file_path screenshot file save path
+        :param region screenshot region
+        """