# Vedro GitLab Reporter
[](https://codecov.io/gh/vedro-universe/vedro-gitlab-reporter)
[](https://pypi.python.org/pypi/vedro-gitlab-reporter/)
[](https://pypi.python.org/pypi/vedro-gitlab-reporter/)
[](https://pypi.python.org/pypi/vedro-gitlab-reporter/)
GitLab (>=12.0) reporter with [collapsable sections](https://docs.gitlab.com/ee/ci/jobs/#custom-collapsible-sections) for [Vedro](https://vedro.io/) 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-gitlab-reporter
```
</p>
</details>
<details>
<summary>Manual</summary>
<p>
To install manually, follow these steps:
1. Install the package using pip:
```shell
$ pip3 install vedro-gitlab-reporter
```
2. Next, activate the plugin in your `vedro.cfg.py` configuration file:
```python
# ./vedro.cfg.py
import vedro
import vedro_gitlab_reporter
class Config(vedro.Config):
class Plugins(vedro.Config.Plugins):
class GitlabReporter(vedro_gitlab_reporter.GitlabReporter):
enabled = True
```
</p>
</details>
## Usage
### Run tests
```shell
$ vedro run -r gitlab --gitlab-collapsable steps
```
## Documentation
`--gitlab-collapsable=<mode>`
| Mode | Description |
| ----- | ----------------------------------------------- |
| steps | Show exception and collapsable steps |
| vars | Show exception, steps and collapsable variables |
| scope | Show exception, steps and collapsable scope |
Raw data
{
"_id": null,
"home_page": "https://github.com/vedro-universe/vedro-gitlab-reporter",
"name": "vedro-gitlab-reporter",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "",
"author": "Nikita Tsvetkov",
"author_email": "tsv1@fastmail.com",
"download_url": "https://files.pythonhosted.org/packages/ba/41/260c9608440be73a8cff201a6670d4475923e64eef9d1bcee632fe5eb897/vedro-gitlab-reporter-2.1.3.tar.gz",
"platform": null,
"description": "# Vedro GitLab Reporter\n\n[](https://codecov.io/gh/vedro-universe/vedro-gitlab-reporter)\n[](https://pypi.python.org/pypi/vedro-gitlab-reporter/)\n[](https://pypi.python.org/pypi/vedro-gitlab-reporter/)\n[](https://pypi.python.org/pypi/vedro-gitlab-reporter/)\n\nGitLab (>=12.0) reporter with [collapsable sections](https://docs.gitlab.com/ee/ci/jobs/#custom-collapsible-sections) for [Vedro](https://vedro.io/) 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-gitlab-reporter\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-gitlab-reporter\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_gitlab_reporter\n\nclass Config(vedro.Config):\n\n class Plugins(vedro.Config.Plugins):\n\n class GitlabReporter(vedro_gitlab_reporter.GitlabReporter):\n enabled = True\n```\n\n</p>\n</details>\n\n## Usage\n\n### Run tests\n\n```shell\n$ vedro run -r gitlab --gitlab-collapsable steps\n```\n\n## Documentation\n\n`--gitlab-collapsable=<mode>`\n\n| Mode | Description |\n| ----- | ----------------------------------------------- |\n| steps | Show exception and collapsable steps |\n| vars | Show exception, steps and collapsable variables |\n| scope | Show exception, steps and collapsable scope |\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "GitLab reporter with collapsable sections for Vedro framework",
"version": "2.1.3",
"project_urls": {
"Docs": "https://vedro.io/docs/integrations/gitlab-reporter",
"GitHub": "https://github.com/vedro-universe/vedro-gitlab-reporter",
"Homepage": "https://github.com/vedro-universe/vedro-gitlab-reporter"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0fce4c079572d8feec66eae675b49f65ea8a921bdb4caf471ee373e746f7c534",
"md5": "aa46c15e1611a80692196e9cb2727694",
"sha256": "0a1de898f9ce29da27b5debdfb5bcaeea8edf94f1cd242c7461a1f5b0ca47227"
},
"downloads": -1,
"filename": "vedro_gitlab_reporter-2.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "aa46c15e1611a80692196e9cb2727694",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 9846,
"upload_time": "2024-01-10T17:16:43",
"upload_time_iso_8601": "2024-01-10T17:16:43.000061Z",
"url": "https://files.pythonhosted.org/packages/0f/ce/4c079572d8feec66eae675b49f65ea8a921bdb4caf471ee373e746f7c534/vedro_gitlab_reporter-2.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ba41260c9608440be73a8cff201a6670d4475923e64eef9d1bcee632fe5eb897",
"md5": "57eb8b07fcb41a6390a653efc6287874",
"sha256": "b980e1bf213cdd944b15e046559b5e12970523c52e3e8a62f1cb7eb2dd9a51a9"
},
"downloads": -1,
"filename": "vedro-gitlab-reporter-2.1.3.tar.gz",
"has_sig": false,
"md5_digest": "57eb8b07fcb41a6390a653efc6287874",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 11907,
"upload_time": "2024-01-10T17:16:46",
"upload_time_iso_8601": "2024-01-10T17:16:46.799190Z",
"url": "https://files.pythonhosted.org/packages/ba/41/260c9608440be73a8cff201a6670d4475923e64eef9d1bcee632fe5eb897/vedro-gitlab-reporter-2.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-10 17:16:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "vedro-universe",
"github_project": "vedro-gitlab-reporter",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "vedro-gitlab-reporter"
}
JSON
