Metadata-Version: 2.1
Name: openapi-python-client
Version: 0.3.0
Summary: Generate modern Python clients from OpenAPI
Home-page: https://github.com/triaxtec/openapi-python-client
Author: Dylan Anthony
Author-email: danthony@triaxtec.com
Requires-Python: >=3.8.0,<4.0.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Requires-Dist: black (>=19.10b0,<20.0)
Requires-Dist: colorama (>=0.4.3,<0.5.0); sys_platform == "win32"
Requires-Dist: httpx (>=0.12.1,<0.13.0)
Requires-Dist: isort (>=4.3.21,<5.0.0)
Requires-Dist: jinja2 (>=2.11.1,<3.0.0)
Requires-Dist: pyyaml (>=5.3.1,<6.0.0)
Requires-Dist: shellingham (>=1.3.2,<2.0.0)
Requires-Dist: stringcase (>=1.2.0,<2.0.0)
Requires-Dist: typer (>=0.1.0,<0.2.0)
Project-URL: Repository, https://github.com/triaxtec/openapi-python-client
Description-Content-Type: text/markdown

[![triaxtec](https://circleci.com/gh/triaxtec/openapi-python-client.svg?style=svg)](https://circleci.com/gh/triaxtec/openapi-python-client)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
[![codecov](https://codecov.io/gh/triaxtec/openapi-python-client/branch/master/graph/badge.svg)](https://codecov.io/gh/triaxtec/openapi-python-client)
[![PyPI version shields.io](https://img.shields.io/pypi/v/openapi-python-client.svg)](https://pypi.python.org/pypi/openapi-python-client/)

# openapi-python-client
Generate modern Python clients from OpenAPI

**This project is still in early development and does not support all OpenAPI features**

## Why This?
The Python clients generated by openapi-generator support Python 2 and therefore come with a lot of baggage. This tool 
aims to generate clients which:
1. Use all the latest and greatest Python features like type annotations and dataclasses
1. Don't carry around a bunch of compatibility code for older version of Python (e.g. the `six` package)
1. Have better documentation and more obvious usage instructions

Additionally, because this generator is written in Python, it should be more accessible to contribution by the people 
using it (Python developers).

## Installation
I recommend you install with [pipx](https://pipxproject.github.io/pipx/)  so you don't conflict with any other packages 
you might have: `pipx install openapi-python-client`.

Better yet, use `pipx run openapi-python-client <normal params / options>` to always use the latest version of the generator.

You can install with normal pip if you want to though: `pip install openapi-python-client`

Then, if you want tab completion: `openapi-python-client --install-completion`

## Usage
### Create a new client
`openapi-python-client generate --url https://my.api.com/openapi.json`

This will generate a new client library named based on the title in your OpenAPI spec.  For example, if the title 
of your API is "My API", the expected output will be "my-api-client".  If a folder already exists by that name, you'll 
get an error.

### Update an existing client
`openapi-python-client update --url https://my.api.com/openapi.json`

> For more usage details run `openapi-python-client --help` or read [usage](usage.md)

## What You Get
1. A `pyproject.toml` file with some basic metadata intended to be used with [Poetry].
1. A `README.md` you'll most definitely need to update with your project's details
1. A Python module named just like the auto-generated project name (e.g. "my_api_client") which contains:
    1. A `client` module which will have both a `Client` class and an `AuthenticatedClient` class.  You'll need these 
    for calling the functions in the `api` module.
    1. An `api` module which will contain one module for each tag in your OpenAPI spec, as well as a `default` module 
    for endpoints without a tag.  Each of these modules in turn contains one function for calling each endpoint.
    1. A `models` module which has all the classes defined by the various schemas in your OpenAPI spec
    
For a full example you can look at tests/test_end_to_end which has a declared [FastAPI](https://fastapi.tiangolo.com/) 
server and the resulting openapi.json file in the "fastapi" directory.  "golden-master" is the generated client from that 
OpenAPI document.
    
## OpenAPI features supported
1. All HTTP Methods
1. JSON and form bodies, path and query parameters
1. float, string, int, date, datetime, string enums, and custom schemas or lists containing any of those
1. html/text or application/json responses containing any of the previous types
1. Bearer token security

## Configuration
You can pass a YAML (or JSON) file to openapi-python-client in order to change some behavior.  The following parameters 
are supported:

### class_overrides
Used to change the name of generated model classes.  This param should be a mapping of existing class name 
(usually a key in the "schemas" section of your OpenAPI document) to class_name and module_name. As an example, if the 
name of the a model in OpenAPI (and therefore the generated class name) was something like "_PrivateInternalLongName" 
and you want the generated client's model to be called "ShortName" in a module called "short_name" you could do this:

Example:
```yaml
class_overrides:
    _PrivateInternalLongName:
      class_name: ShortName
      module_name: short_name
```

The easiest way to find what needs to be overridden is probably to generate your client and go look at everything in the
 models folder.


## Contributors 
 - Dylan Anthony <danthony@triaxtec.com> (Owner)


[CHANGELOG.md]: CHANGELOG.md
[Poetry]: https://python-poetry.org/

