Merge pull request #5 from itk-dev-rpa/release-v1

Release v1

Author: ghbm-itk

.github/workflows/pylint.yml

@@ -1,4 +1,4 @@
-name: Pylint
+name: Linting
 
 on: [push]
 
@@ -14,10 +14,18 @@ jobs:
       uses: actions/setup-python@v3
       with:
         python-version: ${{ matrix.python-version }}
+
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
         pip install pylint
+        pip install flake8
+        pip install .
+
     - name: Analysing the code with pylint
       run: |
         pylint --rcfile=.pylintrc $(git ls-files '*.py')
+
+    - name: Analysing the code with flake8
+      run: |
+        flake8 --extend-ignore=E501,E251 $(git ls-files '*.py')

README.md

@@ -6,7 +6,7 @@ This repo is meant to be used as a template for robots made for [OpenOrchestrato
 
 1. To use the template simply use the repo as a template as shown [here](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template).
 
-2. Fill out the requirements.txt file with all packages needed by the robot.
+2. Fill out the dependencies in the pyproject.toml file with all packages needed by the robot.
 
 3. Implement all functions in the files:
 * src/initialize.py
@@ -15,12 +15,12 @@ This repo is meant to be used as a template for robots made for [OpenOrchestrato
 * src/process.py
 * Feel free to add more files as needed.
 
-4. Make sure the smtp setup in error_screenshot.py is set up to your needs.
+4. Change config.py to your needs.
 
-When the robot is run from OpenOrchestrator the main.bat file is run.
-main.bat does a few things:
+When the robot is run from OpenOrchestrator the main.py file is run.
+main.py does a few things:
 1. A virtual environment is automatically setup with the required packages.
-2. The framework is called passing on all arguments needed by [OpenOrchestratorConnection](https://github.com/itk-dev-rpa/OpenOrchestratorConnection).
+2. The framework is called passing on all arguments needed by [OpenOrchestrator](https://github.com/itk-dev-rpa/OpenOrchestrator).
 
 ## Requirements
 Minimum python version 3.10

Robot-Framework.drawio

@@ -0,0 +1,17 @@
+"""The main file of the robot which will install all requirements in
+a virtual environment and then start the actual process.
+"""
+
+import subprocess
+import os
+import sys
+
+script_directory = os.path.dirname(os.path.realpath(__file__))
+os.chdir(script_directory)
+
+subprocess.run("python -m venv .venv", check=True)
+subprocess.run(r'.venv\Scripts\pip install .', check=True)
+
+command_args = [r".venv\Scripts\python", "-m", "robot_framework"] + sys.argv[1:]
+
+subprocess.run(command_args, check=True)

main.bat

@@ -0,0 +1,21 @@
+[build-system]
+requires = ["setuptools>=65.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "robot_framework"
+version = "0.0.1"
+authors = [
+  { name="ITK Development", email="itk-rpa@mkb.aarhus.dk" },
+]
+readme = "README.md"
+requires-python = ">=3.11"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: Microsoft :: Windows",
+]
+dependencies = [
+    "OpenOrchestrator == 1.*",
+    "Pillow == 9.5.0",
+]

main.py

@@ -0,0 +1,4 @@
+"""The entry point of the process."""
+
+from robot_framework.framework import main
+main()

pyproject.toml

@@ -0,0 +1,9 @@
+"""This module contains configuration constants used across the framework"""
+
+# The number of times the robot retries on an error before terminating.
+MAX_RETRY_COUNT = 3
+
+# Error screenshot config
+SMTP_SERVER = "smtp.aarhuskommune.local"
+SMTP_PORT = 25
+SCREENSHOT_SENDER = "robot@friend.dk"