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
Release files for openapi-client-generator 1.0.13
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| openapi-client-generator-1.0.13.tar.gz | 21.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| openapi_client_generator-1.0.13-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 46.8 kB
Release files / openapi-client-generator-1.0.13.tar.gz
| Download URL | openapi-client-generator-1.0.13.tar.gz |
|---|---|
| Size | 21.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
914a2db782270a5ec48db6376cce803eae04c49fa71f55117efd3b69a7d3f4c2
|
|
BLAKE2b-256 checksum How to use checksums |
b87ce55c52ce6b5bf7779cb82e985166c4a1e8544495da28c3d8cd79d1f75ff6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/50.3.1.post0 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.9.0
|
Release files / openapi_client_generator-1.0.13-py3-none-any.whl
| Download URL | openapi_client_generator-1.0.13-py3-none-any.whl |
|---|---|
| Size | 25.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0b9d0c5547eb3f86b774d7b7b3a43ef7441962f65084d135b267951dc4ce7e8c
|
|
BLAKE2b-256 checksum How to use checksums |
d55557cf7181c5190357b815b3c186a70b6d6faeae19d59079873e041962f707
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/50.3.1.post0 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.9.0
|