# TestFlows.com Open-Source Software Testing Framework
## Introduction
[TestFlows.com Open-Source Software Testing Framework] is a **flow** oriented test framework that can be used for functional,
integration, acceptance and unit testing. It uses **everything is a test** approach
with the focus on providing test designers flexibility in writing and running their tests.
## Documentation
You can find [TestFlows.com Open-Source Software Testing Framework]'s documentation at https://testflows.com.
## Supported environment
* [Ubuntu] 20.04
* [Python 3] >= 3.8
## Installation
You can install [TestFlows.com Open-Source Software Testing Framework] using [pip3]
```bash
$ pip3 install testflows
```
or from sources
```bash
$ git clone https://github.com/testflows/TestFlows.git
$ cd TestFlows
$ ./package && ./install
```
## Styles
[TestFlows.com Open-Source Software Testing Framework] supports defining tests using either the traditional keywords
* **Module**, **Suite**, **Test**, and **Step**
or using keywords such as
* **Module**, **Feature**, **Scenario**, **Given**, **When**, **Then**, **But**, **And**, **By** and **Finally**
## Hello TestFlows
An inline test scenario can be defined as follows
```python
from testflows.core import Scenario
with Scenario("Hello TestFlows!"):
pass
```
then just run it using `python3` command
```bash
$ python3 ./test.py
Jul 12,2020 14:30:20 ⟥ Scenario Hello TestFlows!
1ms ⟥⟤ OK Hello TestFlows!, /Hello TestFlows!
Passing
✔ [ OK ] /Hello TestFlows!
1 scenario (1 ok)
Total time 2ms
Executed on Jul 12,2020 14:30
TestFlows.com Open-Source Software Testing Framework v1.6.200712.1132037
```
## Want to know more?
Find more information about [TestFlows.com Open-Source Software Testing Framework] at https://testflows.com.
Join our channel on [Telegram].
[TestFlows.com Open-Source Software Testing Framework]: https://testflows.com
[Telegram]: https://telegram.me/testflows
[pip3]: https://github.com/pypa/pip
[Python 3]: https://www.python.org/
[Ubuntu]: https://ubuntu.com/
Raw data
{
"_id": null,
"home_page": "https://github.com/testflows/testflows",
"name": "testflows",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "Vitaliy Zakaznikov",
"author_email": "vzakaznikov@testflows.com",
"download_url": "https://files.pythonhosted.org/packages/08/80/9aafa73aa821b251a7cd9ba435ff1b03fa94e2b9be24123a446d8f2f5153/testflows-2.3.0.tar.gz",
"platform": null,
"description": "# TestFlows.com Open-Source Software Testing Framework\n\n\n\n## Introduction\n\n[TestFlows.com Open-Source Software Testing Framework] is a **flow** oriented test framework that can be used for functional,\nintegration, acceptance and unit testing. It uses **everything is a test** approach\nwith the focus on providing test designers flexibility in writing and running their tests.\n\n## Documentation\n\nYou can find [TestFlows.com Open-Source Software Testing Framework]'s documentation at https://testflows.com.\n\n## Supported environment\n\n* [Ubuntu] 20.04\n* [Python 3] >= 3.8\n\n## Installation\n\nYou can install [TestFlows.com Open-Source Software Testing Framework] using [pip3]\n\n```bash\n$ pip3 install testflows\n```\n\nor from sources\n\n```bash\n$ git clone https://github.com/testflows/TestFlows.git\n$ cd TestFlows\n$ ./package && ./install\n```\n\n## Styles\n\n[TestFlows.com Open-Source Software Testing Framework] supports defining tests using either the traditional keywords\n\n* **Module**, **Suite**, **Test**, and **Step**\n\nor using keywords such as\n\n* **Module**, **Feature**, **Scenario**, **Given**, **When**, **Then**, **But**, **And**, **By** and **Finally**\n\n## Hello TestFlows\n\nAn inline test scenario can be defined as follows\n\n```python\nfrom testflows.core import Scenario\n\nwith Scenario(\"Hello TestFlows!\"):\n pass\n```\n\nthen just run it using `python3` command\n\n```bash\n$ python3 ./test.py \nJul 12,2020 14:30:20 \u27e5 Scenario Hello TestFlows!\n 1ms \u27e5\u27e4 OK Hello TestFlows!, /Hello TestFlows!\n\nPassing\n\n\u2714 [ OK ] /Hello TestFlows!\n\n1 scenario (1 ok)\n\nTotal time 2ms\n\nExecuted on Jul 12,2020 14:30\nTestFlows.com Open-Source Software Testing Framework v1.6.200712.1132037\n```\n\n## Want to know more?\n\nFind more information about [TestFlows.com Open-Source Software Testing Framework] at https://testflows.com. \nJoin our channel on [Telegram].\n\n[TestFlows.com Open-Source Software Testing Framework]: https://testflows.com\n[Telegram]: https://telegram.me/testflows\n[pip3]: https://github.com/pypa/pip\n[Python 3]: https://www.python.org/\n[Ubuntu]: https://ubuntu.com/ \n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "TestFlows.com Open-Source Software Testing Framework",
"version": "2.3.0",
"project_urls": {
"Homepage": "https://github.com/testflows/testflows"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "08809aafa73aa821b251a7cd9ba435ff1b03fa94e2b9be24123a446d8f2f5153",
"md5": "4351f50026a15f9a3fa28f0f9787e9e7",
"sha256": "1cc6d95884f96c7c821fb4fd2b066c9373a29c6fab89f97bebc359191d4b3b37"
},
"downloads": -1,
"filename": "testflows-2.3.0.tar.gz",
"has_sig": false,
"md5_digest": "4351f50026a15f9a3fa28f0f9787e9e7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 10354,
"upload_time": "2024-03-06T13:38:12",
"upload_time_iso_8601": "2024-03-06T13:38:12.237278Z",
"url": "https://files.pythonhosted.org/packages/08/80/9aafa73aa821b251a7cd9ba435ff1b03fa94e2b9be24123a446d8f2f5153/testflows-2.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-06 13:38:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "testflows",
"github_project": "testflows",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "testflows"
}
JSON
