Update the documentation
This commit is contained in:
Michael Mintz
parent
e79fa421c9
commit
6d696ca7f2
24
README.md
24
README.md
|
|
@ -5,21 +5,23 @@
|
|||
<meta property="og:image" content="https://seleniumbase.io/cdn/img/mac_sb_logo_5.png" />
|
||||
<link rel="icon" href="https://seleniumbase.io/img/green_logo2.png" />
|
||||
|
||||
<p align="center"><img src="https://seleniumbase.io/cdn/img/mac_sb_banner_t.png" alt="SeleniumBase" title="SeleniumBase" width="600" /></p>
|
||||
|
||||
<p align="center"><b>Reliable web automation and testing with Python/pytest.</b></p>
|
||||
<p align="center"><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.io/cdn/img/fancy_logo_14.png" alt="SeleniumBase" width="300" /></a></p>
|
||||
<p align="center"><b>A complete end-to-end testing experience.</b></p>
|
||||
<p align="center">Extends <a href="https://www.w3.org/TR/webdriver/">Selenium/WebDriver</a> and <a href="https://docs.pytest.org/en/latest/index.html">pytest</a>.</p>
|
||||
|
||||
<p align="center"><a href="https://pypi.python.org/pypi/seleniumbase" target="_blank"><img src="https://img.shields.io/pypi/v/seleniumbase.svg?color=2288EE" alt="PyPI version" /></a> <a href="https://github.com/seleniumbase/SeleniumBase/releases" target="_blank"><img src="https://img.shields.io/github/v/release/seleniumbase/SeleniumBase.svg?color=22AAEE" alt="GitHub version" /></a> <a href="https://seleniumbase.io"><img src="https://img.shields.io/badge/docs-seleniumbase.io-11BBAA.svg" alt="SeleniumBase Docs" /></a> <a href="https://github.com/seleniumbase/SeleniumBase/actions" target="_blank"><img src="https://github.com/seleniumbase/SeleniumBase/workflows/CI%20build/badge.svg" alt="SeleniumBase GitHub Actions" /></a> <a href="https://gitter.im/seleniumbase/SeleniumBase" target="_blank"><img src="https://badges.gitter.im/seleniumbase/SeleniumBase.svg" alt="SeleniumBase" /></a></p>
|
||||
|
||||
<p><b>SeleniumBase</b> is an all-in-one framework for reliable browser automation, end-to-end testing, reports, charts, presentations, and website tours. Tests are run with <b>pytest</b>. Browsers are controlled by <b>WebDriver</b>.</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="#python_installation">🚀 Start</a> |
|
||||
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/features_list.md">🗂️ Features</a> |
|
||||
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/ReadMe.md">👩🏫 Examples</a> |
|
||||
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/customizing_test_runs.md">🖥️ Options</a> |
|
||||
<a href="#python_installation">🐣 Start</a> |
|
||||
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/features_list.md">🏞️ Features</a> |
|
||||
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/ReadMe.md">👨🏫 Examples</a> |
|
||||
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/customizing_test_runs.md">☑️ Options</a> |
|
||||
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/console_scripts/ReadMe.md">🧙 Scripts</a> |
|
||||
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/mobile_testing.md">📱 Mobile</a>
|
||||
<br />
|
||||
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/method_summary.md">📗 API</a> |
|
||||
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/method_summary.md">📒 API</a> |
|
||||
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/syntax_formats.md">🔠 Syntaxes</a> |
|
||||
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/example_logs/ReadMe.md">🔵 Dashboard</a> |
|
||||
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/recorder_mode.md">🔴 Recorder</a> |
|
||||
|
|
@ -28,17 +30,17 @@
|
|||
<br />
|
||||
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/commander.md">🎖️ GUI</a> |
|
||||
<a href="https://seleniumbase.io/demo_page">📰 TestPage</a> |
|
||||
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/translations.md">🌏 Translator</a> |
|
||||
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/translations.md">🈺 Translator</a> |
|
||||
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/presenter/ReadMe.md">🎞️ Presenter</a> |
|
||||
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/chart_maker/ReadMe.md">📊 Charts</a> |
|
||||
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/tour_examples/ReadMe.md">🗺️ Tours</a>
|
||||
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/tour_examples/ReadMe.md">🚎 Tours</a>
|
||||
<br />
|
||||
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/github/workflows/ReadMe.md">🤖 CI</a> |
|
||||
<a href="https://github.com/seleniumbase/SeleniumBase/tree/master/examples/boilerplates">♻️ Boilerplates</a> |
|
||||
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/html_inspector.md">🔎 Inspector</a> |
|
||||
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/js_package_manager.md">🕹️ JSCode</a> |
|
||||
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/dialog_boxes/ReadMe.md">🛂 Dialogs</a> |
|
||||
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/visual_testing/ReadMe.md">🖼️ Visual</a>
|
||||
<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/visual_testing/ReadMe.md">🎭 Visual</a>
|
||||
</p>
|
||||
|
||||
--------
|
||||
|
|
|
|||
|
|
@ -1,21 +1,46 @@
|
|||
<h3 align="left"><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.io/cdn/img/super_logo_m.png" title="SeleniumBase" width="300" /></a></h3>
|
||||
|
||||
<a id="language_tests"></a>
|
||||
<h3><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32" /> Language Tests (Python 3+)</h3>
|
||||
<h2>🌏 Translated Tests 🈺</h2>
|
||||
|
||||
<b>SeleniumBase</b> supports the following 10 languages: <i>English</i>, <i>Chinese</i>, <i>Dutch</i>, <i>French</i>, <i>Italian</i>, <i>Japanese</i>, <i>Korean</i>, <i>Portuguese</i>, <i>Russian</i>, and <i>Spanish</i>.
|
||||
<b>SeleniumBase</b> supports the following 10 languages: <i>English</i>, <i>Chinese</i>, <i>Dutch</i>, <i>French</i>, <i>Italian</i>, <i>Japanese</i>, <i>Korean</i>, <i>Portuguese</i>, <i>Russian</i>, and <i>Spanish</i>. (Examples can be found in [<a href="https://github.com/seleniumbase/SeleniumBase/tree/master/examples/translations">SeleniumBase/examples/translations</a>])
|
||||
|
||||
Examples can be found in [<a href="https://github.com/seleniumbase/SeleniumBase/tree/master/examples/translations">SeleniumBase/examples/translations</a>].
|
||||
Multi-language tests run with **pytest** like other tests. Test methods have a one-to-one mapping to supported languages. Here's an example of a translated test:
|
||||
|
||||
Multi-language tests are run with **pytest** like any other test. Every test method has a one-to-one mapping to every other supported language. <i>Example:</i>
|
||||
```python
|
||||
# Chinese Translation
|
||||
from seleniumbase.translate.chinese import 硒测试用例
|
||||
|
||||
class 我的测试类(硒测试用例):
|
||||
def test_例子1(self):
|
||||
self.开启("https://zh.wikipedia.org/wiki/")
|
||||
self.断言标题("维基百科，自由的百科全书")
|
||||
self.断言元素('a[title="首页"]')
|
||||
self.断言文本("新闻动态", "span#新闻动态")
|
||||
self.输入文本("#searchInput", "舞龍")
|
||||
self.单击("#searchButton")
|
||||
self.断言文本("舞龍", "#firstHeading")
|
||||
```
|
||||
self.open(URL) <=> self.开启网址(URL)
|
||||
|
||||
Here's another example:
|
||||
|
||||
```python
|
||||
# Japanese Translation
|
||||
from seleniumbase.translate.japanese import セレニウムテストケース
|
||||
|
||||
class 私のテストクラス(セレニウムテストケース):
|
||||
def test_例1(self):
|
||||
self.を開く("https://ja.wikipedia.org/wiki/")
|
||||
self.テキストを確認する("ウィキペディア")
|
||||
self.要素を確認する('[title="メインページに移動する"]')
|
||||
self.入力("#searchInput", "アニメ")
|
||||
self.クリックして("#searchButton")
|
||||
self.テキストを確認する("アニメ", "#firstHeading")
|
||||
self.入力("#searchInput", "寿司")
|
||||
```
|
||||
|
||||
<a id="translation_api"></a>
|
||||
<h2><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32" /> Translation API</h2>
|
||||
<h2><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32" /> Translation API 🈺</h2>
|
||||
|
||||
You can use SeleniumBase to selectively translate the method names of any test from one language to another via the console scripts interface. Additionally, the ``import`` line at the top of the Python file will change to import the new ``BaseCase``. Example: ``BaseCase`` becomes ``CasoDeTeste`` when a test is translated into Portuguese.
|
||||
You can use SeleniumBase to selectively translate the method names of any test from one language to another with the console scripts interface. Additionally, the ``import`` line at the top of the Python file will change to import the new ``BaseCase``. Example: ``BaseCase`` becomes ``CasoDeTeste`` when a test is translated into Portuguese.
|
||||
|
||||
```bash
|
||||
seleniumbase translate
|
||||
|
|
@ -59,3 +84,7 @@ plus the 2-letter language code of the new language.
|
|||
(Example: Translating ``test_1.py`` into Japanese with
|
||||
``-c`` will create a new file called ``test_1_ja.py``.)
|
||||
```
|
||||
|
||||
--------
|
||||
|
||||
<h3 align="left"><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.io/cdn/img/super_logo_m.png" title="SeleniumBase" width="280" /></a></h3>
|
||||
|
|
|
|||
|
|
@ -1,15 +1,12 @@
|
|||
<h3 align="left"><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.io/cdn/img/mac_sb_logo_3.png" title="SeleniumBase" width="310" /></a></h3>
|
||||
|
||||
<a id="language_tests"></a>
|
||||
<h3>🌏 Language Tests & Translation API</h3>
|
||||
<h2>🌏 Translated Tests 🈺</h2>
|
||||
|
||||
<b>SeleniumBase</b> supports the following 10 languages: <i>English</i>, <i>Chinese</i>, <i>Dutch</i>, <i>French</i>, <i>Italian</i>, <i>Japanese</i>, <i>Korean</i>, <i>Portuguese</i>, <i>Russian</i>, and <i>Spanish</i>.
|
||||
<b>SeleniumBase</b> supports the following 10 languages: <i>English</i>, <i>Chinese</i>, <i>Dutch</i>, <i>French</i>, <i>Italian</i>, <i>Japanese</i>, <i>Korean</i>, <i>Portuguese</i>, <i>Russian</i>, and <i>Spanish</i>. (Examples can be found in [<a href="https://github.com/seleniumbase/SeleniumBase/tree/master/examples/translations">SeleniumBase/examples/translations</a>])
|
||||
|
||||
Examples can be found in [<a href="https://github.com/seleniumbase/SeleniumBase/tree/master/examples/translations">SeleniumBase/examples/translations</a>].
|
||||
|
||||
Multi-language tests are run with **pytest** like any other test. Test methods have a one-to-one mapping to the other supported languages. Here's an example of a translated test:
|
||||
Multi-language tests run with **pytest** like other tests. Test methods have a one-to-one mapping to supported languages. Here's an example of a translated test:
|
||||
|
||||
```python
|
||||
# Chinese Translation
|
||||
from seleniumbase.translate.chinese import 硒测试用例
|
||||
|
||||
class 我的测试类(硒测试用例):
|
||||
|
|
@ -23,8 +20,25 @@ class 我的测试类(硒测试用例):
|
|||
self.断言文本("舞龍", "#firstHeading")
|
||||
```
|
||||
|
||||
Here's another example:
|
||||
|
||||
```python
|
||||
# Japanese Translation
|
||||
from seleniumbase.translate.japanese import セレニウムテストケース
|
||||
|
||||
class 私のテストクラス(セレニウムテストケース):
|
||||
def test_例1(self):
|
||||
self.を開く("https://ja.wikipedia.org/wiki/")
|
||||
self.テキストを確認する("ウィキペディア")
|
||||
self.要素を確認する('[title="メインページに移動する"]')
|
||||
self.入力("#searchInput", "アニメ")
|
||||
self.クリックして("#searchButton")
|
||||
self.テキストを確認する("アニメ", "#firstHeading")
|
||||
self.入力("#searchInput", "寿司")
|
||||
```
|
||||
|
||||
<a id="translation_api"></a>
|
||||
<h2><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32" /> Translation API</h2>
|
||||
<h2><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32" /> Translation API 🈺</h2>
|
||||
|
||||
You can use SeleniumBase to selectively translate the method names of any test from one language to another with the console scripts interface. Additionally, the ``import`` line at the top of the Python file will change to import the new ``BaseCase``. Example: ``BaseCase`` becomes ``CasoDeTeste`` when a test is translated into Portuguese.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue