OpenAPI Python client generator that follows the KISS principle.
Project description
Simple Open API Client generator
This project was made to generate a simple client (async or not) from an openapi specifications (unlike other client generators, which typically produce code that is difficult for python beginners to use). It aims to produce a single file that contains the Client class.
Notes
This project is in alpha and has probably bugs. Issues/bugfixes/additions are welcome.
Installation
$ pip install simple-openapi-client
Usage
This package is usage from a Python script. Simply load the openapi file (from local file or url) and make the client.
For instance:
from simple_openapi_client import parse_openapi, make_client, Config
config = Config(client_name='Orthanc', package_name='client')
document = parse_openapi(url_or_path='https://api.orthanc-server.com/orthanc-openapi.json')
client_str = make_client(document, config, use_black=True)
with open(f'./{config.package_name}.py', 'w') as file:
file.write(client_str)
Or, for an async client:
from simple_openapi_client import parse_openapi, make_client, Config
config = Config(client_name='AsyncOrthanc', package_name='async_client')
document = parse_openapi(url_or_path='https://api.orthanc-server.com/orthanc-openapi.json')
client_str = make_client(document, config, async_mode=True, use_black=True)
with open(f'./{config.package_name}.py', 'w') as file:
file.write(client_str)
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
Close
Hashes for simple_openapi_client-0.5.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 02899d8401bb461d9f885755f014c613ea192e445ddefbd6af1888792a675f9a |
|
MD5 | bb51dac914fa4362c0ef6e9a57228959 |
|
BLAKE2b-256 | 063018f2e315bbbf95b90f0a98af092cd6f6d8b0326e734fb7c51369ecaf85e5 |
Close
Hashes for simple_openapi_client-0.5.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8c175557b6e4adf37300fe7687b21f806571c74cc5a836a232ab13c6269ed069 |
|
MD5 | bac65e965828cb571c6c6d6c8544a363 |
|
BLAKE2b-256 | a8c819d9ac27e54f10ba4476e7574dc56c37367309007f40a7522ff4a402f3aa |