DOC: Updating examples and making sure that they work properly.

Author: hhslepicka

examples/contact/botcity_contact.py

@@ -1,3 +1,6 @@
+"""
+This is an example using the botcity framework as a script.
+"""
 from botcity.core import *
 
 # Add the resource images

examples/rpa-challenge/README.md

@@ -1,4 +1,17 @@
 # RPA Challenge
 
-The examples in this folder are were created to solve the challenges available at the RPA Challenge Website (http://www.rpachallenge.com/).
+The examples in this folder are were created to solve the challenges 
+available at the RPA Challenge Website (http://www.rpachallenge.com/).
 
+Make sure to install the needed requirements with:
+
+```python
+pip install -r requirements.txt
+```
+
+## Examples
+
+- **input_bot.py**: This example demonstrates how to use computer vision in two ways (serial and parallel) to 
+locate the fields on the screen and fill in the values.
+
+- **input_bot-content.py**: This example leverages the page content and navigate the fields using the keyboard.

examples/rpa-challenge/input-forms/input_bot-content.py

@@ -0,0 +1,56 @@
+import botcity.core.config as cfg
+
+import os
+import sys
+import pandas
+import requests
+from botcity.core import DesktopBot
+
+# Speed up without sleep after action.
+cfg.DEFAULT_SLEEP_AFTER_ACTION = 20
+
+
+class Bot(DesktopBot):
+    def action(self, execution):
+        # Add the resource images
+        self.add_image("start", self.get_resource_abspath("start.png"))
+
+        # Download Input Spreadsheet
+        r = requests.get("http://www.rpachallenge.com/assets/downloadFiles/challenge.xlsx")
+
+        if r.status_code != 200:
+            sys.exit('Error fetching the challenge spreadsheet.')
+
+        # Use Pandas to load the Excel Spreadsheet as a DataFrame:
+        df = pandas.read_excel(r.content)
+        df.dropna(axis='columns', inplace=True)
+
+        df.columns = df.columns.str.strip()
+
+        # Navigate to the website
+        self.browse("http://www.rpachallenge.com/")
+
+        # Find and click into the Start button
+        self.find("start")
+        self.click()
+
+        for index, row in df.iterrows():
+            # Click into main area of the page
+            self.control_a()
+            self.control_c()
+            content = self.get_clipboard()
+
+            self.click_at(1000, 200)
+            field_order = [x for x in content[content.rfind('!') + 1:].split(os.linesep) if x in df.columns]
+
+            for f in field_order:
+                self.tab()
+                value = row[f]
+                self.copy_to_clipboard(str(value))
+                self.control_v()
+
+            self.enter()
+
+
+if __name__ == '__main__':
+    Bot.main()

examples/rpa-challenge/input-forms/input_bot-fast.py

@@ -1,67 +1,71 @@
 import sys
 import pandas
 import requests
-import botcity.core.config as cfg
+from botcity.core import DesktopBot
 
-# Speed up without sleep after action.
-cfg.DEFAULT_SLEEP_AFTER_ACTION = 0
 
-# Add the resource images
-add_image("First Name", "./resources/first_name.png")
-add_image("Last Name", "./resources/last_name.png")
-add_image("Company Name", "./resources/company_name.png")
-add_image("Role in Company", "./resources/role.png")
-add_image("Address", "./resources/address.png")
-add_image("Email", "./resources/email.png")
-add_image("Phone Number", "./resources/phone.png")
-add_image("start", "./resources/start.png")
-add_image("submit", "resources/submit_large.png")
+class Bot(DesktopBot):
+    def action(self, execution=None):
+        # Add the resource images
+        self.add_image("First Name", self.get_resource_abspath("first_name.png"))
+        self.add_image("Last Name", self.get_resource_abspath("last_name.png"))
+        self.add_image("Company Name", self.get_resource_abspath("company_name.png"))
+        self.add_image("Role in Company", self.get_resource_abspath("role.png"))
+        self.add_image("Address", self.get_resource_abspath("address.png"))
+        self.add_image("Email", self.get_resource_abspath("email.png"))
+        self.add_image("Phone Number", self.get_resource_abspath("phone.png"))
+        self.add_image("start", self.get_resource_abspath("start.png"))
+        self.add_image("submit", self.get_resource_abspath("submit.png"))
 
-# Download Input Spreadsheet
-r = requests.get("http://www.rpachallenge.com/assets/downloadFiles/challenge.xlsx")
+        # Download Input Spreadsheet
+        r = requests.get("http://www.rpachallenge.com/assets/downloadFiles/challenge.xlsx")
 
-if r.status_code != 200:
-    sys.exit('Error fetching the challenge spreadsheet.')
+        if r.status_code != 200:
+            sys.exit('Error fetching the challenge spreadsheet.')
 
-# Use Pandas to load the Excel Spreadsheet as a DataFrame:
-df = pandas.read_excel(r.content)
-df.dropna(axis='columns', inplace=True)
+        # Use Pandas to load the Excel Spreadsheet as a DataFrame:
+        df = pandas.read_excel(r.content)
+        df.dropna(axis='columns', inplace=True)
 
-# Create a list with the column names
-labels = [c.strip() for c in df.columns]
-labels.append("submit")
+        # Create a list with the column names
+        labels = [c.strip() for c in df.columns]
+        labels.append("submit")
 
-# Navigate to the website
-browse("http://www.rpachallenge.com/")
+        # Navigate to the website
+        self.browse("http://www.rpachallenge.com/")
 
-# Find and click into the Start button
-find("start")
-click()
+        # Find and click into the Start button
+        self.find("start", waiting_time=50000)
+        self.click()
 
-USE_FIND_MULTIPLE = True
+        USE_FIND_MULTIPLE = True
 
-if USE_FIND_MULTIPLE:
-    ### Using Find Multiple
-    for index, row in df.iterrows():
-        results = find_multiple(labels, matching=0.8)
-        for idx, (label, ele) in enumerate(results.items()):
-            if ele is None:
-                sys.exit(f'Could not find element for field: {label}')
-            x, y = ele.left, ele.top
-            if label == 'submit':
-                click_at(x + 10, y + 10)
-            else:
-                click_at(x + 10, y + 30)
-                copy_to_clipboard(str(row[df.columns[idx]]))
-                paste()
-else:
-    ## Using Find one-by-one
-    for index, row in df.iterrows():
-        for col in df.columns:
-            entry_value = row[col]
-            find_text(col.strip(), matching=0.8)
-            click_relative(10, 30)
-            kb_type(str(entry_value))
-        find("submit")
-        click()
-        wait(500)
+        if USE_FIND_MULTIPLE:
+            # Using Find Parallel
+            for index, row in df.iterrows():
+                results = self.find_multiple(labels, matching=0.8)
+                for idx, (label, ele) in enumerate(results.items()):
+                    if ele is None:
+                        sys.exit(f'Could not find element for field: {label}')
+                    x, y = ele.left, ele.top
+                    if label == 'submit':
+                        self.click_at(x + 10, y + 10)
+                    else:
+                        self.click_at(x + 10, y + 30)
+                        self.copy_to_clipboard(str(row[df.columns[idx]]))
+                        self.paste()
+        else:
+            # Using Find Serial Mode
+            for index, row in df.iterrows():
+                for col in df.columns:
+                    entry_value = row[col]
+                    self.find_text(col.strip(), matching=0.8)
+                    self.click_relative(10, 30)
+                    self.kb_type(str(entry_value))
+                self.find("submit")
+                self.click()
+                self.wait(500)
+
+
+if __name__ == '__main__':
+    Bot.main()