Skip to main content

Generator of python HTTP-clients from OpenApi specification.

Project description

Awesome python HTTP-clients from OpenAPI

Build Status codecov Code style: black downloads python pypi license


Generator of python HTTP-clients from OpenApi specification based on httpx and pydantic

Documentation

Check documentation to see more details about the features. All documentation is in the "docs" directory and online at artsmolin.github.io/pythogen

Examples

Installation

Pip

pip install pythogen

Docker

docker pull artsmolin/pythogen

Generation

  • path/to/input — path to the directory with openapi.yaml;
  • path/to/output — the path to the directory where the generated client will be saved; Pip
pythogen path/to/input/openapi.yaml path/to/output/client.py

Docker

docker run \
-v ./path/to/input:/opt/path/to/input \
-v ./path/to/output:/opt/path/to/output \
artsmolin/pythogen \
path/to/input/openapi.yaml \
path/to/output/client.py

Usage

from petstore.client_async import Client
from petstore.client_async import Pet
from petstore.client_async import EmptyBody
from petstore.client_async import FindPetsByStatusQueryParams

client = Client(base_url="http://your.base.url")
pets: list[Pet] | EmptyBody = await client.findPetsByStatus(
  query_params=FindPetsByStatusQueryParams(status="available"),
)

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

pythogen-0.2.25.tar.gz (20.9 kB view hashes)

Uploaded Source

Built Distribution

pythogen-0.2.25-py3-none-any.whl (29.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page