From a7c621558b53797791a14ac814a11003d1b3e2c6 Mon Sep 17 00:00:00 2001 From: "Roman A. Taycher" Date: Tue, 21 Sep 2021 01:59:19 -0700 Subject: [PATCH 1/7] Update README.md remove python compatibility claim --- README.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1daee8c04..45626b88d 100644 --- a/README.md +++ b/README.md @@ -17,12 +17,10 @@ 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 generating 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 +2. 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). From 76831892f55679a18a5df84134b219c66f8d44de Mon Sep 17 00:00:00 2001 From: "Roman A. Taycher" Date: Tue, 21 Sep 2021 02:17:21 -0700 Subject: [PATCH 2/7] Update README.md add note about being written in python --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 45626b88d..94d60dcf7 100644 --- a/README.md +++ b/README.md @@ -17,10 +17,11 @@ version 3 first with one of many available converters._ ## Why This? -The Python clients generated by openapi-generator comes some downsides. This tool aims to improve on it by generating 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 -2. Have better documentation and more obvious usage instructions +1. Ggenerating 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 imrpove and extend, since it's written in python and jinja2 templates while openapi-generator is a large Java probject which uses Mustache templates. Additionally, because this generator is written in Python, it should be more accessible to contribution by the people using it (Python developers). From 83fb841865947c75bd5846a4ad7e34e2767eada4 Mon Sep 17 00:00:00 2001 From: "Roman A. Taycher" Date: Tue, 21 Sep 2021 02:23:33 -0700 Subject: [PATCH 3/7] Update README.md fix double Gg, add periods --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 94d60dcf7..b801b3bbe 100644 --- a/README.md +++ b/README.md @@ -19,9 +19,9 @@ version 3 first with one of many available converters._ The Python clients generated by openapi-generator comes some downsides. This tool aims to improve on it by: -1. Ggenerating 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 imrpove and extend, since it's written in python and jinja2 templates while openapi-generator is a large Java probject which uses Mustache templates. +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 imrpove and extend. Since it's written in python and jinja2 templates while openapi-generator is a larger Java probject which uses mustache templates. Additionally, because this generator is written in Python, it should be more accessible to contribution by the people using it (Python developers). From afc0e7957236a7673dfd80182795e51c625857b8 Mon Sep 17 00:00:00 2001 From: "Roman A. Taycher" Date: Tue, 21 Sep 2021 02:26:33 -0700 Subject: [PATCH 4/7] Update README.md --- README.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/README.md b/README.md index b801b3bbe..92425e70b 100644 --- a/README.md +++ b/README.md @@ -21,10 +21,7 @@ The Python clients generated by openapi-generator comes some downsides. This too 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 imrpove and extend. Since it's written in python and jinja2 templates while openapi-generator is a larger Java probject which uses mustache templates. - -Additionally, because this generator is written in Python, it should be more accessible to contribution by the people -using it (Python developers). +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 From 599f1c28885a03c630c8f8e93c09a41db0f16fff Mon Sep 17 00:00:00 2001 From: "Roman A. Taycher" Date: Wed, 22 Sep 2021 01:11:29 -0700 Subject: [PATCH 5/7] Apply suggestions from code review Co-authored-by: Dylan Anthony <43723790+dbanty@users.noreply.github.com> --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 92425e70b..ba4cc00d7 100644 --- a/README.md +++ b/README.md @@ -17,10 +17,10 @@ version 3 first with one of many available converters._ ## Why This? -The Python clients generated by openapi-generator comes some downsides. This tool aims to improve on it by: +This tool focuses on creating the best developer experience for Python developers by: -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. +1. Using all the latest and greatest Python features like type annotations and dataclasses. +1. Having documentation and usage instructions specific to this one generator. 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 From 8584918405a7e1e70af3c12ea2a3a2b33d69a1b9 Mon Sep 17 00:00:00 2001 From: "Roman A. Taycher" Date: Wed, 22 Sep 2021 01:14:12 -0700 Subject: [PATCH 6/7] Update README.md fix number in numbered list --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ba4cc00d7..a0f367cff 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ version 3 first with one of many available converters._ This tool focuses on creating the best developer experience for Python developers by: 1. Using all the latest and greatest Python features like type annotations and dataclasses. -1. Having documentation and usage instructions specific to this one generator. +2. Having documentation and usage instructions specific to this one generator. 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 From a08970c13974e9ddebac69c58c22269bc6ead912 Mon Sep 17 00:00:00 2001 From: Dylan Anthony <43723790+dbanty@users.noreply.github.com> Date: Sat, 25 Sep 2021 14:35:59 -0600 Subject: [PATCH 7/7] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a0f367cff..99dc20556 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ This tool focuses on creating the best developer experience for Python developer 1. Using all the latest and greatest Python features like type annotations and dataclasses. 2. Having documentation and usage instructions specific to this one generator. -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. +1. Being written in Python with Jinja2 templates, making it easier to improve and extend for Python developers. It's also much easier to install and use if you already have Python. ## Installation