OpenAPI Client Generator
Project description
OpenAPI Client Generator
This CLI utility allows you to generate Python client packages from OpenAPI v3 specifications. The project aims at supporting any generic valid specification.
Features
works on Python 3.8 and above;
generates clients with type hints to aid static analysis of higher level interfaces that would use the clients;
supports streaming endpoints.
Installation
You can install it from PyPI:
pip install openapi-client-generator
Afterwards, use a CLI utility called openapi-client-generator:
$ openapi-client-generator --help
usage: openapi-client-generator [-h] [-V] {gen} ...
OpenAPI Client Generator
optional arguments:
-h, --help show this help message and exit
-V, --version show program's version number and exit
sub-commands:
valid sub-commands
{gen} additional help
gen Generate client for a provided schema (JSON, YAML).
Contributing
Cloning this repo
The proper way to clone this repo is:
git clone --recurse-submodules <repo-url> <local-project-root>
cd <local-project-root>
# for showing submodule status with `git status`
git config status.submodulesummary 1
# for logging submodule diff with `git diff`
git config diff.submodule log
Test framework
The project uses Nix for bootstrapping its dev environment.
You can run existing test suite with
$ nix-shell --run "make test"
Documentation
Documentation is hosted on ReadTheDocs: https://openapi-client-generator.readthedocs.io/en/develop/
Changelog
See CHANGELOG.
LICENSE
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for openapi-client-generator-1.0.8.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6e88bdf2cd75641c95a81b6b3c87ff8f88e511a46f7bf30931f3580bbac6c6e2 |
|
MD5 | 7c9df4ea237b9f4d47bf55a99bd1ea53 |
|
BLAKE2b-256 | 8e5cf6038b4661ddd583692c7acd0e720aab07f097d136f4855f985732ea1dd4 |
Hashes for openapi_client_generator-1.0.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c127a87638b1c9e996cddb6334ef140eb49bb867cb44739208a81caf4d440342 |
|
MD5 | b50b06dd92e771e94017e1eeb818f267 |
|
BLAKE2b-256 | ae9c2456ddc475f15f3fcfbc8ddb7a315fc71f0943ad89c818e4fe45ab3261cf |