@team-supercharge/oasg 13.1.2 → 13.2.0-feature-python-fastapi-3f657d88.0

package/README.md

@@ -656,6 +656,26 @@ TBD
 
 Publishing the PyPI packages is done with Twine. For authentication againts the PiPI repository you need to set the `TWINE_USERNAME` and `TWINE_PASSWORD` environment variables.
 
+
+#### `python-fastapi`
+
+```json
+{
+  "id": "server-python",
+  "type": "python-fastapi",
+  "source": "source-merged",
+  "packageName": "oasg_example",
+  "repositoryUrl": "https://gitlab.supercharge.io/api/v4/projects/1226/packages/pypi"
+}
+```
+
+|Parameter| Description| Required | Default |
+|-|-|-|-|
+| packageName | Package nem for the project (convention: snake_case) | Y | - |
+| repositoryUrl | URL of the PyPI repository | Y | - |
+
+Publishing the PyPI packages is done with Twine. For authentication againts the PiPI repository you need to set the `TWINE_USERNAME` and `TWINE_PASSWORD` environment variables.
+
 #### `contract-testing`
 
 ```json

package/bin/oasg

@@ -45,6 +45,7 @@ const DEFAULT_GENERATOR_MAPPING = {
   "nestjs":           { version: '7.0.1',   generator: 'typescript-angular' },
   "spring":           { version: '7.0.1',   generator: 'spring' },
   "spring-kotlin":    { version: '7.0.1',   generator: 'kotlin-spring' },
+  "python-fastapi":   { version: '7.0.1',   generator: 'python-fastapi' },
   // misc targets
   "contract-testing": { version: '4.3.1',   generator: 'typescript-node' },
   "openapi":          { version: undefined, generator: undefined },

package/config.schema.yml

@@ -20,6 +20,7 @@ properties:
         - $ref: '#/targets/Android'
         - $ref: '#/targets/ios'
         - $ref: '#/targets/Python'
+        - $ref: '#/targets/PythonFastApi'
         - $ref: '#/targets/ContractTesting'
         - $ref: '#/targets/NestJS'
         - $ref: '#/targets/OpenAPI'
@@ -295,6 +296,20 @@ targets:
         - packageName
         - repositoryUrl
 
+  PythonFastApi:
+    allOf:
+      - $ref: '#/targets/Base'
+      - properties:
+          type:
+            pattern: "^python-fastapi$"
+          packageName:
+            type: string
+          repositoryUrl:
+            type: string
+        required:
+        - packageName
+        - repositoryUrl
+
   ContractTesting:
     allOf:
       - $ref: '#/targets/Base'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@team-supercharge/oasg",
-  "version": "13.1.2",
+  "version": "13.2.0-feature-python-fastapi-3f657d88.0",
   "description": "Node-based tool to lint OpenAPI documents and generate clients, servers and documentation from them",
   "author": "Supercharge",
   "license": "MIT",

package/targets/python-fastapi/generate.sh

@@ -0,0 +1,29 @@
+#/bin/bash
+
+source $(dirname "$0")/../common.sh
+
+# change npm pre-release syntax (with - after semver) to python local syntax (with + after semver)
+version=$(echo $version | sed 's/-/\+/')
+echo "[NOTE] version updated to: ${version}"
+
+rm -rf out/$targetId
+mkdir -p out/$targetId
+
+java -jar $binary generate \
+  -g $generatorId \
+  -i $openApiFile \
+  -t $templateDir \
+  -o out/$targetId \
+  -c $(dirname "$0")/generator-config.json \
+  -p "packageVersion=$version,packageName=$packageName" $generatorCustomArgs
+
+cd out/$targetId
+
+touch "src/$packageName/__init__.py"
+python3 -m venv venv
+source venv/bin/activate
+pip install --upgrade pip
+pip install flit==3.9.0
+flit build --no-use-vcs
+
+cd ../../

package/targets/python-fastapi/generator-config.json

@@ -0,0 +1,7 @@
+{
+  "inlineSchemaOptions": {
+    "ARRAY_ITEM_SUFFIX": "",
+    "MAP_ITEM_SUFFIX": "",
+    "SKIP_SCHEMA_REUSE": "true"
+  }
+}

package/targets/python-fastapi/publish.sh

@@ -0,0 +1,9 @@
+#/bin/bash
+
+source $(dirname "$0")/../common.sh
+
+cd out/$targetId
+source venv/bin/activate
+pip install twine==4.0.2
+python3 -m twine upload --repository-url $repositoryUrl dist/*
+cd ../..

package/targets/python-fastapi/templates/pyproject_toml.mustache

@@ -0,0 +1,35 @@
+[project]
+name = "{{packageName}}"
+version = "{{appVersion}}"
+description = "{{appDescription}}"
+
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.black]
+line-length = 88
+exclude = '''
+(
+  /(
+      \.eggs         # exclude a few common directories in the
+    | \.git          # root of the project
+    | \.hg
+    | \.mypy_cache
+    | \.tox
+    | \.venv
+    | _build
+    | buck-out
+    | build
+    | dist
+  )/
+)
+'''
+
+[tool.isort]
+profile = "black"
+skip = [
+    '.eggs', '.git', '.hg', '.mypy_cache', '.nox', '.pants.d', '.tox',
+    '.venv', '_build', 'buck-out', 'build', 'dist', 'node_modules', 'venv',
+]
+skip_gitignore = true