Skip to content

docs: Remove openapi generation python2 compatibility claim #499

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Sep 25, 2021
Merged

docs: Remove openapi generation python2 compatibility claim #499

Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
a7c6215
Update README.md
rtaycher Sep 21, 2021
7683189
Update README.md
rtaycher Sep 21, 2021
83fb841
Update README.md
rtaycher Sep 21, 2021
afc0e79
Update README.md
rtaycher Sep 21, 2021
599f1c2
Apply suggestions from code review
rtaycher Sep 22, 2021
8584918
Update README.md
rtaycher Sep 22, 2021
a08970c
Update README.md
dbanty Sep 25, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 4 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,11 @@ version 3 first with one of many available converters._

## 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:
The Python clients generated by openapi-generator comes some downsides. This tool aims to improve on it by:

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).
1. Generating clients which use all the latest and greatest Python features like type annotations and dataclasses.
2. Having better documentation and more obvious usage instructions.
3. Being easier to improve and extend, especially for python developers. Since openapi-python-client is written in python and jinja2 templates, while openapi-generator is a larger Java project which uses more restrictive mustache templates.

## Installation

Expand Down