Post-release fixes

Author: cmin764

README.md

@@ -2,7 +2,8 @@
 
 Robot Framework template implementing a Producer-Consumer model using custom libraries
 and resources. This combines two already existing templates, such as the
-"Extended Robot Framework template" and "Producer-consumer model template", into one.
+**Extended Robot Framework template** and the **Producer-consumer model template**,
+into one.
 
 It features the following:
 - Producer-Consumer model: one task produces work and another consumes it.
@@ -12,8 +13,8 @@ It features the following:
   - Custom Python libraries placed in the [*libraries*](./libraries/) directory.
   - Custom reusable RF resources and variables file placed in
     [*resources*](./resources/).
-  - Optional (setup) scripts to be ran before the robot starts in [*bin*](./bin/).
-    (**rcc** only)
+  - Optional (setup) scripts, to be ran before the robot starts, in [*bin*](./bin/).
+    (**rcc** & Control Room only)
   - Locally mocked Work Items and environment variables JSON files, to customize the
     run and simulate the Control Room behavior, in [*devdata*](./devdata/).
 
@@ -39,6 +40,10 @@ Every such task has its own `<Task Name> With Trace` flavor through which you ca
 enable a fine grained control over the robot run and enable error tracing as well with
 it. (debugging purposes)
 
+> It is highly recommended to **rename and customize** all these tasks, including any
+> other file, resource or library, as the naming used here isn't suitable for
+> production. (it's just a template demo-ing the functionality)
+
 ### How to run
 
 1. The first task runs with the only available initial input Work Item:
@@ -49,10 +54,10 @@ it. (debugging purposes)
 
 Set `CREATE_REPORT` env var (in Control Room as well) if you decide to use the 3rd Step
 for reporting purposes. This is enabled by default locally in the
-[env.json](./devdata/env.json) file.
+[env.json](./devdata/env.json) file (and its other flavors when running with **rcc**).
 
 Please go through the robot code and read the `[Documentation]` and comment sections
-for each of the tasks/keywords in order to understand the details.
+for each of the tasks/keywords in order to understand how the bot works in detail.
 
 ## Learn more
 
@@ -67,5 +72,5 @@ for each of the tasks/keywords in order to understand the details.
 - [Extended Robot Framework Template](https://robocorp.com/portal/robot/robocorp/template-extended)
 - [Producer-Consumer Model Template](https://robocorp.com/portal/robot/robocorp/template-producer-consumer)
 - [Web Store Order Processor Using Work Items](https://robocorp.com/portal/robot/robocorp/example-web-store-work-items)
-- [Template for producer-consumer model robots using work items](https://robocorp.com/portal/robot/robocorp/example-producer-consumer-reporting)
+- [Reporting Producer-Consumer model with Excel and Browser](https://robocorp.com/portal/robot/robocorp/example-producer-consumer-reporting)
 - [Order in bulk the total number of requested robot parts](https://robocorp.com/portal/robot/robocorp/example-orders-distribution)

bin/generate-workitem-file.py

@@ -14,7 +14,7 @@
 from pathlib import Path
 
 
-def main(argv, argc):
+def main(argc, argv):
     """Main entry point of the script which gets executed before the bot starts."""
     # Use `argparse` for better support towards CLI argument parsing:
     #  https://docs.python.org/3/library/argparse.html
@@ -34,5 +34,5 @@ def main(argv, argc):
 if __name__ == "__main__":
     # Call the main function with CLI arguments and exit with a return code. A non-zero
     #  value will interrupt the bot execution.
-    return_code = main(sys.argv, len(sys.argv))
-    sys.exit(int(return_code or 0))
+    return_code = main(len(sys.argv), sys.argv)  # called with CLI arguments
+    sys.exit(int(return_code or 0))  # exits with above return code

consumer.robot

@@ -2,7 +2,7 @@
 Documentation    Robot Framework template implementing a Producer-Consumer model using
 ...    custom libraries and resources. (Consumer robot which consumes input work)
 
-Library    MyLibrary
+Library    DummyLibrary
 Library    RPA.Robocorp.WorkItems
 
 Resource    keywords.robot

libraries/MyLibrary.py libraries/DummyLibrary.py

@@ -1,24 +1,29 @@
-"""RF-importable library written in Python."""
+"""RF-importable library written in Python.
+
+Attention! Please rename it and add your own useful keywords and documentation.
+"""
 
 from robot.api import logger
 
 # Variables can be accessed from the resources/variables.py Python module here as well.
 from variables import TODAY
 
 
-class MyLibrary:
-    """Give this library a proper name and document it."""
+class DummyLibrary:
+    """Set a proper name, add useful methods and document it accordingly."""
 
     def __init__(self):
-        """Add and document optional input data passed during the import."""
-        # Additionally add a state available for the entire life of the library.
-        self._context = object()  # just an example (you can remove this)
+        """Add and document optional input data passed during the import. ([kw]args)"""
+        # Additionally, add a state available for the entire life of the library.
+        self._context = None  # just a dummy example (used later on in the methods)
 
     def log_today_in_python(self) -> None:
         """Displays today's date in Python."""
         logger.info(f"Today is {TODAY}. (from Python)")
+        self._context = "under logging keyword"
 
     def my_library_keyword(self, var: str = "test") -> str:
         """Describe what this RF exposed keyword does."""
         logger.info("Python code (as RF keyword) executed with value: %s", var)
+        self._context = "under my keyword"
         return var

producer.robot

@@ -2,7 +2,7 @@
 Documentation    Robot Framework template implementing a Producer-Consumer model using
 ...    custom libraries and resources. (Producer robot which produces output work)
 
-Library    MyLibrary
+Library    DummyLibrary
 Library    RPA.FileSystem
 Library    RPA.Robocorp.WorkItems
 

resources/variables.py

@@ -3,8 +3,9 @@
 from RPA.Robocorp.utils import get_output_dir
 
 
-# Various user-defined constants:
+# Current date formatted as a string in YYYY-MM-DD format.
 TODAY = datetime.strftime(datetime.now(), "%Y-%m-%d")
+
 # File which gets attached in the output Work Items produced by the Producer. This file
-#  is generated by a pre-run script configured in the robot.yaml.
+#  is generated by a pre-run script configured in the robot.yaml during rcc/cloud runs.
 WORKITEM_FILE_PATH = str(get_output_dir() / "random-workitem-file.txt")