# 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**: All methods for interaction, waiting different conditions and asserting the results
are already here.
* **No limits**: You are not limited to a single testing framework, use Vigilant with **unittest**,
**pytest**, or for **scrapping data**.
* **Stability**: We use Selenium WebDriver. It is a **W3C standard**.
## What included?
_Wait for condition, Act by Interaction, Assert the result._
### **Actions**
- `click()`
- `scroll_to()`
- `fill_form()`
- `switch_to_window()`
- ...
### **Waiters for condition**
- `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()`
- ...
### **Assertions**
- `see()`
- `dont_see()`
- `see_text()`
- `see_in_title()`
- ...
### **Scrappers**
Minimal required methods for scrapping some data:
- `get_text_from_element()`
- `get_attribute_from_element()`
- `get_cookie()`
- `save_data_to_txt()`
### **Test PDF**
You're testing some eCommerce project, and you need to check your PDF invoice file? No problem!
- `find_pdf_file()`,
- `assert_strings_in_pdf()`,
- `assert_strings_not_in_pdf()`,
- `find_file_and_assert_strings_are_in()`,
- ...
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": null,
"name": "vigilant-kit",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "bdd, functional, functional-testing, pytest, selenium, tdd, testing, unittest, webdriver",
"author": null,
"author_email": "Pelykh Ivan <ivan.pelykh@protonmail.com>",
"download_url": "https://files.pythonhosted.org/packages/5d/b7/c43a95cd105298ef90c538a530b87a9dfd48d0810d0f705abca4af5c0a65/vigilant_kit-1.4.6.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**: All methods for interaction, waiting different conditions and asserting the results\nare already here.\n* **No limits**: You are not limited to a single testing framework, use Vigilant with **unittest**,\n **pytest**, or for **scrapping data**. \n* **Stability**: We use Selenium WebDriver. It is a **W3C standard**.\n\n\n## What included?\n_Wait for condition, Act by Interaction, Assert the result._\n\n\n### **Actions** \n - `click()`\n - `scroll_to()`\n - `fill_form()`\n - `switch_to_window()`\n - ...\n\n### **Waiters for condition** \n\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\n### **Assertions** \n\n - `see()`\n - `dont_see()`\n - `see_text()`\n - `see_in_title()`\n - ...\n\n\n\n\n### **Scrappers**\nMinimal required methods for scrapping some data:\n - `get_text_from_element()`\n - `get_attribute_from_element()`\n - `get_cookie()`\n - `save_data_to_txt()`\n\n### **Test PDF**\nYou're testing some eCommerce project, and you need to check your PDF invoice file? No problem!\n - `find_pdf_file()`,\n - `assert_strings_in_pdf()`,\n - `assert_strings_not_in_pdf()`,\n - `find_file_and_assert_strings_are_in()`,\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": null,
"summary": "Library that makes functional testing with Selenium WebDriver fast and easy.",
"version": "1.4.6",
"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": "7e0fbfe3472a517b8f7667090563001e6dff39f37fbcf19400510e31100649c6",
"md5": "e5ef54aa7ab3b86fa6d905dc951c5f7c",
"sha256": "9e6edb1d76e74b229d2d15f248aed8a80f716d2f296966192b430025ca0f4a16"
},
"downloads": -1,
"filename": "vigilant_kit-1.4.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e5ef54aa7ab3b86fa6d905dc951c5f7c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 24642,
"upload_time": "2024-08-18T09:53:48",
"upload_time_iso_8601": "2024-08-18T09:53:48.769838Z",
"url": "https://files.pythonhosted.org/packages/7e/0f/bfe3472a517b8f7667090563001e6dff39f37fbcf19400510e31100649c6/vigilant_kit-1.4.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5db7c43a95cd105298ef90c538a530b87a9dfd48d0810d0f705abca4af5c0a65",
"md5": "ae1c5ceb1d8c4ac64e15f7b3ed1c4438",
"sha256": "cc2ed60f9bf0391231c67e63fe2c0870f7610d67ea1ee9f8cb9154bd5b591b7c"
},
"downloads": -1,
"filename": "vigilant_kit-1.4.6.tar.gz",
"has_sig": false,
"md5_digest": "ae1c5ceb1d8c4ac64e15f7b3ed1c4438",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 36901,
"upload_time": "2024-08-18T09:53:50",
"upload_time_iso_8601": "2024-08-18T09:53:50.934140Z",
"url": "https://files.pythonhosted.org/packages/5d/b7/c43a95cd105298ef90c538a530b87a9dfd48d0810d0f705abca4af5c0a65/vigilant_kit-1.4.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-18 09:53:50",
"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
