# Vedro Unittest
[](https://codecov.io/gh/vedro-universe/vedro-unittest)
[](https://pypi.python.org/pypi/vedro-unittest/)
[](https://pypi.python.org/pypi/vedro-unittest/)
[](https://pypi.python.org/pypi/vedro-unittest/)
[vedro-unittest](https://pypi.org/project/vedro-unittest/) allows running unittest test cases within the [Vedro](https://vedro.io/) framework. This plugin seamlessly integrates unittest test cases, converting them into Vedro scenarios to leverage the powerful features of the Vedro testing framework.
## Installation
<details open>
<summary>Quick</summary>
<p>
For a quick installation, you can use a plugin manager as follows:
```shell
$ vedro plugin install vedro-unittest
```
</p>
</details>
<details>
<summary>Manual</summary>
<p>
To install manually, follow these steps:
1. Install the package using pip:
```shell
$ pip3 install vedro-unittest
```
2. Next, activate the plugin in your `vedro.cfg.py` configuration file:
```python
# ./vedro.cfg.py
import vedro
import vedro_unittest
class Config(vedro.Config):
class Plugins(vedro.Config.Plugins):
class VedroUnitTest(vedro_unittest.VedroUnitTest):
enabled = True
```
</p>
</details>
## Usage
To use the plugin, create your unittest test cases as usual:
```python
# ./scenarios/test_base64.py
import unittest
from base64 import b64encode, b64decode
class TestBase64Encoding(unittest.TestCase):
def test_encode_to_base64(self):
result = b64encode(b"banana")
self.assertEqual(result, b"YmFuYW5h")
def test_decode_from_base64(self):
result = b64decode(b"YmFuYW5h")
self.assertEqual(result, b"banana")
```
Then run your tests using Vedro:
```shell
$ vedro run tests/
```
This will automatically detect and run your unittest test cases as Vedro scenarios, allowing you to take advantage of Vedro's rich feature set.
**📘 Explore more:** Learn how to gradually migrate your test suite, understand compatibility and limitations, and unlock the full potential of Vedro in the [official unittest bridge documentation](https://vedro.io/docs/integrations/unittest-bridge).
Raw data
{
"_id": null,
"home_page": "https://github.com/vedro-universe/vedro-unittest",
"name": "vedro-unittest",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Nikita Tsvetkov",
"author_email": "tsv1@fastmail.com",
"download_url": "https://files.pythonhosted.org/packages/20/fe/07050076c9da70b609f404ea2ee38702d6bf44b60f0cefaae9bdf61618bb/vedro_unittest-0.2.0.tar.gz",
"platform": null,
"description": "# Vedro Unittest\n\n[](https://codecov.io/gh/vedro-universe/vedro-unittest)\n[](https://pypi.python.org/pypi/vedro-unittest/)\n[](https://pypi.python.org/pypi/vedro-unittest/)\n[](https://pypi.python.org/pypi/vedro-unittest/)\n\n[vedro-unittest](https://pypi.org/project/vedro-unittest/) allows running unittest test cases within the [Vedro](https://vedro.io/) framework. This plugin seamlessly integrates unittest test cases, converting them into Vedro scenarios to leverage the powerful features of the Vedro testing framework.\n\n## Installation\n\n<details open>\n<summary>Quick</summary>\n<p>\n\nFor a quick installation, you can use a plugin manager as follows:\n\n```shell\n$ vedro plugin install vedro-unittest\n```\n\n</p>\n</details>\n\n<details>\n<summary>Manual</summary>\n<p>\n\nTo install manually, follow these steps:\n\n1. Install the package using pip:\n\n```shell\n$ pip3 install vedro-unittest\n```\n\n2. Next, activate the plugin in your `vedro.cfg.py` configuration file:\n\n```python\n# ./vedro.cfg.py\nimport vedro\nimport vedro_unittest\n\nclass Config(vedro.Config):\n\n class Plugins(vedro.Config.Plugins):\n\n class VedroUnitTest(vedro_unittest.VedroUnitTest):\n enabled = True\n```\n\n</p>\n</details>\n\n## Usage\n\nTo use the plugin, create your unittest test cases as usual:\n\n```python\n# ./scenarios/test_base64.py\nimport unittest\nfrom base64 import b64encode, b64decode\n\nclass TestBase64Encoding(unittest.TestCase):\n def test_encode_to_base64(self):\n result = b64encode(b\"banana\")\n self.assertEqual(result, b\"YmFuYW5h\")\n\n def test_decode_from_base64(self):\n result = b64decode(b\"YmFuYW5h\")\n self.assertEqual(result, b\"banana\")\n```\n\nThen run your tests using Vedro:\n\n```shell\n$ vedro run tests/\n```\n\nThis will automatically detect and run your unittest test cases as Vedro scenarios, allowing you to take advantage of Vedro's rich feature set.\n\n**\ud83d\udcd8 Explore more:** Learn how to gradually migrate your test suite, understand compatibility and limitations, and unlock the full potential of Vedro in the [official unittest bridge documentation](https://vedro.io/docs/integrations/unittest-bridge).\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Allows running unittest test cases within the Vedro framework",
"version": "0.2.0",
"project_urls": {
"Docs": "https://vedro.io/docs/integrations/unittest-bridge",
"GitHub": "https://github.com/vedro-universe/vedro-unittest",
"Homepage": "https://github.com/vedro-universe/vedro-unittest"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "e48b12b0d24cd45595727d7dd0ea383f846bc3e5298d701420370396d7c94cfb",
"md5": "8783d593fca451146102c907ef21d1a6",
"sha256": "467b199ed2ba667c90fabee902ff315acd6f6121c267227eb6ca6afb7e356cde"
},
"downloads": -1,
"filename": "vedro_unittest-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8783d593fca451146102c907ef21d1a6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 13038,
"upload_time": "2025-08-23T08:56:59",
"upload_time_iso_8601": "2025-08-23T08:56:59.786453Z",
"url": "https://files.pythonhosted.org/packages/e4/8b/12b0d24cd45595727d7dd0ea383f846bc3e5298d701420370396d7c94cfb/vedro_unittest-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "20fe07050076c9da70b609f404ea2ee38702d6bf44b60f0cefaae9bdf61618bb",
"md5": "50e9a7e5897da708637fc5cb2301362f",
"sha256": "5282624ba6117541564fe2937b1d56958d2f33e71f17916ac77593d692bccd92"
},
"downloads": -1,
"filename": "vedro_unittest-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "50e9a7e5897da708637fc5cb2301362f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 16238,
"upload_time": "2025-08-23T08:57:00",
"upload_time_iso_8601": "2025-08-23T08:57:00.630331Z",
"url": "https://files.pythonhosted.org/packages/20/fe/07050076c9da70b609f404ea2ee38702d6bf44b60f0cefaae9bdf61618bb/vedro_unittest-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-23 08:57:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "vedro-universe",
"github_project": "vedro-unittest",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "vedro",
"specs": [
[
">=",
"1.14"
],
[
"<",
"2.0"
]
]
}
],
"lcname": "vedro-unittest"
}
JSON
