Name | abstract-test-package JSON |
Version |
0.0.4
JSON |
| download |
home_page | https://github.com/AbstractEndeavors/abstract_test_package |
Summary | abstract_test_package is a Python package that facilitates testing with abstract scenarios. Utilizing PyTest, it offers extra utilities to streamline the creation and execution of abstract tests. |
upload_time | 2023-05-31 01:36:56 |
maintainer | |
docs_url | None |
author | putkoff |
requires_python | >=3.6 |
license | |
keywords |
|
VCS |
|
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
# abstract_test_package
This is a Python package that facilitates testing with abstract scenarios. Utilizing PyTest, it offers extra utilities to streamline the creation and execution of abstract tests.
You can locate this package in the `abstract_essentials` project at `github.io/abstract_endeavors/abstract_essentials/abstract_test_package/`.
## Installation
You can install the `abstract_test_package` module via pip:
```sh
pip install abstract_test_package
```
Or directly from the source:
```sh
git clone https://github.io/abstract_endeavors/abstract_essentials/abstract_test_package/
cd abstract_test_package
python setup.py install
```
## Usage
Below is a usage example of the `abstract_test_package`:
```python
from abstract_test_package import create_test, execute_test
test = create_test(name="Test 1", scenario=[...])
execute_test(test)
```
This example creates an abstract test and then executes it.
## Documentation
The `abstract_test_package` module provides the following classes and functions:
### `create_test(name: str = 'Test', scenario: list = [...])`
Generates an abstract test scenario with the provided name and details.
### `execute_test(test: any)`
Executes the given abstract test scenario.
### `validate_test(test: any) -> bool`
Verifies if the given object is a valid test scenario.
### `calculate_test_results(test: any) -> dict`
Calculates the results of a given abstract test scenario.
### `compare_test_results(test1: any, test2: any) -> bool`
Compares two test scenarios and returns True if their results are equivalent, False otherwise.
... and many more!
Please refer to the source code for the complete list of classes and functions provided by the module, as well as their detailed documentation.
## Contributing
Contributions are welcome! Please fork this repository and open a pull request to add snippets, make grammar tweaks, etc.
## Contact
If you have any questions, feel free to reach out to us at partners@abstractendeavors.com.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
## Authors
* putkoff - main developer
This README file was last updated on May 29, 2023.
Raw data
{
"_id": null,
"home_page": "https://github.com/AbstractEndeavors/abstract_test_package",
"name": "abstract-test-package",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "putkoff",
"author_email": "partners@abstractendeavors.com",
"download_url": "https://files.pythonhosted.org/packages/2a/00/d8377e4f0faac385ccf9a4b2533a7f60cd89a5d02af5a5a9655cde84bb04/abstract_test_package-0.0.4.tar.gz",
"platform": null,
"description": "# abstract_test_package\n\nThis is a Python package that facilitates testing with abstract scenarios. Utilizing PyTest, it offers extra utilities to streamline the creation and execution of abstract tests.\n\nYou can locate this package in the `abstract_essentials` project at `github.io/abstract_endeavors/abstract_essentials/abstract_test_package/`.\n\n## Installation\n\nYou can install the `abstract_test_package` module via pip:\n\n```sh\npip install abstract_test_package\n```\n\nOr directly from the source:\n\n```sh\ngit clone https://github.io/abstract_endeavors/abstract_essentials/abstract_test_package/\ncd abstract_test_package\npython setup.py install\n```\n\n## Usage\n\nBelow is a usage example of the `abstract_test_package`:\n\n```python\nfrom abstract_test_package import create_test, execute_test\n\ntest = create_test(name=\"Test 1\", scenario=[...])\nexecute_test(test)\n```\n\nThis example creates an abstract test and then executes it.\n\n## Documentation\n\nThe `abstract_test_package` module provides the following classes and functions:\n\n### `create_test(name: str = 'Test', scenario: list = [...])`\n\nGenerates an abstract test scenario with the provided name and details.\n\n### `execute_test(test: any)`\n\nExecutes the given abstract test scenario.\n\n### `validate_test(test: any) -> bool`\n\nVerifies if the given object is a valid test scenario.\n\n### `calculate_test_results(test: any) -> dict`\n\nCalculates the results of a given abstract test scenario.\n\n### `compare_test_results(test1: any, test2: any) -> bool`\n\nCompares two test scenarios and returns True if their results are equivalent, False otherwise.\n\n... and many more!\n\nPlease refer to the source code for the complete list of classes and functions provided by the module, as well as their detailed documentation.\n\n## Contributing\n\nContributions are welcome! Please fork this repository and open a pull request to add snippets, make grammar tweaks, etc.\n\n## Contact\n\nIf you have any questions, feel free to reach out to us at partners@abstractendeavors.com.\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n\n## Authors\n\n* putkoff - main developer\n\nThis README file was last updated on May 29, 2023.\n",
"bugtrack_url": null,
"license": "",
"summary": "abstract_test_package is a Python package that facilitates testing with abstract scenarios. Utilizing PyTest, it offers extra utilities to streamline the creation and execution of abstract tests.",
"version": "0.0.4",
"project_urls": {
"Homepage": "https://github.com/AbstractEndeavors/abstract_test_package"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b8971b6a3ff392a0a2d81d060c87a7f81b3cf5d3bfcaffa39a2f611c34927988",
"md5": "40d16e815573c8a918291a6ab887897f",
"sha256": "f571f582d1be000bf522d4f1084fe6a4acc69a367ff55463bcc802ba1cd081ae"
},
"downloads": -1,
"filename": "abstract_test_package-0.0.4-py3.11.egg",
"has_sig": false,
"md5_digest": "40d16e815573c8a918291a6ab887897f",
"packagetype": "bdist_egg",
"python_version": "0.0.4",
"requires_python": ">=3.6",
"size": 7402,
"upload_time": "2023-05-31T01:36:54",
"upload_time_iso_8601": "2023-05-31T01:36:54.636192Z",
"url": "https://files.pythonhosted.org/packages/b8/97/1b6a3ff392a0a2d81d060c87a7f81b3cf5d3bfcaffa39a2f611c34927988/abstract_test_package-0.0.4-py3.11.egg",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "89bd7a3e31744763089ab0a8f209590416a52f43814d576ba81670cef73ea287",
"md5": "4f2bf53b0f9153b3d6ce02d265d3b56e",
"sha256": "47f909935907943ea1a18a1fe4f670bff189a3335932ebf84929587ccedc0047"
},
"downloads": -1,
"filename": "abstract_test_package-0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4f2bf53b0f9153b3d6ce02d265d3b56e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 4174,
"upload_time": "2023-05-31T01:36:50",
"upload_time_iso_8601": "2023-05-31T01:36:50.350749Z",
"url": "https://files.pythonhosted.org/packages/89/bd/7a3e31744763089ab0a8f209590416a52f43814d576ba81670cef73ea287/abstract_test_package-0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2a00d8377e4f0faac385ccf9a4b2533a7f60cd89a5d02af5a5a9655cde84bb04",
"md5": "645b767120f68b16b639eea00d11e998",
"sha256": "5ae22e7a109eab209262d22ccfe6a55d4e8c9b76bf86c5ac4ddb10489b2faf1a"
},
"downloads": -1,
"filename": "abstract_test_package-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "645b767120f68b16b639eea00d11e998",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 3495,
"upload_time": "2023-05-31T01:36:56",
"upload_time_iso_8601": "2023-05-31T01:36:56.118486Z",
"url": "https://files.pythonhosted.org/packages/2a/00/d8377e4f0faac385ccf9a4b2533a7f60cd89a5d02af5a5a9655cde84bb04/abstract_test_package-0.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-31 01:36:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "AbstractEndeavors",
"github_project": "abstract_test_package",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "abstract-test-package"
}