feat(new-sdk-version): Adding 3.0.0 version SDK (#6)

Supported API versions:
* v2

Summary:
* Making SDK independent of the API version.

Breaking changes:
* API version is removed from the package name.

Functionality Additions:
* No changes

Bug Fixes:
* No changes

Author: spasumarthi21

CHANGELOG.md

@@ -1,5 +1,27 @@
+3.0.0 (12/02/2019)
+
+Supported API versions:
+* v2
+
+Summary:
+* Making SDK independent of the API version.
+
+Breaking changes:
+* API version is removed from the package name.
+
+Functionality Additions:
+* No changes
+
+Bug Fixes:
+* No changes
+
+-----------------------
+
 v2-2.0.0 (09/19/2019)
 
+Supported API versions:
+* v2
+
 Summary:
 * Update class and property names.
 
@@ -56,7 +78,11 @@ Bug Fixes:
 * No changes.
 
 -----------------------
- v2-1.0.0 (08/30/2019)
+
+v2-1.0.0 (08/30/2019)
+
+Supported API versions:
+* v2
 
 Summary:
 * Releasing first version of Engines API(v2).

README.md

@@ -1,9 +1,9 @@
 # analyticsapi-engines-python-sdk
 
 ## Overview
-API client library to leverage Factset's Analytics API in python. Each API version directory contains its respective Analytics API implementation.
+API client library to leverage FactSet's PA Engine, SPAR Engine and Vault API in python.
 
-**`fds.analyticsapi.engines.vAPI_VERSION`** - Contains the Python library. It is developed using [open-api-generator](https://github.com/OpenAPITools/openapi-generator).
+**`fds.analyticsapi.engines`** - Contains the Python library. It is developed using [open-api-generator](https://github.com/OpenAPITools/openapi-generator).
 
 **`Utilities`** - Contains the EnginesAPI's OpenAPI schema (openapi-schema.json), configuration file (openapi-generator-config.json), OpenAPI's python edited templates and End-to-End tests of library.
 
@@ -12,12 +12,12 @@ API client library to leverage Factset's Analytics API in python. Each API versi
 
 #### Current versions
 * API_VERSION - 2
-* PACKAGE_VERSION - 2.0.0
+* PACKAGE_VERSION - 3.0.0
 
 ## To install the API client library
 * Run the below command.
 ```
-pip install fds.analyticsapi.engines.vAPI_VERSION-*.*.*.tar.gz
+pip install fds.analyticsapi.engines-*.*.*.tar.gz
 ```
 
 ## Generate library
@@ -27,16 +27,16 @@ To customize the OpenAPI generator options and generate the library. Please go t
 * Install [Java SDK8 64 bit version](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html).
 * Install PyCharm.
 * Clone this `analyticsapi-engines-python-sdk` repository.
-* Move into the `analyticsapi-engines-python-sdk/API_VERSION/Utilities/codegen` folder and run the `download-codegen.bat` file by double clicking it (for downloading the openapi-generator-cli.jar).
+* Move into the `analyticsapi-engines-python-sdk/Utilities/codegen` folder and run the `download-codegen.bat` file by double clicking it (for downloading the openapi-generator-cli.jar).
 
 ### To update and build the library
-* Move to the `vAPI_VERSION` location.
-* Delete all the contents of `fds.analyticsapi.engines.vAPI_VERSION` except `.openapi-generator-ignore` script and `pydocs` sub-directory.
+* Move to the `analyticsapi-engines-python-sdk` location.
+* Delete all the contents of `fds.analyticsapi.engines` directory except `.openapi-generator-ignore` script.
 * In the `Utilities` folder update the `packageVersion` field to new **PACKAGE_VERSION** in `openapi-generator-config.json` file.
-* Run the below command after updating **API_VERSION** and **http-user-agent** with correct values.
+* Run the below command after updating **PACKAGE_VERSION** with correct values.
 ```
 javac -classpath Utilities/codegen/*; Utilities/codegen/CustomPythonClientCodegen.java
-java -DapiTests=false -DmodelTests=false -classpath Utilities/codegen/;Utilities/codegen/*; org.openapitools.codegen.OpenAPIGenerator generate --generator-name CustomPythonClientCodegen --input-spec Utilities/codegen/openapi-schema.json --output fds.analyticsapi.engines.vAPI_VERSION --config Utilities/codegen/openapi-generator-config.json --http-user-agent engines-api/vAPI_VERSION/PACKAGE_VERSION/python --template-dir Utilities/codegen/templates --skip-validate-spec
+java -DapiTests=false -DmodelTests=false -classpath Utilities/codegen/;Utilities/codegen/*; org.openapitools.codegen.OpenAPIGenerator generate --generator-name CustomPythonClientCodegen --input-spec Utilities/codegen/openapi-schema.json --output fds.analyticsapi.engines --config Utilities/codegen/openapi-generator-config.json --http-user-agent engines-api/PACKAGE_VERSION/python --template-dir Utilities/codegen/templates --skip-validate-spec
 ```
 * Run the below command which generates API client library in `dist` directory.
 ```
@@ -48,12 +48,12 @@ python setup.py sdist
 #### Running the Test Cases using PyCharm
 * Open the PyCharm.
 * Goto `File-> Open`.
-* Browse for the `vAPI_VERSION/Utilities/test` folder and open it.
+* Browse for the `Utilities/test` folder and open it.
 * Goto `View-> Tool Windows-> Terminal` and open the terminal.
-* In the terminal, move to the location `vAPI_VERSION/fds.analyticsapi.engines.vAPI_VERSION`.
+* In the terminal, move to the location `fds.analyticsapi.engines`.
 * Install the library.
 ```
-pip install fds.analyticsapi.engines.v*-*.*.*.tar.gz
+pip install fds.analyticsapi.engines.*.*.*.tar.gz
 ```
 * Set the below environment variables.
 ```

v2/Utilities/.gitignore renamed to Utilities/.gitignore

@@ -4,6 +4,6 @@ SETLOCAL
 
 SET script-path=%~dp0
 
-powershell -Command "(new-object System.Net.WebClient).DownloadFile('http://central.maven.org/maven2/org/openapitools/openapi-generator-cli/4.1.1/openapi-generator-cli-4.1.1.jar', '%script-path%openapi-generator-cli-4.1.1.jar')"
+powershell -Command "(new-object System.Net.WebClient).DownloadFile('http://central.maven.org/maven2/org/openapitools/openapi-generator-cli/4.2.2/openapi-generator-cli-4.2.2.jar', '%script-path%openapi-generator-cli-4.2.2.jar')"
 
 ENDLOCAL

v2/Utilities/codegen/CustomPythonClientCodegen.java renamed to Utilities/codegen/CustomPythonClientCodegen.java

@@ -0,0 +1,6 @@
+{
+  "packageName": "fds.analyticsapi.engines",
+  "projectName": "fds.analyticsapi.engines",
+  "packageVersion": "3.0.0",
+  "packageUrl": "https://github.com/factset/analyticsapi-engines-python-sdk"
+}

v2/Utilities/codegen/download-codegen.bat renamed to Utilities/codegen/download-codegen.bat

@@ -1,4 +1,4 @@
-{{! This file is picked from the v4.1.1 release of openapi-generator(https://github.com/OpenAPITools/openapi-generator/blob/v4.1.1/modules/openapi-generator/src/main/resources/python/__init__api.mustache) }}
+{{! This file is picked from the v4.2.2 release of openapi-generator(https://github.com/OpenAPITools/openapi-generator/blob/v4.2.2/modules/openapi-generator/src/main/resources/python/__init__api.mustache) }}
 {{! Changes made: 1) Added import of UtilityApi. }}
 from __future__ import absolute_import
 

Utilities/codegen/openapi-generator-config.json

@@ -1,4 +1,4 @@
-{{! This file is picked from the v4.1.1 release of openapi-generator(https://github.com/OpenAPITools/openapi-generator/blob/v4.1.1/modules/openapi-generator/src/main/resources/python/__init__package.mustache) }}
+{{! This file is picked from the v4.2.2 release of openapi-generator(https://github.com/OpenAPITools/openapi-generator/blob/v4.2.2/modules/openapi-generator/src/main/resources/python/__init__package.mustache) }}
 {{! Changes made: 1) Added import of UtilityApi. }}
 # coding: utf-8
 

v2/Utilities/codegen/openapi-schema.json renamed to Utilities/codegen/openapi-schema.json

@@ -1,4 +1,4 @@
-{{! This file is picked from the v4.1.1 release of openapi-generator(https://github.com/OpenAPITools/openapi-generator/blob/v4.1.1/modules/openapi-generator/src/main/resources/python/common_README.mustache) }}
+{{! This file is picked from the v4.2.2 release of openapi-generator(https://github.com/OpenAPITools/openapi-generator/blob/v4.2.2/modules/openapi-generator/src/main/resources/python/common_README.mustache) }}
 {{! Changes made: 1) Added link to UtilityApi's documentation. }}
 ```python
 from __future__ import print_function