[Python] add project name to setup.py in python client (#5836)

* add project name to setup.py in python client

* update python README to use project name

* add cli option project name for python

modules/swagger-codegen/src/main/java/io/swagger/codegen/CodegenConstants.java

@@ -96,6 +96,7 @@ public class CodegenConstants {
     public static final String ENSURE_UNIQUE_PARAMS = "ensureUniqueParams";
     public static final String ENSURE_UNIQUE_PARAMS_DESC = "Whether to ensure parameter names are unique in an operation (rename parameters that are not).";
 
+    public static final String PROJECT_NAME = "projectName";
     public static final String PACKAGE_NAME = "packageName";
     public static final String PACKAGE_VERSION = "packageVersion";
 

modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/PythonClientCodegen.java

@@ -24,8 +24,9 @@ import org.apache.commons.lang3.StringUtils;
 public class PythonClientCodegen extends DefaultCodegen implements CodegenConfig {
     public static final String PACKAGE_URL = "packageUrl";
 
-    protected String packageName;
+    protected String packageName; // e.g. petstore_api
     protected String packageVersion;
+    protected String projectName; // for setup.py, e.g. petstore-api
     protected String packageUrl;
     protected String apiDocPath = "docs/";
     protected String modelDocPath = "docs/";
@@ -114,6 +115,7 @@ public class PythonClientCodegen extends DefaultCodegen implements CodegenConfig
         cliOptions.clear();
         cliOptions.add(new CliOption(CodegenConstants.PACKAGE_NAME, "python package name (convention: snake_case).")
                 .defaultValue("swagger_client"));
+        cliOptions.add(new CliOption(CodegenConstants.PROJECT_NAME, "python project name in setup.py (e.g. petstore-api)."));
         cliOptions.add(new CliOption(CodegenConstants.PACKAGE_VERSION, "python package version.")
                 .defaultValue("1.0.0"));
         cliOptions.add(new CliOption(PACKAGE_URL, "python package URL."));
@@ -139,6 +141,15 @@ public class PythonClientCodegen extends DefaultCodegen implements CodegenConfig
             setPackageName("swagger_client");
         }
 
+        if (additionalProperties.containsKey(CodegenConstants.PROJECT_NAME)) {
+            setProjectName((String) additionalProperties.get(CodegenConstants.PROJECT_NAME));
+        }
+        else {
+            // default: set project based on package name
+            // e.g. petstore_api (package name) => petstore-api (project name)
+            setProjectName(packageName.replaceAll("_", "-"));
+        }
+
         if (additionalProperties.containsKey(CodegenConstants.PACKAGE_VERSION)) {
             setPackageVersion((String) additionalProperties.get(CodegenConstants.PACKAGE_VERSION));
         }
@@ -154,6 +165,7 @@ public class PythonClientCodegen extends DefaultCodegen implements CodegenConfig
                     Boolean.valueOf(additionalProperties().get(CodegenConstants.HIDE_GENERATION_TIMESTAMP).toString()));
         }
 
+        additionalProperties.put(CodegenConstants.PROJECT_NAME, projectName);
         additionalProperties.put(CodegenConstants.PACKAGE_NAME, packageName);
         additionalProperties.put(CodegenConstants.PACKAGE_VERSION, packageVersion);
 
@@ -196,7 +208,6 @@ public class PythonClientCodegen extends DefaultCodegen implements CodegenConfig
         return str.replaceAll("\\.", "_");
     }
 
-    
     @Override
     public Map<String, Object> postProcessModels(Map<String, Object> objs) {
         // process enum in models
@@ -494,6 +505,10 @@ public class PythonClientCodegen extends DefaultCodegen implements CodegenConfig
         this.packageName = packageName;
     }
 
+    public void setProjectName(String projectName) {
+        this.projectName= projectName;
+    }
+
     public void setPackageVersion(String packageVersion) {
         this.packageVersion = packageVersion;
     }

modules/swagger-codegen/src/main/resources/python/README.mustache

@@ -1,4 +1,4 @@
-# {{packageName}}
+# {{{projectName}}}
 {{#appDescription}}
 {{{appDescription}}}
 {{/appDescription}}

modules/swagger-codegen/src/main/resources/python/setup.mustache

@@ -5,7 +5,7 @@
 import sys
 from setuptools import setup, find_packages
 
-NAME = "{{packageName}}"
+NAME = "{{{projectName}}}"
 VERSION = "{{packageVersion}}"
 {{#apiInfo}}
 {{#apis}}

modules/swagger-codegen/src/test/java/io/swagger/codegen/options/PythonClientOptionsProvider.java

@@ -9,6 +9,7 @@ import java.util.Map;
 
 public class PythonClientOptionsProvider implements OptionsProvider {
     public static final String PACKAGE_NAME_VALUE = "swagger_client_python";
+    public static final String PROJECT_NAME_VALUE = "swagger-client-python";
     public static final String PACKAGE_VERSION_VALUE = "1.0.0-SNAPSHOT";
     public static final String PACKAGE_URL_VALUE = "";
 
@@ -22,6 +23,7 @@ public class PythonClientOptionsProvider implements OptionsProvider {
         ImmutableMap.Builder<String, String> builder = new ImmutableMap.Builder<String, String>();
         return builder.put(PythonClientCodegen.PACKAGE_URL, PACKAGE_URL_VALUE)
                 .put(CodegenConstants.PACKAGE_NAME, PACKAGE_NAME_VALUE)
+                .put(CodegenConstants.PROJECT_NAME, PROJECT_NAME_VALUE)
                 .put(CodegenConstants.PACKAGE_VERSION, PACKAGE_VERSION_VALUE)
                 .put(CodegenConstants.SORT_PARAMS_BY_REQUIRED_FLAG, "true")
                 .put(CodegenConstants.HIDE_GENERATION_TIMESTAMP, "true")

modules/swagger-codegen/src/test/java/io/swagger/codegen/python/PythonClientOptionsTest.java

@@ -28,6 +28,8 @@ public class PythonClientOptionsTest extends AbstractOptionsTest {
         new Expectations(clientCodegen) {{
             clientCodegen.setPackageName(PythonClientOptionsProvider.PACKAGE_NAME_VALUE);
             times = 1;
+            clientCodegen.setProjectName(PythonClientOptionsProvider.PROJECT_NAME_VALUE);
+            times = 1;
             clientCodegen.setPackageVersion(PythonClientOptionsProvider.PACKAGE_VERSION_VALUE);
             times = 1;
             clientCodegen.setPackageUrl(PythonClientOptionsProvider.PACKAGE_URL_VALUE);

samples/client/petstore/python/README.md

@@ -1,4 +1,4 @@
-# petstore_api
+# petstore-api
 This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\
 
 This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

samples/client/petstore/python/setup.py

@@ -14,7 +14,7 @@
 import sys
 from setuptools import setup, find_packages
 
-NAME = "petstore_api"
+NAME = "petstore-api"
 VERSION = "1.0.0"
 # To install the library, run the following
 #