Skip to content

Commit e5fd39a

Browse files
committed
Prepare 0.2.0 Release
- Bump version to 0.2.0 - Update changelog - Add note about async API to generated READMEs
1 parent dac9b25 commit e5fd39a

File tree

4 files changed

+32
-4
lines changed

4 files changed

+32
-4
lines changed

Diff for: CHANGELOG.md

+13-3
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,19 @@ All notable changes to this project will be documented in this file.
44
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
55
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
66

7-
# Unreleased
8-
- Update Typer dependency to 0.1.0 and remove click-completion dependency
9-
- Add a `--version` option to print the version of openapi-python-client and exit
7+
## 0.2.0 - 2020-03-22
8+
### Changes
9+
- Update Typer dependency to 0.1.0 and remove click-completion dependency (#19)
10+
- Switched to httpx from requests for both this tool and generated clients (#15)
11+
12+
### Additions
13+
- `--version` option to print the version of openapi-python-client and exit
14+
- `--config` option for passing a config.yml file to override generated class names (#9)
15+
- Generated clients will now have some basic Poetry usage in their README.md (#13)
16+
- Generated clients will now have an async_api module for async versions of every function in the api module (#16)
17+
- Generated clients will be auto-formatted with isort and black (#12)
18+
- Generated clients will have a .gitignore covering some basics (#14)
19+
- A number of additions to the README including recommending pipx (#20)
1020

1121
## 0.1.2 - 2020-03-16
1222
- Improve handling of optional properties in generated `to_dict` function for models

Diff for: openapi_python_client/templates/README.md

+9
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,15 @@ from {{ package_name }}.api.my_tag import get_my_data_model
2727
my_data: MyDataModel = get_my_data_model(client=client)
2828
```
2929

30+
Or do the same thing with an async version:
31+
32+
```python
33+
from {{ package_name }}.models import MyDataModel
34+
from {{ package_name }}.async_api.my_tag import get_my_data_model
35+
36+
my_data: MyDataModel = await get_my_data_model(client=client)
37+
```
38+
3039
Things to know:
3140
1. Every path/method combo becomes a Python function with type annotations.
3241
1. All path/query params, and bodies become method arguments.

Diff for: pyproject.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "openapi-python-client"
3-
version = "0.1.2"
3+
version = "0.2.0"
44
description = "Generate modern Python clients from OpenAPI"
55

66
authors = [

Diff for: tests/test_end_to_end/golden-master/README.md

+9
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,15 @@ from my_test_api_client.api.my_tag import get_my_data_model
2727
my_data: MyDataModel = get_my_data_model(client=client)
2828
```
2929

30+
Or do the same thing with an async version:
31+
32+
```python
33+
from my_test_api_client.models import MyDataModel
34+
from my_test_api_client.async_api.my_tag import get_my_data_model
35+
36+
my_data: MyDataModel = await get_my_data_model(client=client)
37+
```
38+
3039
Things to know:
3140
1. Every path/method combo becomes a Python function with type annotations.
3241
1. All path/query params, and bodies become method arguments.

0 commit comments

Comments
 (0)