Refactoring, add argparse support, update README.md

Author: woyow

README.md

@@ -13,7 +13,7 @@ Automatically generating directories and `browsers.json`, `docker-compose.yaml`,
   - [x] docker-compose.yaml
 - [x] teams-quota / users-quota
   - [x] htpasswd
-- [x] hosts config
+- [ ] hosts config
   - [x] standart parameters for selenoid
   - [ ] optional parameters for selenoid
   - [ ] shell-script for pull browser images from browsers-config
@@ -128,15 +128,37 @@ teams-quota: # [optional] - if use ggr balancer
 ```
 
 ## Run script
+### 1. Go to the folder and give execute permissions
 ```bash
 cd ~/selenoid-config-tool
-chmod u+x ./main.py
-./main.py
+chmod u+x ./sctool
+```
+### 2. Default usage
+```bash
+./sctool
+```
+### 3. Usage with parameters
+#### 3.1 Get help
+```bash
+./sctool --help
+```
+#### 3.2 Run with custom parameters
+```bash
+./sctool --results-dir ./your-results-dir --config-dir ./your-config-dir
+# or
+./sctool -r ./your-results-dir -c ./your-config-dir
 ```
 
 ## Results
 ### 1. Change to the directory with the results
 ```bash
 cd ~/selenoid-config-tool/results
 ```
-### 2. Ready!
+### 2. Ready!
+
+## Possible problems
+The tool uses caching for http-responses. Therefore, in rare cases, you may not receive up-to-date information on browser versions. The cache is stored in the default folder for your user - `~/.cache/`
+#### For remove cache, usage:
+```bash
+rm ~/.cache/selenoid_config_tool_requests_cache.sqlite
+```

config/test_config.yaml examples/config/config.yaml

@@ -15,12 +15,8 @@ browsers:
     versions: # from min and to max in steps of 1
       range:
         min: 80.0
-        max: 98.0
+        max: 99.0
         ignore: [82.0]
-      #capabilities:
-      #  vnc_enabled: True
-      #  video_enabled: False
-      #  session_timeout: "1m"
 
   - type: chrome-mobile
     use: true

main.py

@@ -4,4 +4,5 @@ pykwalify==1.8.0
 requests==2.27.1
 requests-cache==0.9.1
 htpasswd==2.3
-lxml==4.8.0
+lxml==4.8.0
+halo==0.0.31

requirements.txt

@@ -0,0 +1,48 @@
+#! /usr/bin/env python3
+
+import argparse
+import sys
+import os
+
+from helpers.change_root_dir import ChangeRootDir
+from src.configurator import Configurator
+
+
+def init() -> None:
+    try:
+        change_root_dir = ChangeRootDir()
+        change_root_dir()  # Change directory to be able to run script in different directories
+    except:
+        print("Something went wrong. Root directory not changed.")
+    finally:
+        del change_root_dir
+
+
+def main() -> None:
+    init()
+    cmd_args.config_dir = os.path.abspath(cmd_args.config_dir)
+    cmd_args.results_dir = os.path.abspath(cmd_args.results_dir)
+    print(cmd_args)
+    configurator = Configurator(cmd_args)
+    configurator()
+    print(f'Complete!\n'
+          f'\n'
+          f'Find your results into {cmd_args.results_dir} directory')
+
+
+if __name__ == '__main__':
+    parser = argparse.ArgumentParser(prog='sctool')
+
+    parser.add_argument('-r',
+                        '--results-dir',
+                        default='./results',
+                        help='Directory to save results, default - ./results'
+                        )
+    parser.add_argument('-c',
+                        '--config-dir',
+                        default='./config',
+                        help='Directory to get yaml config file, default - ./config'
+                        )
+
+    cmd_args = parser.parse_args()
+    sys.exit(main())

sctool

@@ -8,8 +8,11 @@ class ConfigParser(OpenFile):
     ic.disable()
     # ic.enable()
 
-    def __init__(self) -> None:
-        self.file_path = './config/test_config.yaml'
+    def __init__(self, config_dir) -> None:
+        self.config_dir = config_dir
+        ic(self.config_dir)
+
+        self.file_path = f'{self.config_dir}/config.yaml'
         self.schema_path = './config/schema/config_schema.yaml'
         super().__init__(self.file_path)
         self.config_file = self.open_yaml_file()