SeleniumBase: A fast & reliable web automation framework for end-to-end testing with Python, pytest and WebDriver. Includes tools for reporting, visual testing, RPA, and more.
+
+SeleniumBase is a Python framework for web automation, end-to-end testing, and more.
+Tests are run with "pytest". Browsers are controlled by WebDriver.
+
-β Has a [complete API](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/method_summary.md) for writing UI tests.
+β Has a [complete API](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/method_summary.md) for Web-UI testing.
β Expands pytest [command-line options](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/customizing_test_runs.md).
-β Includes tools for [logging and reports](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/example_logs/ReadMe.md).
+β Includes tools for [dashboards & reports](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/example_logs/ReadMe.md).
+β Includes [scripts](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/console_scripts/ReadMe.md) for driver management.
--------
-
π΅ Add **[Python](https://www.python.org/downloads/)** and **[Git](https://git-scm.com/)** to your System PATH.
π΅ Create a **[Python virtual environment](https://seleniumbase.io/help_docs/virtualenv_instructions/)**.
-
Install SeleniumBase: π
+
Install SeleniumBase:
-π΅ You can install ``seleniumbase`` from [pypi](https://pypi.python.org/pypi/seleniumbase):
+π΅ You can install ``seleniumbase`` from [GitHub](https://github.com/seleniumbase/SeleniumBase):
+
+```bash
+git clone https://github.com/seleniumbase/SeleniumBase.git
+cd SeleniumBase/
+pip install . # Normal installation
+pip install -e . # Editable install
+```
+
+> (When using a virtual env, the Editable install is faster.)
+
+π΅ You can also install ``seleniumbase`` from [pypi](https://pypi.python.org/pypi/seleniumbase):
```bash
pip install seleniumbase
@@ -84,15 +96,6 @@ pip install seleniumbase
> (Add ``--force-reinstall`` to upgrade dependencies.)
> (Use ``pip3`` if multiple versions of Python are installed.)
-π΅ You can also install ``seleniumbase`` from a [GitHub](https://github.com/seleniumbase/SeleniumBase) clone:
-
-```bash
-git clone https://github.com/seleniumbase/SeleniumBase.git
-cd SeleniumBase/
-pip install . # Normal installation
-pip install -e . # Editable install
-```
-
π΅ Type ``seleniumbase`` or ``sbase`` to verify that SeleniumBase was installed successfully:
```bash
@@ -164,14 +167,14 @@ cd ui_tests/
ui_tests/
βββ __init__.py
βββ boilerplates/
-βΒ Β βββ __init__.py
-βΒ Β βββ base_test_case.py
-βΒ Β βββ boilerplate_test.py
-βΒ Β βββ page_objects.py
-βΒ Β βββ samples/
-βΒ Β βββ __init__.py
-βΒ Β βββ google_objects.py
-βΒ Β βββ google_test.py
+β βββ __init__.py
+β βββ base_test_case.py
+β βββ boilerplate_test.py
+β βββ page_objects.py
+β βββ samples/
+β βββ __init__.py
+β βββ google_objects.py
+β βββ google_test.py
βββ my_first_test.py
βββ parameterized_test.py
βββ pytest.ini
@@ -301,7 +304,7 @@ nosetests [FILE_NAME.py]:[CLASS_NAME].[METHOD_NAME]
-
+
* A complete test automation framework for web/mobile UI testing.
* Supports [pytest](https://docs.pytest.org/en/latest/), [unittest](https://docs.python.org/3/library/unittest.html), and [nose](http://nose.readthedocs.io/en/latest/) for test discovery and running.
@@ -37,4 +37,4 @@
* Can load and make assertions on PDF files from websites or the local file system.
* Includes useful [Python decorators and password obfuscation methods](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/common/ReadMe.md).
-[](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md)
+[](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md)
diff --git a/help_docs/syntax_formats.md b/help_docs/syntax_formats.md
index 3ae04cff..8404126e 100755
--- a/help_docs/syntax_formats.md
+++ b/help_docs/syntax_formats.md
@@ -3,6 +3,12 @@
+
+[](https://www.youtube.com/watch?v=HOooW_0o468)
+
+--------
+
SeleniumBase supports 15 different syntax formats for structuring tests. (The first 4 are the most common.)