diff --git a/README.md b/README.md index c05c5143..3eae9e21 100755 --- a/README.md +++ b/README.md @@ -6,55 +6,58 @@

-SeleniumBase

+SeleniumBase

+

+Everything you need to test websites. +

Latest Release on GitHub -Latest Release on PyPI SeleniumBase Azure Pipelines -SeleniumBase GitHub Actions -SeleniumBase SeleniumBase PyPI downloads -SeleniumBase Twitter followers +Latest Release on PyPI +SeleniumBase GitHub Actions SeleniumBase Azure Pipelines +SeleniumBase SeleniumBase.io Docs

-

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. +

πŸš€ Start | πŸ—‚οΈ Features | πŸ–₯️ CLI | -πŸ‘¨β€πŸ« Examples +πŸ‘¨β€πŸ« Examples | +♻️ Boilerplates | +πŸ—Ύ Locales | +πŸ—„οΈ PkgManager
πŸ“— API | πŸ“Š Reports | +πŸ’» Scripts | πŸ“± Mobile | +πŸ”‘ Syntax Formats | +🌐 GridHub | ⏺️ Recorder
πŸ€– CI | 🌏 Translate | πŸ—ΊοΈ Tours | -πŸ–ΌοΈ VisualTest -
-πŸ’» CMD Scripts | -🌐 Grid | -πŸ”  SyntaxFormats -
-♻️ Boilerplates | -πŸ—Ύ Locales | -πŸ—„οΈ PkgManager -
+πŸ–ΌοΈ VisualTest | πŸ“‘ Presenter | πŸ“ˆ ChartMaker | πŸ›‚ MasterQA

-βœ… 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.
-------- -

(Below: test_swag_labs.py using Demo Mode.)

+

(Example: test_swag_labs.py in Demo Mode.)

```bash pytest test_swag_labs.py --demo @@ -62,19 +65,28 @@ pytest test_swag_labs.py --demo

SeleniumBase Demo Mode

--------- - -

Python Setup: 🐍

+

Python Setup:

πŸ”΅ 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] - +

Detailed Instructions:

@@ -925,6 +928,9 @@ pytest --reruns 5 --reruns-delay 1
Tested with SeleniumBase SeleniumBase.io Docs
+
SeleniumBase PyPI downloads +SeleniumBase Twitter followers
+

SeleniumBase on GitHub SeleniumBase on Gitter SeleniumBase on Twitter diff --git a/help_docs/ReadMe.md b/help_docs/ReadMe.md index 241946f1..1a076729 100755 --- a/help_docs/ReadMe.md +++ b/help_docs/ReadMe.md @@ -1,4 +1,4 @@ -
SeleniumBase
+
SeleniumBase

Help Docs

@@ -10,7 +10,7 @@ πŸ‘¨β€πŸ« Examples | πŸ“± Mobile
-πŸ”  Syntax Formats | +πŸ”‘ Syntax Formats | πŸ€– CI
πŸ“— API | diff --git a/help_docs/features_list.md b/help_docs/features_list.md index 9faf24ba..a78400c3 100755 --- a/help_docs/features_list.md +++ b/help_docs/features_list.md @@ -1,10 +1,10 @@ -[](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md) +[](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md) [](https://www.youtube.com/watch?v=Sjzq9kU5kOw)

(Watch the tutorial on YouTube)

-

β›² Features: πŸ—‚οΈ

+

β›² Features: πŸ—‚οΈ

* 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 @@

The 15 unique syntax formats

+

(Watch this tutorial on YouTube)

+ +[](https://www.youtube.com/watch?v=HOooW_0o468) + +-------- + SeleniumBase supports 15 different syntax formats for structuring tests. (The first 4 are the most common.)

1. BaseCase direct inheritance