@team-supercharge/oasg 4.0.2 → 4.1.0

package/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [4.1.0](https://gitlab.com/team-supercharge/oasg/compare/v4.0.2...v4.1.0) (2022-03-22)
+
+
+### Features
+
+* add the ability to setup default generator version by target ([0abbc90](https://gitlab.com/team-supercharge/oasg/commit/0abbc90ba0d4af97c577d76ca1f451f825e3a77f))
+* introduce python client generation ([a23e77d](https://gitlab.com/team-supercharge/oasg/commit/a23e77dc9fbf8182e5aac3190a1bcdb28c55a598))
+
 ### [4.0.2](https://gitlab.com/team-supercharge/oasg/compare/v4.0.1...v4.0.2) (2022-03-21)
 
 

package/README.md

@@ -27,6 +27,7 @@ Design APIs in OpenAPI 3.0 format, lint them, and generate client/server package
     * [Spring](#spring)
     * [Android](#android)
     * [iOS](#iOS)
+    * [Python](#python)
 * [Migration Guide](#migration-guide)
 * [Roadmap](#roadmap)
 
@@ -400,6 +401,25 @@ Common target parameters
 | podRepository | The public SC pod repository where the specification is stored | Y | - |
 | repository | URL of the generated client api code repository | Y | - |
 
+#### Python
+
+```json
+{
+  "id": "client-python",
+  "type": "python",
+  "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.
+
 ## Migration Guide
 
 This section covers the breaking changes and their migrations across major version upgrades.

package/bin/oasg

@@ -23,7 +23,17 @@ const REQUIRED_COMMANDS = ['java', 'wget', 'jq'];
 const SERVE_PORT = '8888';
 const PROXY_PORT = '9999';
 
-const DEFAULT_GENERATOR_VERSION = '4.3.1';
+const DEFAULT_GENERATOR_VERSION_MAPPING = {
+  "android": '4.3.1',
+  "ios": '4.3.1',
+  "react-native": '4.3.1',
+  "angular": '4.3.1',
+  "spring": '4.3.1',
+  "spring-kotlin": '4.3.1',
+  "stubby": '4.3.1',
+  "feign": '4.3.1',
+  "python": '5.4.0' // python generation does not work with 4.3.1
+};
 const DEFAULT_KTLINT_VERSION = '0.39.0';
 const BIN_FOLDER = 'out/.bin';
 
@@ -42,6 +52,7 @@ const DEFAULT_GENERATOR_ID_MAPPING = {
   "spring-kotlin": 'kotlin-spring',
   "stubby": 'stubby',
   "feign": 'spring',
+  "python": 'python'
 }
 
 let config;
@@ -175,7 +186,7 @@ async function parseConfig() {
   // set default generator values to targets with undefined
   config.targets.forEach(t => {
     if (!t.generator) {
-      t.generator = DEFAULT_GENERATOR_VERSION;
+      t.generator = DEFAULT_GENERATOR_VERSION_MAPPING[t.type];
     }
     if (!t.generatorId) {
       if (t.type in DEFAULT_GENERATOR_ID_MAPPING) {

package/config.schema.yml

@@ -18,6 +18,7 @@ properties:
         - $ref: '#/targets/Stubby'
         - $ref: '#/targets/Android'
         - $ref: '#/targets/ios'
+        - $ref: '#/targets/Python'
 required:
   - targets
 additionalProperties: false
@@ -232,6 +233,20 @@ targets:
         - repository
         - podRepository
 
+  Python:
+    allOf:
+      - $ref: '#/targets/Base'
+      - properties:
+          type:
+            pattern: "^python$"
+          packageName:
+            type: string
+          repositoryUrl:
+            type: string
+        required:
+        - packageName
+        - repositoryUrl
+
 definitions:
   # default
   SourceOverrides:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@team-supercharge/oasg",
-  "version": "4.0.2",
+  "version": "4.1.0",
   "description": "Node-based tool to lint OpenAPI documents and generate clients, servers and documentation from them",
   "author": "Supercharge",
   "license": "MIT",

package/targets/python/generate.sh

@@ -0,0 +1,21 @@
+#/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 \
+  -o out/$targetId \
+  -c $(dirname "$0")/generator-config.json \
+  -p "packageVersion=$version,packageName=$packageName" $generatorCustomArgs
+
+cd out/$targetId
+python3 setup.py sdist bdist_wheel
+cd ../../

package/targets/python/generator-config.json

@@ -0,0 +1,3 @@
+{
+  "library": "urllib3"
+}

package/targets/python/publish.sh

@@ -0,0 +1,7 @@
+#/bin/bash
+
+source $(dirname "$0")/../common.sh
+
+cd out/$targetId
+python3 -m twine upload --repository-url $repositoryUrl dist/*
+cd ../..