| Name | bepatient JSON |
| Version |
0.12.0
JSON |
| download |
| home_page | None |
| Summary | A library facilitating work with asynchronous APIs |
| upload_time | 2024-10-11 19:21:12 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | MIT License Copyright (c) 2023 Dawid Szaniawski Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
api
async
api_testing
automation
json
testing
web
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://github.com/dawid-szaniawski/bepatient/actions/workflows/tox.yml)
[](https://pypi.org/project/bepatient/)
[](https://pypi.org/project/bepatient/)
[](https://github.com/dawid-szaniawski/bepatient/blob/master/LICENSE)
[](https://github.com/psf/black)
[](https://github.com/astral-sh/ruff)
[](https://codecov.io/github/dawid-szaniawski/bepatient)
[](https://www.codefactor.io/repository/github/dawid-szaniawski/bepatient)
# Be Patient
_bepatient_ is a library aimed at facilitating work with asynchronous applications. It
allows for the repeated execution of specific actions until the desired effect is
achieved.
## Features
- Set up and monitor requests for expected values.
- Flexible comparison using various checkers and comparers.
- Configure multiple conditions to be met by response.
- Inspect various aspects of the response (body, status code, headers).
- Detailed logs, facilitating the analysis of the test process.
- Retry mechanism with customizable retries and delay.
## Installation
To install _bepatient_, you can use pip:
```bash
pip install bepatient
```
_bepatient_ supports Python 3.10+
## Basic Usage
Using RequestsWaiter object:
```python
from requests import get
from bepatient import RequestsWaiter
waiter = RequestsWaiter(request=get("https://example.com/api"))
waiter.add_checker(comparer="contain", expected_value="string")
waiter.run()
response = waiter.get_result()
assert response.status_code == 200
```
Simple way:
```python
from requests import get
from bepatient import wait_for_value_in_request
response = wait_for_value_in_request(
request=get("https://example.com/api"),
comparer="contain",
expected_value="string"
)
assert response.status_code == 200
```
If we need add more than one checker:
```python
from requests import get
from bepatient import wait_for_values_in_request
list_of_checkers = [
{
"checker": "json_checker",
"comparer": "contain",
"expected_value": "string"
},
{
"checker": "headers_checker",
"comparer": "is_equal",
"expected_value": "cloudflare",
"dict_path": "Server",
},
]
response = wait_for_values_in_request(
request=get("https://example.com/api"),
checkers=list_of_checkers,
retries=5,
)
assert response.status_code == 200
```
## License
MIT License
Copyright (c) 2023-2024 Dawid Szaniawski
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Raw data
{
"_id": null,
"home_page": null,
"name": "bepatient",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "api, async, api_testing, automation, json, testing, web",
"author": null,
"author_email": "Dawid Szaniawski <dszaniawski@webludus.pl>",
"download_url": "https://files.pythonhosted.org/packages/b0/ae/7133133e69b52f4cd347bfc51f529899e01c5a3dde1e80bf723dfde1518a/bepatient-0.12.0.tar.gz",
"platform": null,
"description": "[](https://github.com/dawid-szaniawski/bepatient/actions/workflows/tox.yml)\n[](https://pypi.org/project/bepatient/)\n[](https://pypi.org/project/bepatient/)\n[](https://github.com/dawid-szaniawski/bepatient/blob/master/LICENSE)\n[](https://github.com/psf/black)\n[](https://github.com/astral-sh/ruff)\n[](https://codecov.io/github/dawid-szaniawski/bepatient)\n[](https://www.codefactor.io/repository/github/dawid-szaniawski/bepatient)\n\n# Be Patient\n\n_bepatient_ is a library aimed at facilitating work with asynchronous applications. It\nallows for the repeated execution of specific actions until the desired effect is\nachieved.\n\n## Features\n\n- Set up and monitor requests for expected values.\n- Flexible comparison using various checkers and comparers.\n- Configure multiple conditions to be met by response.\n- Inspect various aspects of the response (body, status code, headers).\n- Detailed logs, facilitating the analysis of the test process.\n- Retry mechanism with customizable retries and delay.\n\n## Installation\n\nTo install _bepatient_, you can use pip:\n\n```bash\npip install bepatient\n```\n\n_bepatient_ supports Python 3.10+\n\n## Basic Usage\n\nUsing RequestsWaiter object:\n\n```python\nfrom requests import get\n\nfrom bepatient import RequestsWaiter\n\nwaiter = RequestsWaiter(request=get(\"https://example.com/api\"))\nwaiter.add_checker(comparer=\"contain\", expected_value=\"string\")\nwaiter.run()\n\nresponse = waiter.get_result()\n\nassert response.status_code == 200\n```\n\nSimple way:\n\n```python\nfrom requests import get\n\nfrom bepatient import wait_for_value_in_request\n\nresponse = wait_for_value_in_request(\n request=get(\"https://example.com/api\"),\n comparer=\"contain\",\n expected_value=\"string\"\n)\nassert response.status_code == 200\n```\n\nIf we need add more than one checker:\n\n```python\nfrom requests import get\n\nfrom bepatient import wait_for_values_in_request\n\nlist_of_checkers = [\n {\n \"checker\": \"json_checker\",\n \"comparer\": \"contain\",\n \"expected_value\": \"string\"\n },\n {\n \"checker\": \"headers_checker\",\n \"comparer\": \"is_equal\",\n \"expected_value\": \"cloudflare\",\n \"dict_path\": \"Server\",\n },\n]\nresponse = wait_for_values_in_request(\n request=get(\"https://example.com/api\"),\n checkers=list_of_checkers,\n retries=5,\n)\nassert response.status_code == 200\n```\n\n## License\n\nMIT License\n\nCopyright (c) 2023-2024 Dawid Szaniawski\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Dawid Szaniawski Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "A library facilitating work with asynchronous APIs",
"version": "0.12.0",
"project_urls": {
"Documentation": "https://bepatient.webludus.pl/",
"Homepage": "https://webludus.pl/en",
"Source": "https://github.com/dawid-szaniawski/bepatient"
},
"split_keywords": [
"api",
" async",
" api_testing",
" automation",
" json",
" testing",
" web"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f6f89d0ffda80383e8df75d967eb6b82b554ab309b8561f659ea826c8d6ff3f4",
"md5": "59caff67b76dfae8e719af08d7439546",
"sha256": "a19b5d376a93689630a76f636f359265280626bcb833d95bf2b3e25acc25d45d"
},
"downloads": -1,
"filename": "bepatient-0.12.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "59caff67b76dfae8e719af08d7439546",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 16680,
"upload_time": "2024-10-11T19:21:11",
"upload_time_iso_8601": "2024-10-11T19:21:11.027199Z",
"url": "https://files.pythonhosted.org/packages/f6/f8/9d0ffda80383e8df75d967eb6b82b554ab309b8561f659ea826c8d6ff3f4/bepatient-0.12.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b0ae7133133e69b52f4cd347bfc51f529899e01c5a3dde1e80bf723dfde1518a",
"md5": "80ac35444e7535edbccd4f5d0261bf98",
"sha256": "0480419af809dc5604c67134e34ff96c5ad597ec8c4b76033df9b4b0b065e0b9"
},
"downloads": -1,
"filename": "bepatient-0.12.0.tar.gz",
"has_sig": false,
"md5_digest": "80ac35444e7535edbccd4f5d0261bf98",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 19339,
"upload_time": "2024-10-11T19:21:12",
"upload_time_iso_8601": "2024-10-11T19:21:12.669925Z",
"url": "https://files.pythonhosted.org/packages/b0/ae/7133133e69b52f4cd347bfc51f529899e01c5a3dde1e80bf723dfde1518a/bepatient-0.12.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-11 19:21:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dawid-szaniawski",
"github_project": "bepatient",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "bepatient"
}
