# Vedro Git Changed
[![Codecov](https://img.shields.io/codecov/c/github/vedro-universe/vedro-git-changed/master.svg?style=flat-square)](https://codecov.io/gh/vedro-universe/vedro-git-changed)
[![PyPI](https://img.shields.io/pypi/v/vedro-git-changed.svg?style=flat-square)](https://pypi.python.org/pypi/vedro-git-changed/)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/vedro-git-changed?style=flat-square)](https://pypi.python.org/pypi/vedro-git-changed/)
[![Python Version](https://img.shields.io/pypi/pyversions/vedro-git-changed.svg?style=flat-square)](https://pypi.python.org/pypi/vedro-git-changed/)
[vedro-git-changed](https://pypi.org/project/vedro-git-changed/) is a [Vedro](https://vedro.io) plugin that runs test scenarios which have changed relative to the specified git branch.
## Installation
<details open>
<summary>Quick</summary>
<p>
For a quick installation, you can use a plugin manager as follows:
```shell
$ vedro plugin install vedro-git-changed
```
</p>
</details>
<details>
<summary>Manual</summary>
<p>
To install manually, follow these steps:
1. Install the package using pip:
```shell
$ pip3 install vedro-git-changed
```
2. Next, activate the plugin in your `vedro.cfg.py` configuration file:
```python
# ./vedro.cfg.py
import vedro
import vedro_git_changed
class Config(vedro.Config):
class Plugins(vedro.Config.Plugins):
class VedroGitChanged(vedro_git_changed.VedroGitChanged):
enabled = True
```
</p>
</details>
## Usage
To run test scenarios that have been modified compared to the `main` branch, use the following command:
```shell
$ vedro run --changed-against-branch=main
```
By default, the plugin caches `git fetch` results for 60 seconds. To change this duration, specify a different cache duration in seconds with the `--changed-fetch-cache` argument.
For example, to disable caching, set the cache duration to 0:
```shell
$ vedro run --changed-against-branch=main --changed-fetch-cache=0
```
To disable fetching the latest changes from the remote repository, use the `--changed-no-fetch` argument:
```shell
$ vedro run --changed-against-branch=main --changed-no-fetch
```
Raw data
{
"_id": null,
"home_page": "https://github.com/vedro-universe/vedro-git-changed",
"name": "vedro-git-changed",
"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/83/b3/9fadedb928ee73dd516a5afca1fdf3179b8f800ef225520c5b3ab4b80cb5/vedro_git_changed-0.2.0.tar.gz",
"platform": null,
"description": "# Vedro Git Changed\n\n[![Codecov](https://img.shields.io/codecov/c/github/vedro-universe/vedro-git-changed/master.svg?style=flat-square)](https://codecov.io/gh/vedro-universe/vedro-git-changed)\n[![PyPI](https://img.shields.io/pypi/v/vedro-git-changed.svg?style=flat-square)](https://pypi.python.org/pypi/vedro-git-changed/)\n[![PyPI - Downloads](https://img.shields.io/pypi/dm/vedro-git-changed?style=flat-square)](https://pypi.python.org/pypi/vedro-git-changed/)\n[![Python Version](https://img.shields.io/pypi/pyversions/vedro-git-changed.svg?style=flat-square)](https://pypi.python.org/pypi/vedro-git-changed/)\n\n[vedro-git-changed](https://pypi.org/project/vedro-git-changed/) is a [Vedro](https://vedro.io) plugin that runs test scenarios which have changed relative to the specified git branch.\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-git-changed\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-git-changed\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_git_changed\n\nclass Config(vedro.Config):\n\n class Plugins(vedro.Config.Plugins):\n\n class VedroGitChanged(vedro_git_changed.VedroGitChanged):\n enabled = True\n```\n\n</p>\n</details>\n\n## Usage\n\nTo run test scenarios that have been modified compared to the `main` branch, use the following command:\n\n```shell\n$ vedro run --changed-against-branch=main\n```\n\nBy default, the plugin caches `git fetch` results for 60 seconds. To change this duration, specify a different cache duration in seconds with the `--changed-fetch-cache` argument.\n\nFor example, to disable caching, set the cache duration to 0:\n\n```shell\n$ vedro run --changed-against-branch=main --changed-fetch-cache=0\n```\n\nTo disable fetching the latest changes from the remote repository, use the `--changed-no-fetch` argument:\n\n```shell\n$ vedro run --changed-against-branch=main --changed-no-fetch\n```\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Vedro plugin that runs test scenarios which have changed relative to the specified git branch",
"version": "0.2.0",
"project_urls": {
"Docs": "https://github.com/vedro-universe/vedro-git-changed",
"GitHub": "https://github.com/vedro-universe/vedro-git-changed",
"Homepage": "https://github.com/vedro-universe/vedro-git-changed"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e364dd8e0d2ae75930bf7a9548290fa8294137c2693019eb88ac576368551dea",
"md5": "7d9a54ead05cc9e819984c52f7093657",
"sha256": "be32bd53d8eef60fcc2535124892275062686fcd19336eddb55b51e545a797f4"
},
"downloads": -1,
"filename": "vedro_git_changed-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7d9a54ead05cc9e819984c52f7093657",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 9495,
"upload_time": "2024-07-18T15:35:05",
"upload_time_iso_8601": "2024-07-18T15:35:05.767023Z",
"url": "https://files.pythonhosted.org/packages/e3/64/dd8e0d2ae75930bf7a9548290fa8294137c2693019eb88ac576368551dea/vedro_git_changed-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "83b39fadedb928ee73dd516a5afca1fdf3179b8f800ef225520c5b3ab4b80cb5",
"md5": "407ad2f75e0c12683efa93e49efd0ed2",
"sha256": "d962ed0747bd5cefb6a76a088d884b907c0c4268dd8650e9c979a247b95cad49"
},
"downloads": -1,
"filename": "vedro_git_changed-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "407ad2f75e0c12683efa93e49efd0ed2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 11371,
"upload_time": "2024-07-18T15:35:07",
"upload_time_iso_8601": "2024-07-18T15:35:07.197865Z",
"url": "https://files.pythonhosted.org/packages/83/b3/9fadedb928ee73dd516a5afca1fdf3179b8f800ef225520c5b3ab4b80cb5/vedro_git_changed-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-18 15:35:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "vedro-universe",
"github_project": "vedro-git-changed",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "vedro-git-changed"
}