Merge pull request #908 from seleniumbase/invoke-with-python-dash-m

Invoke console scripts with: "python -m seleniumbase"

Author: mdmintz

.gitignore

@@ -27,8 +27,8 @@ ENV/
 VENV/
 env.bak/
 venv.bak/
-sbase
-sbase*
+.sbase
+.sbase*
 seleniumbase_env
 seleniumbase_venv
 sbase_env

docs/requirements.txt

@@ -5,7 +5,7 @@ joblib==1.0.1;python_version>="3.6"
 Markdown==3.3.4;python_version>="3.6"
 MarkupSafe==2.0.1;python_version>="3.6"
 docutils==0.17.1
-Jinja2==3.0.0;python_version>="3.6"
+Jinja2==3.0.1;python_version>="3.6"
 click==8.0.0
 readme-renderer==29.0
 pymdown-extensions==8.2

help_docs/customizing_test_runs.md

@@ -211,6 +211,12 @@ pytest my_first_test.py --server=USERNAME:[email protected] --port=80
 
 Or you can create your own Selenium Grid for test distribution. ([See this ReadMe for details](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/utilities/selenium_grid/ReadMe.md))
 
+To use a server on the ``https`` protocol, add ``--protocol=https``:
+
+```bash
+pytest test_suite.py --protocol=https --server=IP_ADDRESS --port=PORT
+```
+
 <h3><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="28" /> Example tests using Logging:</h3>
 
 ```bash

sbase/ReadMe.txt

@@ -0,0 +1,2 @@
+"SBase" is the short name of "SeleniumBase".
+Use with console scripts: "python -m sbase".

sbase/__init__.py

@@ -0,0 +1,22 @@
+import os
+import sys
+
+# Remove "" and current working directory from the first entry
+# of sys.path (if present) to avoid using the current directory
+# in SeleniumBase commands when invoked as "python -m sbase <command>"
+if sys.path[0] in ("", os.getcwd()):
+    sys.path.pop(0)
+
+if __package__ == "":
+    path = os.path.dirname(os.path.dirname(__file__))
+    sys.path.insert(0, path)
+
+if __name__ == "__main__":
+    import warnings
+    from seleniumbase.console_scripts.run import main
+
+    warnings.filterwarnings(
+        "ignore", category=DeprecationWarning, module=".*packaging\\.version"
+    )
+    main()
+    sys.exit()

sbase/__main__.py

@@ -0,0 +1,22 @@
+import os
+import sys
+
+# Remove "" and current working directory from the first entry
+# of sys.path (if present) to avoid using the current directory
+# in SeleniumBase commands when invoked as "python -m seleniumbase <command>"
+if sys.path[0] in ("", os.getcwd()):
+    sys.path.pop(0)
+
+if __package__ == "":
+    path = os.path.dirname(os.path.dirname(__file__))
+    sys.path.insert(0, path)
+
+if __name__ == "__main__":
+    import warnings
+    from seleniumbase.console_scripts.run import main
+
+    warnings.filterwarnings(
+        "ignore", category=DeprecationWarning, module=".*packaging\\.version"
+    )
+    main()
+    sys.exit()

seleniumbase/__main__.py

@@ -1,2 +1,2 @@
 # seleniumbase package
-__version__ = "1.63.6"
+__version__ = "1.63.7"

seleniumbase/__version__.py

@@ -205,8 +205,8 @@ def main():
     data.append("VENV/")
     data.append("env.bak/")
     data.append("venv.bak/")
-    data.append("sbase")
-    data.append("sbase*")
+    data.append(".sbase")
+    data.append(".sbase*")
     data.append("seleniumbase_env")
     data.append("seleniumbase_venv")
     data.append("sbase_env")

seleniumbase/console_scripts/sb_mkdir.py

@@ -13,13 +13,15 @@ The following commands will work once you've installed seleniumbase.
 ```bash
 seleniumbase download server
 ```
+
 * (Required for using your own Selenium Grid)
 
 <h4><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="30" /> Grid Hub server controls:</h4>
 
 ```bash
 seleniumbase grid-hub {start|stop|restart} [OPTIONS]
 ```
+
 <b>Options:</b>
 <ul>
 <li> -v / --verbose  (Increases verbosity of logging output.)</li>
@@ -31,6 +33,7 @@ seleniumbase grid-hub {start|stop|restart} [OPTIONS]
 ```bash
 seleniumbase grid-node {start|stop|restart} --hub=[HUB_IP] [OPTIONS]
 ```
+
 <b>Options:</b>
 <ul>
 <li> -v / --verbose  (Increases verbosity of logging output.)</li>
@@ -48,30 +51,41 @@ pytest test_suite.py --server=IP_ADDRESS --port=4444
 You can also run your tests on someone else's Selenium Grid to avoid managing your own. Here are some Selenium Grids that you can use (and the run command format):
 
 * [BrowserStack](https://www.browserstack.com/automate#) Selenium Grid:
+
 ```bash
 pytest my_first_test.py --server=USERNAME:[email protected] --port=80
 ```
 
 * [Sauce Labs](https://saucelabs.com/products/open-source-frameworks/selenium) Selenium Grid:
+
 ```bash
 pytest my_first_test.py --server=USERNAME:[email protected] --port=80
 ```
 
 * [TestingBot](https://testingbot.com/features) Selenium Grid:
+
 ```bash
 pytest my_first_test.py --server=USERNAME:[email protected] --port=80
 ```
 
 * [CrossBrowserTesting](https://help.crossbrowsertesting.com/selenium-testing/getting-started/python/) Selenium Grid:
+
 ```bash
 pytest my_first_test.py --server=USERNAME:[email protected] --port=80
 ```
 
 * [LambdaTest](https://www.lambdatest.com/selenium-automation) Selenium Grid:
+
 ```bash
 pytest my_first_test.py --server=USERNAME:[email protected] --port=80
 ```
 
+To use a server on the ``https`` protocol, add ``--protocol=https``:
+
+```bash
+pytest test_suite.py --protocol=https --server=IP_ADDRESS --port=PORT
+```
+
 (For setting browser desired capabilities while running Selenium remotely, see the <a href="https://seleniumbase.io/help_docs/desired_capabilities/">desired capabilities documentation</a> and the sample files located in <a href="https://github.com/seleniumbase/SeleniumBase/tree/master/examples/capabilities">SeleniumBase/examples/capabilities</a>)
 
 <h4><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="30" /> More info about the Selenium Grid Hub can be found here:</h4>