Skip to content

Commit 703d3b4

Browse files
committed
Update metadata/docs for 0.4.0
1 parent f94c963 commit 703d3b4

File tree

3 files changed

+18
-13
lines changed

3 files changed

+18
-13
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
[![triaxtec](https://circleci.com/gh/triaxtec/openapi-python-client.svg?style=svg)](https://circleci.com/gh/triaxtec/openapi-python-client)
2-
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
32
[![codecov](https://codecov.io/gh/triaxtec/openapi-python-client/branch/master/graph/badge.svg)](https://codecov.io/gh/triaxtec/openapi-python-client)
43
[![PyPI version shields.io](https://img.shields.io/pypi/v/openapi-python-client.svg)](https://pypi.python.org/pypi/openapi-python-client/)
4+
[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://lbesson.mit-license.org/)
5+
[![Generic badge](https://img.shields.io/badge/type_checked-mypy-informational.svg)](https://mypy.readthedocs.io/en/stable/introduction.html)
6+
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
7+
58

69
# openapi-python-client
710
Generate modern Python clients from OpenAPI
@@ -51,20 +54,21 @@ get an error.
5154
for endpoints without a tag. Each of these modules in turn contains one function for calling each endpoint.
5255
1. A `models` module which has all the classes defined by the various schemas in your OpenAPI spec
5356

54-
For a full example you can look at tests/test_end_to_end which has a declared [FastAPI](https://fastapi.tiangolo.com/)
57+
For a full example you can look at the `test_end_to_end` directory which has a declared [FastAPI](https://fastapi.tiangolo.com/)
5558
server and the resulting openapi.json file in the "fastapi" directory. "golden-master" is the generated client from that
5659
OpenAPI document.
5760

5861
## OpenAPI features supported
5962
1. All HTTP Methods
6063
1. JSON and form bodies, path and query parameters
64+
1. File uploads with multipart/form-data bodies
6165
1. float, string, int, date, datetime, string enums, and custom schemas or lists containing any of those
6266
1. html/text or application/json responses containing any of the previous types
6367
1. Bearer token security
6468

6569
## Configuration
66-
You can pass a YAML (or JSON) file to openapi-python-client in order to change some behavior. The following parameters
67-
are supported:
70+
You can pass a YAML (or JSON) file to openapi-python-client with the `--config` option in order to change some behavior.
71+
The following parameters are supported:
6872

6973
### class_overrides
7074
Used to change the name of generated model classes. This param should be a mapping of existing class name
@@ -84,9 +88,5 @@ The easiest way to find what needs to be overridden is probably to generate your
8488
models folder.
8589
8690
87-
## Contributors
88-
- Dylan Anthony <danthony@triaxtec.com> (Owner)
89-
90-
9191
[CHANGELOG.md]: CHANGELOG.md
9292
[Poetry]: https://python-poetry.org/

pyproject.toml

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,17 @@
11
[tool.poetry]
22
name = "openapi-python-client"
3-
version = "0.3.0"
3+
version = "0.4.0"
44
description = "Generate modern Python clients from OpenAPI"
55
repository = "https://github.com/triaxtec/openapi-python-client"
6-
7-
authors = [
8-
"Dylan Anthony <danthony@triaxtec.com>",
6+
license = "MIT"
7+
keywords=["OpenAPI", "Client", "Generator"]
8+
authors = ["Dylan Anthony <danthony@triaxtec.com>"]
9+
classifiers = [
10+
"Development Status :: 3 - Alpha",
11+
"Intended Audience :: Developers",
12+
"Topic :: Software Development :: Code Generators",
13+
"Typing :: Typed",
914
]
10-
1115
readme = "README.md"
1216
packages = [
1317
{include = "openapi_python_client"},

usage.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ $ openapi-python-client [OPTIONS] COMMAND [ARGS]...
1111
**Options**:
1212

1313
* `--version`: Print the version and exit
14+
* `--config PATH`: Path to the config file to use
1415
* `--install-completion`: Install completion for the current shell.
1516
* `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
1617
* `--help`: Show this message and exit.

0 commit comments

Comments
 (0)