# OpenAPI Generator in Package Installer for Python (PIP)
[](
<https://join.slack.com/t/openapi-generator/shared_invite/zt-12jxxd7p2-XUeQM~4pzsU9x~eGLQqX2g>
) [](
<https://badge.fury.io/py/openapi-generator-cli>
) [](
<https://github.com/psf/black>
) [](
<https://github.com/astral-sh/ruff>
)
OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec (both 2.0 and 3.0 are supported). Please see [OpenAPITools/openapi-generator]
---
This project checks the [maven repository] once a day for a new version and will publish this new version automatically as a python package.
## Installation
You must have the `java` binary executable available on your PATH for this to work. (JDK 11 is the minimal version supported. To install OpenJDK, please visit <https://adoptium.net/>)
You can install the package either in a virtual environment or globally.
```sh
# install the latest version of "openapi-generator-cli"
pip install openapi-generator-cli
# install a specific version of "openapi-generator-cli"
pip install openapi-generator-cli==4.3.1
```
You can also install with [`jdk4py`] instead of `java` binary. (`python>=3.10` is required)
```sh
pip install openapi-generator-cli[jdk4py]
```
After installation `openapi-generator-cli` command will be available in your virtual environment or globally depending on your installation.
To check the version, for example. Type the following command
```sh
# this will print the correct version number
openapi-generator-cli version
```
## Further Documentation
Please refer to the [official openapi-generator docs] for more information about the possible arguments and a detailed usage manual of the command line interface.
## Like the package?
Please leave a star.
## Have suggestions or feedback?
Please raise an issue, happy to hear from you :)
[OpenAPITools/openapi-generator]: <https://github.com/OpenAPITools/openapi-generator>
[maven repository]: <https://mvnrepository.com/artifact/org.openapitools/openapi-generator-cli>
[`jdk4py`]: <https://github.com/activeviam/jdk4py>
[official openapi-generator docs]: <https://github.com/OpenAPITools/openapi-generator#3---usage>
Raw data
{
"_id": null,
"home_page": "https://openapi-generator.tech",
"name": "openapi-generator-cli",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.9",
"maintainer_email": null,
"keywords": "openapi, generator, cli",
"author": "OpenAPI Generator community",
"author_email": "team@openapitools.org",
"download_url": "https://files.pythonhosted.org/packages/e1/ef/b3908fdcb7ac4bd5f5dd1d15d80b26b45e1905d7873e5e443f5968f6f742/openapi_generator_cli-7.10.0.post0.tar.gz",
"platform": null,
"description": "# OpenAPI Generator in Package Installer for Python (PIP)\n\n[](\n <https://join.slack.com/t/openapi-generator/shared_invite/zt-12jxxd7p2-XUeQM~4pzsU9x~eGLQqX2g>\n) [](\n <https://badge.fury.io/py/openapi-generator-cli>\n) [](\n <https://github.com/psf/black>\n) [](\n <https://github.com/astral-sh/ruff>\n)\n\nOpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec (both 2.0 and 3.0 are supported). Please see [OpenAPITools/openapi-generator]\n\n---\n\nThis project checks the [maven repository] once a day for a new version and will publish this new version automatically as a python package.\n\n## Installation\n\nYou must have the `java` binary executable available on your PATH for this to work. (JDK 11 is the minimal version supported. To install OpenJDK, please visit <https://adoptium.net/>)\n\nYou can install the package either in a virtual environment or globally.\n\n```sh\n# install the latest version of \"openapi-generator-cli\"\npip install openapi-generator-cli\n\n# install a specific version of \"openapi-generator-cli\"\npip install openapi-generator-cli==4.3.1\n```\n\nYou can also install with [`jdk4py`] instead of `java` binary. (`python>=3.10` is required)\n\n```sh\npip install openapi-generator-cli[jdk4py]\n```\n\nAfter installation `openapi-generator-cli` command will be available in your virtual environment or globally depending on your installation.\n\nTo check the version, for example. Type the following command\n\n```sh\n# this will print the correct version number\nopenapi-generator-cli version\n```\n\n## Further Documentation\n\nPlease refer to the [official openapi-generator docs] for more information about the possible arguments and a detailed usage manual of the command line interface.\n\n## Like the package?\n\nPlease leave a star.\n\n## Have suggestions or feedback?\n\nPlease raise an issue, happy to hear from you :)\n\n[OpenAPITools/openapi-generator]: <https://github.com/OpenAPITools/openapi-generator>\n[maven repository]: <https://mvnrepository.com/artifact/org.openapitools/openapi-generator-cli>\n[`jdk4py`]: <https://github.com/activeviam/jdk4py>\n[official openapi-generator docs]: <https://github.com/OpenAPITools/openapi-generator#3---usage>\n",
"bugtrack_url": null,
"license": "APACHE 2.0",
"summary": "CLI for openapi generator",
"version": "7.10.0.post0",
"project_urls": {
"Documentation": "https://github.com/OpenAPITools/openapi-generator#3---usage",
"Homepage": "https://openapi-generator.tech",
"Repository": "https://github.com/OpenAPITools/openapi-generator"
},
"split_keywords": [
"openapi",
" generator",
" cli"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6ca9b69e3eb2448384161622e3b5b48c071666051dec305ef2621dfe870df50a",
"md5": "31ae3f653bbca29bb5fd64ff58e19502",
"sha256": "79a4398cbddc57de03467b943e0e945bd23a613c571f4bebf7c93a0f341f30f4"
},
"downloads": -1,
"filename": "openapi_generator_cli-7.10.0.post0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "31ae3f653bbca29bb5fd64ff58e19502",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.9",
"size": 26973354,
"upload_time": "2024-12-05T15:27:55",
"upload_time_iso_8601": "2024-12-05T15:27:55.595568Z",
"url": "https://files.pythonhosted.org/packages/6c/a9/b69e3eb2448384161622e3b5b48c071666051dec305ef2621dfe870df50a/openapi_generator_cli-7.10.0.post0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e1efb3908fdcb7ac4bd5f5dd1d15d80b26b45e1905d7873e5e443f5968f6f742",
"md5": "34f49c2559c8f8abb45eaad77dc2467b",
"sha256": "e5f5caa6d954689bb001ced0647cddb975bf3095f7844a686991ef3c3bf2a207"
},
"downloads": -1,
"filename": "openapi_generator_cli-7.10.0.post0.tar.gz",
"has_sig": false,
"md5_digest": "34f49c2559c8f8abb45eaad77dc2467b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.9",
"size": 26960388,
"upload_time": "2024-12-05T15:28:12",
"upload_time_iso_8601": "2024-12-05T15:28:12.856584Z",
"url": "https://files.pythonhosted.org/packages/e1/ef/b3908fdcb7ac4bd5f5dd1d15d80b26b45e1905d7873e5e443f5968f6f742/openapi_generator_cli-7.10.0.post0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-05 15:28:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "OpenAPITools",
"github_project": "openapi-generator#3---usage",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"circle": true,
"appveyor": true,
"lcname": "openapi-generator-cli"
}
JSON
