# Openapi Python Generator
[][pypi_]
[][status]
[][python version]
[][license]
[][documentation]
[][tests]
[][codecov]
[][pre-commit]
[][black]
[pypi_]: https://pypi.org/project/openapi-python-generator/
[status]: https://pypi.org/project/openapi-python-generator/
[python version]: https://pypi.org/project/openapi-python-generator
[documentation]: https://marcomuellner.github.io/openapi-python-generator/
[tests]: https://github.com/MarcoMuellner/openapi-python-generator/actions?workflow=Tests
[codecov]: https://app.codecov.io/gh/MarcoMuellner/openapi-python-generator
[pre-commit]: https://github.com/pre-commit/pre-commit
[black]: https://github.com/psf/black
---
__Documentation:__ [here][documentation]
---
## Features
- __Ease of use__. Provide input, output and the library, and the generator will do the rest.
- __Type safety and type hinting.__ __OpenAPI python generator__ makes heavy use of pydantic models to provide type-safe data structures.
- __Support for multiple rest frameworks.__ __OpenAPI python generator__ currently supports the following:
- [httpx](https://pypi.org/project/httpx/)
- [requests](https://pypi.org/project/requests/)
- [aiohttp](https://pypi.org/project/aiohttp/)
- __Async and sync code generation support__, depending on the framework. It will automatically create both for frameworks that support both.
- __Easily extendable using Jinja2 templates__. The code is designed to be easily extendable and should support even more languages and frameworks in the future.
- __Fully tested__. Every generated code is automatically tested against the OpenAPI spec and we have 100% coverage.
- __Usage as CLI or as library__.
## Requirements
- Python 3.7+
## Installation
You can install _Openapi Python Generator_ via [pip] from [PyPI]:
```console
$ pip install openapi-python-generator
```
## Usage
Please see the [Quick start page] for details.
## Roadmap
- Support for all commonly used http libraries in the python ecosystem (~~requests~~, urllib, ...)
- Support for multiple languages
- Support for multiple authentication schemes
- Support custom themes
## Contributing
Contributions are very welcome.
To learn more, see the [Contributor Guide].
## License
Distributed under the terms of the [MIT license][license],
_Openapi Python Generator_ is free and open source software.
## Issues
If you encounter any problems,
please [file an issue] along with a detailed description.
## Credits
Special thanks to the peeps from [openapi-schema-pydantic](https://github.com/kuimono/openapi-schema-pydantic),
which already did a lot of the legwork by providing a pydantic schema for the OpenAPI 3.0.0+ specification.
This project was generated from [@cjolowicz]'s [Hypermodern Python Cookiecutter] template.
[@cjolowicz]: https://github.com/cjolowicz
[pypi]: https://pypi.org/
[hypermodern python cookiecutter]: https://github.com/cjolowicz/cookiecutter-hypermodern-python
[file an issue]: https://github.com/MarcoMuellner/openapi-python-generator/issues
[pip]: https://pip.pypa.io/
<!-- github-only -->
[license]: https://github.com/MarcoMuellner/openapi-python-generator/blob/main/LICENSE
[contributor guide]: https://github.com/MarcoMuellner/openapi-python-generator/blob/main/CONTRIBUTING.md
[Quick start page]: https://marcomuellner.github.io/openapi-python-generator/quick_start/
Raw data
{
"_id": null,
"home_page": "https://github.com/MarcoMuellner/openapi-python-generator",
"name": "openapi-python-generator",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "OpenAPI, Generator, Python, async",
"author": "Marco M\u00fcllner",
"author_email": "muellnermarco@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/e3/ec/c6765e3dffc7e018f90be393fae7b0ebb35f5ca03f149eec3d7594e52bd1/openapi_python_generator-1.1.1.tar.gz",
"platform": null,
"description": "# Openapi Python Generator\n\n[][pypi_]\n[][status]\n[][python version]\n[][license]\n\n[][documentation]\n[][tests]\n[][codecov]\n\n[][pre-commit]\n[][black]\n\n[pypi_]: https://pypi.org/project/openapi-python-generator/\n[status]: https://pypi.org/project/openapi-python-generator/\n[python version]: https://pypi.org/project/openapi-python-generator\n[documentation]: https://marcomuellner.github.io/openapi-python-generator/\n[tests]: https://github.com/MarcoMuellner/openapi-python-generator/actions?workflow=Tests\n[codecov]: https://app.codecov.io/gh/MarcoMuellner/openapi-python-generator\n[pre-commit]: https://github.com/pre-commit/pre-commit\n[black]: https://github.com/psf/black\n\n\n\n---\n__Documentation:__ [here][documentation]\n\n---\n\n## Features\n\n- __Ease of use__. Provide input, output and the library, and the generator will do the rest.\n- __Type safety and type hinting.__ __OpenAPI python generator__ makes heavy use of pydantic models to provide type-safe data structures.\n- __Support for multiple rest frameworks.__ __OpenAPI python generator__ currently supports the following:\n - [httpx](https://pypi.org/project/httpx/)\n - [requests](https://pypi.org/project/requests/)\n - [aiohttp](https://pypi.org/project/aiohttp/)\n- __Async and sync code generation support__, depending on the framework. It will automatically create both for frameworks that support both.\n- __Easily extendable using Jinja2 templates__. The code is designed to be easily extendable and should support even more languages and frameworks in the future.\n- __Fully tested__. Every generated code is automatically tested against the OpenAPI spec and we have 100% coverage.\n- __Usage as CLI or as library__.\n\n## Requirements\n\n- Python 3.7+\n\n## Installation\n\nYou can install _Openapi Python Generator_ via [pip] from [PyPI]:\n\n```console\n$ pip install openapi-python-generator\n```\n\n## Usage\n\nPlease see the [Quick start page] for details.\n\n## Roadmap\n\n- Support for all commonly used http libraries in the python ecosystem (~~requests~~, urllib, ...)\n- Support for multiple languages\n- Support for multiple authentication schemes\n- Support custom themes\n\n## Contributing\n\nContributions are very welcome.\nTo learn more, see the [Contributor Guide].\n\n## License\n\nDistributed under the terms of the [MIT license][license],\n_Openapi Python Generator_ is free and open source software.\n\n## Issues\n\nIf you encounter any problems,\nplease [file an issue] along with a detailed description.\n\n## Credits\n\nSpecial thanks to the peeps from [openapi-schema-pydantic](https://github.com/kuimono/openapi-schema-pydantic),\nwhich already did a lot of the legwork by providing a pydantic schema for the OpenAPI 3.0.0+ specification.\n\nThis project was generated from [@cjolowicz]'s [Hypermodern Python Cookiecutter] template.\n\n[@cjolowicz]: https://github.com/cjolowicz\n[pypi]: https://pypi.org/\n[hypermodern python cookiecutter]: https://github.com/cjolowicz/cookiecutter-hypermodern-python\n[file an issue]: https://github.com/MarcoMuellner/openapi-python-generator/issues\n[pip]: https://pip.pypa.io/\n\n<!-- github-only -->\n\n[license]: https://github.com/MarcoMuellner/openapi-python-generator/blob/main/LICENSE\n[contributor guide]: https://github.com/MarcoMuellner/openapi-python-generator/blob/main/CONTRIBUTING.md\n[Quick start page]: https://marcomuellner.github.io/openapi-python-generator/quick_start/\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Openapi Python Generator",
"version": "1.1.1",
"project_urls": {
"Changelog": "https://github.com/MarcoMuellner/openapi-python-generator/releases",
"Documentation": "https://openapi-python-generator.readthedocs.io",
"Homepage": "https://github.com/MarcoMuellner/openapi-python-generator",
"Repository": "https://github.com/MarcoMuellner/openapi-python-generator"
},
"split_keywords": [
"openapi",
" generator",
" python",
" async"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0054ff7e26d089b45cb04b0bf95092092fded7c9fdfd62a14c8996b2e3929487",
"md5": "e103225aff6c285d8cab7a5c5b391639",
"sha256": "4bcb51ad0682bfb98f1feefed9855e4f48043a16b178af7c1ecda2056dd938a0"
},
"downloads": -1,
"filename": "openapi_python_generator-1.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e103225aff6c285d8cab7a5c5b391639",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 24768,
"upload_time": "2024-12-13T11:50:21",
"upload_time_iso_8601": "2024-12-13T11:50:21.067129Z",
"url": "https://files.pythonhosted.org/packages/00/54/ff7e26d089b45cb04b0bf95092092fded7c9fdfd62a14c8996b2e3929487/openapi_python_generator-1.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e3ecc6765e3dffc7e018f90be393fae7b0ebb35f5ca03f149eec3d7594e52bd1",
"md5": "3f6f90972ad264ba9dda5447f9ecc031",
"sha256": "0e303be0450be40cc3b8b6262e4ac93934f5a5246978ccfbf7c9cab790c38375"
},
"downloads": -1,
"filename": "openapi_python_generator-1.1.1.tar.gz",
"has_sig": false,
"md5_digest": "3f6f90972ad264ba9dda5447f9ecc031",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 17446,
"upload_time": "2024-12-13T11:50:23",
"upload_time_iso_8601": "2024-12-13T11:50:23.353161Z",
"url": "https://files.pythonhosted.org/packages/e3/ec/c6765e3dffc7e018f90be393fae7b0ebb35f5ca03f149eec3d7594e52bd1/openapi_python_generator-1.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-13 11:50:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MarcoMuellner",
"github_project": "openapi-python-generator",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "openapi-python-generator"
}
JSON
