# vedro-spec-compare
[](https://pypi.org/project/vedro-spec-compare/)
[](https://pypi.org/project/vedro-spec-compare/)
# Description
`vedro-spec-compare` is a tool to compare two OpenAPI specs and generate a coverage report
# Installation
```bash
pip3 install vedro-spec-compare
```
# Usage
## Help
```bash
vsc -h
```
```
usage: vsc [-h] {coverage} ...
vedro-spec-compare commands
positional arguments:
{coverage} Available commands
coverage Generate coverage report
options:
-h, --help show this help message and exit
```
## Coverage
```bash
vsc coverage -h
```
```
usage: vsc coverage [-h] [--report-path REPORT_PATH] golden_spec_path testing_spec_path
positional arguments:
golden_spec_path Path to the golden OpenAPI spec
testing_spec_path Path to the testing OpenAPI spec
options:
-h, --help show this help message and exit
--report-path REPORT_PATH
The path of the coverage report
```
### Examples
#### From yml files
```bash
vsc coverage golden_spec.yml testing_spec.yml
```
```bash
google-chrome coverage.html
```
#### With report path
```bash
vsc coverage golden_spec.yml testing_spec.yml --report-path coverage_report.html
```
```bash
google-chrome coverage_report.html
```
#### From urls
```bash
vsc coverage https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore-expanded.yaml https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.yaml
```
```bash
google-chrome coverage.html
```
Raw data
{
"_id": null,
"home_page": "https://github.com/kvs8/vedro-spec-compare",
"name": "vedro-spec-compare",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Konstantin Shefer",
"author_email": "kostya.shefer.999@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/2c/d3/037c6539554803081b657cac0e91769f0a67af0f1607c205effb47a4a02b/vedro_spec_compare-0.0.2.tar.gz",
"platform": null,
"description": "# vedro-spec-compare\n\n[](https://pypi.org/project/vedro-spec-compare/)\n[](https://pypi.org/project/vedro-spec-compare/)\n\n# Description\n\n`vedro-spec-compare` is a tool to compare two OpenAPI specs and generate a coverage report\n\n# Installation\n\n```bash\npip3 install vedro-spec-compare\n```\n\n\n# Usage\n\n## Help\n```bash\nvsc -h\n```\n```\nusage: vsc [-h] {coverage} ...\n\nvedro-spec-compare commands\n\npositional arguments:\n {coverage} Available commands\n coverage Generate coverage report\n\noptions:\n -h, --help show this help message and exit\n```\n\n## Coverage\n```bash\nvsc coverage -h\n```\n```\nusage: vsc coverage [-h] [--report-path REPORT_PATH] golden_spec_path testing_spec_path\n\npositional arguments:\n golden_spec_path Path to the golden OpenAPI spec\n testing_spec_path Path to the testing OpenAPI spec\n\noptions:\n -h, --help show this help message and exit\n --report-path REPORT_PATH\n The path of the coverage report\n```\n\n### Examples\n#### From yml files\n```bash\nvsc coverage golden_spec.yml testing_spec.yml\n```\n```bash\ngoogle-chrome coverage.html \n```\n\n#### With report path\n```bash\nvsc coverage golden_spec.yml testing_spec.yml --report-path coverage_report.html\n```\n```bash\ngoogle-chrome coverage_report.html \n```\n\n#### From urls\n```bash\nvsc coverage https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore-expanded.yaml https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.yaml\n```\n```bash\ngoogle-chrome coverage.html \n```\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "OpenAPI spec compare",
"version": "0.0.2",
"project_urls": {
"Homepage": "https://github.com/kvs8/vedro-spec-compare"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f8cbb645b8bff2486d0be65e22bf40d113909dba1e73cd38c1021ad0d1483b77",
"md5": "6042994f6d1d77246c6f06122525373b",
"sha256": "df30d3df6eb75cfe56d0686d52bfd8c16ba885f95c01ed69a1684bb1680062a3"
},
"downloads": -1,
"filename": "vedro_spec_compare-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6042994f6d1d77246c6f06122525373b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 11426,
"upload_time": "2024-10-07T17:11:50",
"upload_time_iso_8601": "2024-10-07T17:11:50.934628Z",
"url": "https://files.pythonhosted.org/packages/f8/cb/b645b8bff2486d0be65e22bf40d113909dba1e73cd38c1021ad0d1483b77/vedro_spec_compare-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2cd3037c6539554803081b657cac0e91769f0a67af0f1607c205effb47a4a02b",
"md5": "4a00fb0b24699b54601f941939bdebc9",
"sha256": "92b0add97fcc4b1af57fd836897412933ed4ef97d7b34c51973644e1ade5386b"
},
"downloads": -1,
"filename": "vedro_spec_compare-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "4a00fb0b24699b54601f941939bdebc9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 10614,
"upload_time": "2024-10-07T17:11:52",
"upload_time_iso_8601": "2024-10-07T17:11:52.624971Z",
"url": "https://files.pythonhosted.org/packages/2c/d3/037c6539554803081b657cac0e91769f0a67af0f1607c205effb47a4a02b/vedro_spec_compare-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 17:11:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kvs8",
"github_project": "vedro-spec-compare",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "vedro-spec-compare"
}
JSON
