| Name | oaspy JSON |
| Version |
2024.10.22
JSON |
| download |
| home_page | None |
| Summary | oaspy is a quick-and-dirty tool to generate an OpenApi 3.x specification from an insomnia V4 collections. |
| upload_time | 2024-10-22 16:33:23 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <3.12,>=3.9 |
| license | None |
| keywords |
oaspy
insomnia
openapi
converter
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# oaspy
[](https://docs.python.org/3.10/)
[](https://opensource.org/licenses/MIT)
[](https://pypi.org/project/oaspy/)
---
**oaspy** is a quick-and-dirty tool to generate an [OpenApi 3.x](https://www.openapis.org) specification from an [insomnia V4](https://insomnia.rest/products/insomnia) collections.
## Getting Started
For more, see the [documentation](./docs/README.md).
### Installation
**oaspy** is available on [PyPI](https://pypi.org/project/oaspy/):
```shell
pip install oaspy
```
## Usage
To run **oaspy**, try any of the following:
```sh
oaspy --help
```
## Commands
### **gen:** :new: (in progress)
Generate an OpenApi 3.x file from an Insomnia collection v4.
```sh
oaspy gen --help
```
with the default options.
```sh
oaspy gen --file Insomnia_file_v4.json
```
defining the version of openapi to generate.
```sh
oaspy gen --file Insomnia_file_v4.json --schema v30
```
> argument `v30` refers to openapi version 3.0.x
defining the version of openapi to generate and the output file name.
```sh
oaspy gen --file Insomnia_file_v4.json --output my_oa3_export.json
```
a complete version of the above.
```sh
oaspy gen --file Insomnia_file_v4.json --schema v30 --output my_oa3_export.json
```
### **check:** :new:
Validates the structure of an OpenApi file.
```sh
oaspy check --help
```
```sh
oaspy check --file my_oa3_export.json
```
### **info:** :new:
Shows information from an Insomnia v4 file.
```sh
oaspy info --help
```
```sh
oaspy info --file Insomnia_file_v4.json
```
### Configuration
**oaspy** can be configured through a `pyproject.toml` if it is used as a dev dependency in your project.
If left unspecified, the default configuration is equivalent to:
```toml
[tool.oaspy]
title = "awesome api - OpenAPI 3.0"
description = "my awesome api"
terms-of-service = "http://awesome.io/terms"
contact-url = "http://awesome.io"
contact-email = "apiteam@awesome.io"
license-name = "MIT"
license-url = "https://opensource.org/license/mit/"
version = "1.0.0"
```
## License
This project is licensed under the terms of the [MIT.](https://opensource.org/license/mit/) license.
The full text of this license can be found in the [LICENSE.](./LICENSE) file.
## How to Contribute
For any questions, comments, suggestions or contributions, go to the [issues.](https://gitlab.com/HomeInside/oaspy/-/issues) section.
Before opening a new issue, check the existing ones to find a solution (possibly already existing) to the problem you are facing.
Raw data
{
"_id": null,
"home_page": null,
"name": "oaspy",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.12,>=3.9",
"maintainer_email": null,
"keywords": "oaspy, insomnia, openapi, converter",
"author": null,
"author_email": "Jorge Brunal <diniremix@gmail.com>, Gabriel Jimenez <awesome@email.com>",
"download_url": "https://files.pythonhosted.org/packages/73/7b/5170150e4de7070caf0ed87d06aebd2a2b792093bc8b0146dc1177aa6a9b/oaspy-2024.10.22.tar.gz",
"platform": null,
"description": "# oaspy\n\n[](https://docs.python.org/3.10/)\n[](https://opensource.org/licenses/MIT)\n[](https://pypi.org/project/oaspy/)\n---\n\n**oaspy** is a quick-and-dirty tool to generate an [OpenApi 3.x](https://www.openapis.org) specification from an [insomnia V4](https://insomnia.rest/products/insomnia) collections.\n\n\n## Getting Started\n\nFor more, see the [documentation](./docs/README.md).\n\n### Installation\n\n**oaspy** is available on [PyPI](https://pypi.org/project/oaspy/):\n\n```shell\npip install oaspy\n```\n\n## Usage\n\nTo run **oaspy**, try any of the following:\n\n```sh\noaspy --help\n```\n\n\n## Commands\n\n### **gen:** :new: (in progress)\n\nGenerate an OpenApi 3.x file from an Insomnia collection v4.\n\n```sh\noaspy gen --help\n```\n\nwith the default options.\n\n```sh\noaspy gen --file Insomnia_file_v4.json\n```\n\ndefining the version of openapi to generate.\n\n```sh\noaspy gen --file Insomnia_file_v4.json --schema v30\n```\n> argument `v30` refers to openapi version 3.0.x\n\ndefining the version of openapi to generate and the output file name.\n\n```sh\noaspy gen --file Insomnia_file_v4.json --output my_oa3_export.json\n```\n\na complete version of the above.\n\n```sh\noaspy gen --file Insomnia_file_v4.json --schema v30 --output my_oa3_export.json\n```\n\n\n### **check:** :new:\n\nValidates the structure of an OpenApi file.\n\n```sh\noaspy check --help\n```\n\n```sh\noaspy check --file my_oa3_export.json\n```\n\n### **info:** :new:\n\nShows information from an Insomnia v4 file.\n\n```sh\noaspy info --help\n```\n\n```sh\noaspy info --file Insomnia_file_v4.json\n```\n\n\n### Configuration\n\n**oaspy** can be configured through a `pyproject.toml` if it is used as a dev dependency in your project.\n\nIf left unspecified, the default configuration is equivalent to:\n\n```toml\n[tool.oaspy]\ntitle = \"awesome api - OpenAPI 3.0\"\ndescription = \"my awesome api\"\nterms-of-service = \"http://awesome.io/terms\"\ncontact-url = \"http://awesome.io\"\ncontact-email = \"apiteam@awesome.io\"\nlicense-name = \"MIT\"\nlicense-url = \"https://opensource.org/license/mit/\"\nversion = \"1.0.0\"\n```\n\n\n## License\n\nThis project is licensed under the terms of the [MIT.](https://opensource.org/license/mit/) license.\n\nThe full text of this license can be found in the [LICENSE.](./LICENSE) file.\n\n\n## How to Contribute\n\nFor any questions, comments, suggestions or contributions, go to the [issues.](https://gitlab.com/HomeInside/oaspy/-/issues) section.\nBefore opening a new issue, check the existing ones to find a solution (possibly already existing) to the problem you are facing.\n\n",
"bugtrack_url": null,
"license": null,
"summary": "oaspy is a quick-and-dirty tool to generate an OpenApi 3.x specification from an insomnia V4 collections.",
"version": "2024.10.22",
"project_urls": {
"Changelog": "https://gitlab.com/HomeInside/oaspy/-/blob/master/CHANGELOG.md",
"Documentation": "https://gitlab.com/HomeInside/oaspy",
"Homepage": "https://gitlab.com/HomeInside/oaspy",
"Source": "https://gitlab.com/HomeInside/oaspy"
},
"split_keywords": [
"oaspy",
" insomnia",
" openapi",
" converter"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "19f6f8d292aea15d4501d0e3066efc46fd22d788c28cfa309f50a27ccaf087d7",
"md5": "e23569146bed2f01d9dca56344559783",
"sha256": "20a631ed23a84a174c804465578be355ee24cf96555d422fd45f99a9a82c84b2"
},
"downloads": -1,
"filename": "oaspy-2024.10.22-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e23569146bed2f01d9dca56344559783",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12,>=3.9",
"size": 23672,
"upload_time": "2024-10-22T16:33:22",
"upload_time_iso_8601": "2024-10-22T16:33:22.218239Z",
"url": "https://files.pythonhosted.org/packages/19/f6/f8d292aea15d4501d0e3066efc46fd22d788c28cfa309f50a27ccaf087d7/oaspy-2024.10.22-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "737b5170150e4de7070caf0ed87d06aebd2a2b792093bc8b0146dc1177aa6a9b",
"md5": "33b59a5edb38eb8ddf6b4b590f0339cd",
"sha256": "4d0bdd1f05032a631cd13c7bd6936b1eb31171fa3764d90845f2d2383bc6d362"
},
"downloads": -1,
"filename": "oaspy-2024.10.22.tar.gz",
"has_sig": false,
"md5_digest": "33b59a5edb38eb8ddf6b4b590f0339cd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.9",
"size": 24653,
"upload_time": "2024-10-22T16:33:23",
"upload_time_iso_8601": "2024-10-22T16:33:23.485726Z",
"url": "https://files.pythonhosted.org/packages/73/7b/5170150e4de7070caf0ed87d06aebd2a2b792093bc8b0146dc1177aa6a9b/oaspy-2024.10.22.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-22 16:33:23",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "HomeInside",
"gitlab_project": "oaspy",
"lcname": "oaspy"
}
