Merge pull request #1 from openapi-json-schema-tools/adds_petstore

Adds samples and readme

Author: spacether

.DS_Store

@@ -1,2 +1,55 @@
 # openapi-python-client-comparison
 openapi python client comparison
+
+A repo to compare openapi python clients
+
+## Implementations Included
+- [swagger-codegen](https://github.com/swagger-api/swagger-codegen), python generator
+- [openapi-generator](https://github.com/OpenAPITools/openapi-generator)
+  - python-prior generator
+  - python-nextgen
+- [openapi-json-schema-generator](https://github.com/openapi-json-schema-tools/openapi-json-schema-generator), python generator
+
+## Openapi Documents and Purposes
+
+| Document | Purpose | Provenance |
+| -------- | ------- | ---------- |
+| petstore.yaml | standard api | [openapi-generator repo](https://github.com/OpenAPITools/openapi-generator/blob/917892db7d1dc5a459bdf6d499a491367fc97751/modules/openapi-generator/src/test/resources/3_0/petstore.yaml)
+
+## Generated Code Amount
+via vscode code counter tool
+
+### petstore.yaml
+
+| Generator | Files | Code |
+| -------- | ----- | ---- |
+| openapi_generator_python_nextgen | 27 | 2712 |
+| openapi_generator_python_prior | 30 | 5075 |
+| openapi_json_schema_generator_python | 365 | 12875
+
+Reasons for the openapi json scheme generator difference
+- has overload type hints on all endpoints, allows input content type selection
+- json paths used to create files so many files made
+- object models have getters written for optional properties
+
+## Generate
+
+docker run --rm -v ${PWD}:/local swaggerapi/swagger-codegen-cli:2.4.31 generate \
+    -i /local/petstore.yaml \
+    -l python \
+    -o /local/swagger_codegen_python
+
+docker run --rm -v "${PWD}:/local" openapitools/openapi-generator-cli:v6.5.0 generate \
+    -i /local/petstore.yaml \
+    -g python-prior \
+    -o /local/openapi_generator_python_prior
+
+docker run --rm -v "${PWD}:/local" openapitools/openapi-generator-cli:v6.5.0 generate \
+    -i /local/petstore.yaml \
+    -g python-nextgen \
+    -o /local/openapi_generator_python_nextgen
+
+docker run --rm -v "${PWD}:/local" openapjsonschematools/openapi-json-schema-generator-cli:2.0.0 generate \
+    -i /local/petstore.yaml \
+    -g python \
+    -o /local/openapi_json_schema_generator_python

README.md

@@ -0,0 +1,37 @@
+# NOTE: This file is auto generated by OpenAPI Generator.
+# URL: https://openapi-generator.tech
+#
+# ref: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: openapi_client Python package
+
+on: [push, pull_request]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.7", "3.8", "3.9", "3.10"]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install flake8 pytest
+          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+      - name: Lint with flake8
+        run: |
+          # stop the build if there are Python syntax errors or undefined names
+          flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+          # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+          flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+      - name: Test with pytest
+        run: |
+          pytest

petstore/openapi_generator_python_nextgen/.github/workflows/python.yml

@@ -0,0 +1,66 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+venv/
+.venv/
+.python-version
+.pytest_cache
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+#Ipython Notebook
+.ipynb_checkpoints

petstore/openapi_generator_python_nextgen/.gitignore

@@ -0,0 +1,25 @@
+# NOTE: This file is auto generated by OpenAPI Generator.
+# URL: https://openapi-generator.tech
+#
+# ref: https://docs.gitlab.com/ee/ci/README.html
+# ref: https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/ci/templates/Python.gitlab-ci.yml
+
+stages:
+  - test
+
+.pytest:
+  stage: test
+  script:
+   - pip install -r requirements.txt
+   - pip install -r test-requirements.txt
+   - pytest --cov=openapi_client
+
+pytest-3.7:
+  extends: .pytest
+  image: python:3.7-alpine
+pytest-3.8:
+  extends: .pytest
+  image: python:3.8-alpine
+pytest-3.9:
+  extends: .pytest
+  image: python:3.9-alpine

petstore/openapi_generator_python_nextgen/.gitlab-ci.yml

@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md

petstore/openapi_generator_python_nextgen/.openapi-generator-ignore

@@ -0,0 +1,48 @@
+.github/workflows/python.yml
+.gitignore
+.gitlab-ci.yml
+.openapi-generator-ignore
+.travis.yml
+README.md
+docs/ApiResponse.md
+docs/Category.md
+docs/Order.md
+docs/Pet.md
+docs/PetApi.md
+docs/StoreApi.md
+docs/Tag.md
+docs/User.md
+docs/UserApi.md
+git_push.sh
+openapi_client/__init__.py
+openapi_client/api/__init__.py
+openapi_client/api/pet_api.py
+openapi_client/api/store_api.py
+openapi_client/api/user_api.py
+openapi_client/api_client.py
+openapi_client/configuration.py
+openapi_client/exceptions.py
+openapi_client/models/__init__.py
+openapi_client/models/api_response.py
+openapi_client/models/category.py
+openapi_client/models/order.py
+openapi_client/models/pet.py
+openapi_client/models/tag.py
+openapi_client/models/user.py
+openapi_client/rest.py
+pyproject.toml
+requirements.txt
+setup.cfg
+setup.py
+test-requirements.txt
+test/__init__.py
+test/test_api_response.py
+test/test_category.py
+test/test_order.py
+test/test_pet.py
+test/test_pet_api.py
+test/test_store_api.py
+test/test_tag.py
+test/test_user.py
+test/test_user_api.py
+tox.ini

petstore/openapi_generator_python_nextgen/.openapi-generator/FILES

@@ -0,0 +1 @@
+6.5.0

petstore/openapi_generator_python_nextgen/.openapi-generator/VERSION

@@ -0,0 +1,17 @@
+# ref: https://docs.travis-ci.com/user/languages/python
+language: python
+python:
+  - "3.7"
+  - "3.8"
+  - "3.9"
+  - "3.10"
+  - "3.11"
+  # uncomment the following if needed
+  #- "3.11-dev"  # 3.11 development branch
+  #- "nightly"  # nightly build
+# command to install dependencies
+install:
+  - "pip install -r requirements.txt"
+  - "pip install -r test-requirements.txt"
+# command to run tests
+script: pytest --cov=openapi_client