# Vigilant Kit
**Vigilant** is a set of tools designed to help write and run robust functional tests using Selenium WebDriver. With
**Vigilant**, you can start writing complex test cases in a minute.
## Why Vigilant?
* **Easy to start & Fast To Write**: Vigilant provides you with methods that help you write functional tests quickly
without spending time on writing boilerplate code every time you start a new project.
* **No limit in usage**: You are not limited to a single testing framework; you can use Vigilant with **unittest**,
**pytest**, or for **scrapping data**. It's just a tool, use it as you want.
* **Stability**: We use Selenium WebDriver. It is a **W3C standard**.
- WebDriver drives a browser natively, as a user would, either locally or on a remote machine using the Selenium server.
- WebDriver is designed as a simple and more concise programming interface.
- WebDriver is a compact object-oriented API.
- It drives the browser effectively.
## What it includes?
Vigilant provide a suite of methods designed for efficient browser interaction, robust assertion of various
conditions, and adaptive waiting mechanisms to accommodate different states and conditions.
### **Interacting with WebBrowser**
- `click()` - click on element when it visible and scrolled in to the view;
- `scroll_to()` - easy scroll to the element when necessary;
- `fill_form()` - fill form with many fields without repetitive;
- `switch_to_window()` - work with multiply browser windows without any issues;
- ...
### **Assertions** - included!
Their names speak for themselves
- `see()`
- `dont_see()`
- `see_text()`
- `see_in_title()`
- ...
### **Waiters**
Waiting conditions are already here!
- `wait_for_element_to_be_visible()`
- `wait_for_element_to_be_clickable()`
- `wait_for_text_to_be_present_in_element()`
- `wait_for_element_to_disappear()`
- ...
And much more! Check list of all available - [Actions](docs/actions.md)
## Extending Functionality
If you need something that is not covered in this library, you still have access to all native `Selenium WebDriver`
methods. You can create your own methods or use native `WebDriver` methods and share them on one browser session.
## Install
```shell
pip install vigilant-kit
```
## Docs
### Configuration
- [Vigilant configuration](docs/configuration.md)
- [Adding custom browser options](docs/browser_options.md)
- [Using native selenium methods](docs/native_selenium.md)
### Examples & tutorials
- [Quick start example using `unittest` library](docs/vigilant_unittest.md)
- [Quick start example using `pytest`](docs/vigilant_pytest.md)
- [Testing ecommerce project using `vigilant-kit` and `pytest`](docs/tutorial_pytest.md)
### Actions
- [List of actions](docs/actions.md)
Raw data
{
"_id": null,
"home_page": "",
"name": "vigilant-kit",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "bdd,functional,functional-testing,pytest,selenium,tdd,testing,unittest,webdriver",
"author": "",
"author_email": "Pelykh Ivan <ivan.pelykh@protonmail.com>",
"download_url": "https://files.pythonhosted.org/packages/0b/ff/1323059f5ec814ecbb199797885e39e8c485d49b930fd21d720aed3fdc61/vigilant_kit-1.4.2.tar.gz",
"platform": null,
"description": "# Vigilant Kit\n**Vigilant** is a set of tools designed to help write and run robust functional tests using Selenium WebDriver. With \n**Vigilant**, you can start writing complex test cases in a minute.\n\n## Why Vigilant?\n* **Easy to start & Fast To Write**: Vigilant provides you with methods that help you write functional tests quickly \nwithout spending time on writing boilerplate code every time you start a new project.\n* **No limit in usage**: You are not limited to a single testing framework; you can use Vigilant with **unittest**,\n **pytest**, or for **scrapping data**. It's just a tool, use it as you want.\n* **Stability**: We use Selenium WebDriver. It is a **W3C standard**.\n - WebDriver drives a browser natively, as a user would, either locally or on a remote machine using the Selenium server.\n - WebDriver is designed as a simple and more concise programming interface.\n - WebDriver is a compact object-oriented API.\n - It drives the browser effectively.\n\n## What it includes?\nVigilant provide a suite of methods designed for efficient browser interaction, robust assertion of various \nconditions, and adaptive waiting mechanisms to accommodate different states and conditions.\n\n### **Interacting with WebBrowser** \n - `click()` - click on element when it visible and scrolled in to the view;\n - `scroll_to()` - easy scroll to the element when necessary;\n - `fill_form()` - fill form with many fields without repetitive;\n - `switch_to_window()` - work with multiply browser windows without any issues;\n - ...\n\n### **Assertions** - included! \n\nTheir names speak for themselves\n - `see()`\n - `dont_see()`\n - `see_text()`\n - `see_in_title()`\n - ...\n\n\n### **Waiters** \n\nWaiting conditions are already here!\n - `wait_for_element_to_be_visible()`\n - `wait_for_element_to_be_clickable()`\n - `wait_for_text_to_be_present_in_element()`\n - `wait_for_element_to_disappear()`\n - ...\n\nAnd much more! Check list of all available - [Actions](docs/actions.md)\n\n\n## Extending Functionality\nIf you need something that is not covered in this library, you still have access to all native `Selenium WebDriver` \nmethods. You can create your own methods or use native `WebDriver` methods and share them on one browser session.\n\n## Install\n```shell\npip install vigilant-kit\n```\n\n## Docs\n\n### Configuration\n- [Vigilant configuration](docs/configuration.md)\n- [Adding custom browser options](docs/browser_options.md)\n- [Using native selenium methods](docs/native_selenium.md)\n\n### Examples & tutorials\n- [Quick start example using `unittest` library](docs/vigilant_unittest.md) \n- [Quick start example using `pytest`](docs/vigilant_pytest.md) \n- [Testing ecommerce project using `vigilant-kit` and `pytest`](docs/tutorial_pytest.md)\n\n### Actions\n- [List of actions](docs/actions.md)\n",
"bugtrack_url": null,
"license": "",
"summary": "Library that makes functional testing with Selenium WebDriver fast and easy.",
"version": "1.4.2",
"project_urls": {
"Bug Tracker": "https://github.com/ivpel/vigilant/issues",
"Homepage": "https://github.com/ivpel/vigilant"
},
"split_keywords": [
"bdd",
"functional",
"functional-testing",
"pytest",
"selenium",
"tdd",
"testing",
"unittest",
"webdriver"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7e90da9905ee97e5ac26ea89b0fd4f9d6b7e9f0a468cb7e21275ecfbdfd8b060",
"md5": "95aaa84945231ddcfee6cde7a3587ae7",
"sha256": "bcf6b7a71a6268897a75e8a1f4956391dc340c1dc455c61e2101bad4ddb4badf"
},
"downloads": -1,
"filename": "vigilant_kit-1.4.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "95aaa84945231ddcfee6cde7a3587ae7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 22537,
"upload_time": "2024-03-10T19:10:04",
"upload_time_iso_8601": "2024-03-10T19:10:04.597332Z",
"url": "https://files.pythonhosted.org/packages/7e/90/da9905ee97e5ac26ea89b0fd4f9d6b7e9f0a468cb7e21275ecfbdfd8b060/vigilant_kit-1.4.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0bff1323059f5ec814ecbb199797885e39e8c485d49b930fd21d720aed3fdc61",
"md5": "34d090be9a7a18235b40911b09072bf8",
"sha256": "1ebc4af6d0b09228db511339779a59e540c06d0e94436c9b2571fdeaf83f4161"
},
"downloads": -1,
"filename": "vigilant_kit-1.4.2.tar.gz",
"has_sig": false,
"md5_digest": "34d090be9a7a18235b40911b09072bf8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 34858,
"upload_time": "2024-03-10T19:10:08",
"upload_time_iso_8601": "2024-03-10T19:10:08.718654Z",
"url": "https://files.pythonhosted.org/packages/0b/ff/1323059f5ec814ecbb199797885e39e8c485d49b930fd21d720aed3fdc61/vigilant_kit-1.4.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-10 19:10:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ivpel",
"github_project": "vigilant",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "vigilant-kit"
}
JSON
