# Visual Regression Testing (VRT) CLI Tool
This CLI tool is designed to help with visual regression testing by comparing images from two directories (`vrt-expected` and `vrt-actual`). It also provides functionality to approve new baseline images.
## Features
- **Initialization**: Create the necessary directories for storing expected and actual images.
- **Comparison**: Compare images in the `vrt-expected` and `vrt-actual` directories and generate a difference image if discrepancies are found.
- **Approval**: Approve actual images and move them to the `vrt-expected` directory, renaming them as required.
## Installation
```bash
pip install vrt_python
```
## Usage
### 1. Initialize Directories
To set up the necessary directories (`vrt-expected` and `vrt-actual`), run:
```bash
vrt init
```
This command will create the following directories:
- `vrt-expected`: Where you store your expected baseline images.
- `vrt-actual`: Where you store the actual images to compare against the baseline.
### 2. Compare Images
To compare images between the `vrt-expected` and `vrt-actual` directories, run:
```bash
vrt compare
```
This command will:
- Compare each image in `vrt-expected` with the corresponding image in `vrt-actual`.
- Generate a difference image in the `vrt-difference` directory if discrepancies are found.
- Print the percentage of difference for each image.
### 3. Approve Actual Images
To approve the actual images and move them to the `vrt-expected` directory, run:
```bash
vrt approve
```
This command will:
- Copy images from the `vrt-actual` directory to the `vrt-expected` directory.
- Rename the images by replacing the `actual_` prefix with `expected_`.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
Raw data
{
"_id": null,
"home_page": "https://github.com/vshkodin/vrt-python",
"name": "vrt-python",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Vladimir Shkodin",
"author_email": "v.s.shkodin@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/56/33/cc4ea58bb475dca2bd480770dd96f955d5e3d070dbc91e8996643fff6c7a/vrt_python-0.2.0.tar.gz",
"platform": null,
"description": "\n# Visual Regression Testing (VRT) CLI Tool\n\nThis CLI tool is designed to help with visual regression testing by comparing images from two directories (`vrt-expected` and `vrt-actual`). It also provides functionality to approve new baseline images.\n\n## Features\n\n- **Initialization**: Create the necessary directories for storing expected and actual images.\n- **Comparison**: Compare images in the `vrt-expected` and `vrt-actual` directories and generate a difference image if discrepancies are found.\n- **Approval**: Approve actual images and move them to the `vrt-expected` directory, renaming them as required.\n\n## Installation\n\n```bash\npip install vrt_python\n```\n\n## Usage\n\n### 1. Initialize Directories\n\nTo set up the necessary directories (`vrt-expected` and `vrt-actual`), run:\n\n```bash\nvrt init\n```\n\nThis command will create the following directories:\n- `vrt-expected`: Where you store your expected baseline images.\n- `vrt-actual`: Where you store the actual images to compare against the baseline.\n\n### 2. Compare Images\n\nTo compare images between the `vrt-expected` and `vrt-actual` directories, run:\n\n```bash\nvrt compare\n```\n\nThis command will:\n- Compare each image in `vrt-expected` with the corresponding image in `vrt-actual`.\n- Generate a difference image in the `vrt-difference` directory if discrepancies are found.\n- Print the percentage of difference for each image.\n\n### 3. Approve Actual Images\n\nTo approve the actual images and move them to the `vrt-expected` directory, run:\n\n```bash\nvrt approve\n```\n\nThis command will:\n- Copy images from the `vrt-actual` directory to the `vrt-expected` directory.\n- Rename the images by replacing the `actual_` prefix with `expected_`.\n\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n",
"bugtrack_url": null,
"license": null,
"summary": "A CLI tool for visual regression testing",
"version": "0.2.0",
"project_urls": {
"Homepage": "https://github.com/vshkodin/vrt-python"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2cbed0bfaa0f2b88cf0c3d35697e646c2a4de2e034725e344d5fa60cd35bcc7f",
"md5": "0095894c610971e71a468735e03de0c0",
"sha256": "e087a5f37116cf70be4fd6387ab6ba906079dc92fc5bfb3217d13bd4d3f2a9c7"
},
"downloads": -1,
"filename": "vrt_python-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0095894c610971e71a468735e03de0c0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 4508,
"upload_time": "2024-08-29T03:18:42",
"upload_time_iso_8601": "2024-08-29T03:18:42.190207Z",
"url": "https://files.pythonhosted.org/packages/2c/be/d0bfaa0f2b88cf0c3d35697e646c2a4de2e034725e344d5fa60cd35bcc7f/vrt_python-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5633cc4ea58bb475dca2bd480770dd96f955d5e3d070dbc91e8996643fff6c7a",
"md5": "6a0d095d6789336044cc74cc668444b0",
"sha256": "942a1f1a2de6a354d8f662d2c9ef142c32add615e536491903fb67b1979c70c1"
},
"downloads": -1,
"filename": "vrt_python-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "6a0d095d6789336044cc74cc668444b0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 4007,
"upload_time": "2024-08-29T03:18:43",
"upload_time_iso_8601": "2024-08-29T03:18:43.024513Z",
"url": "https://files.pythonhosted.org/packages/56/33/cc4ea58bb475dca2bd480770dd96f955d5e3d070dbc91e8996643fff6c7a/vrt_python-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-29 03:18:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "vshkodin",
"github_project": "vrt-python",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "vrt-python"
}
JSON
